google-dfp-api 0.9.2 → 0.9.3

data/examples/v201311/line_item_service/create_mobile_line_item.rb

@@ -1,135 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example create a new line item to serve to the mobile platform. To
-# determine which line items exist, run get_all_line_items.rb. To determine
-# which orders exist, run get_all_orders.rb. To create a mobile ad unit, run
-# create_mobile_ad_unit.rb. To determine which placements exist, run
-# get_all_placements.rb.
-#
-# Mobile features needs to be enabled in your account to use mobile targeting.
-#
-# Tags: LineItemService.createLineItem
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def create_mobile_line_item()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the order that all created line items will belong to and the
-  # placement containing ad units with a mobile target platform.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-  targeted_placement_id = 'INSERT_MOBILE_PLACEMENT_ID_HERE'.to_i
-
-  # Create inventory targeting.
-  inventory_targeting = {:targeted_placement_ids => [targeted_placement_id]}
-
-  # Create technology targeting.
-  technology_targeting = {
-      :device_manufacturer_targeting => {
-          # Target the Google device manufacturer (40100).
-          :device_manufacturers => [{:id => 40100}],
-          :is_targeted => true
-      },
-      :mobile_device_targeting => {
-          # Exclude the Nexus One device (604046).
-          :excluded_mobile_devices => [{:id => 604046}]
-      },
-      :mobile_device_submodel_targeting => {
-          # Target the iPhone 4 device submodel (640003).
-          :targeted_mobile_device_submodels => [{:id => 640003}]
-      }
-  }
-
-  # Create targeting.
-  targeting = {
-      :inventory_targeting => inventory_targeting,
-      :technology_targeting => technology_targeting
-  }
-
-  # Create local line item object.
-  line_item = {
-      :name => 'Mobile line item',
-      :order_id => order_id,
-      :targeting => targeting,
-      :line_item_type => 'STANDARD',
-      :allow_overbook => true,
-      # Set the target platform to mobile.
-      :target_platform => 'MOBILE',
-      # Set the creative rotation type to even.
-      :creative_rotation_type => 'EVEN',
-      # Set the size of creatives that can be associated with this line item.
-      :creative_placeholders => [
-          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false}}
-      ],
-      # Set the length of the line item to run.
-      :start_date_time_type => 'IMMEDIATELY',
-      :end_date_time => Time.new + 60 * 60 * 24 * 7,
-      # Set the cost per day to $2.
-      :cost_type => 'CPM',
-      :cost_per_unit => {:currency_code => 'USD', :micro_amount => 2000000},
-      # Set the number of units bought to 500,000 so that the budget is $1,000.
-      :units_bought => 500000,
-      :unit_type => 'IMPRESSIONS'
-  }
-
-  # Create the line item on the server.
-  return_line_item = line_item_service.create_line_item(line_item)
-
-  if return_line_item
-    puts(("Line item with ID: %d, belonging to order ID: %d, " +
-        "and named: %s was created.") %
-        [return_line_item[:id], return_line_item[:order_id],
-         return_line_item[:name]])
-  else
-    raise 'No line items were created.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    create_mobile_line_item()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201311/line_item_service/get_line_item.rb

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets a line item by its ID. To determine which line items
-# exist, run get_all_line_items.rb.
-#
-# Tags: LineItemService.getLineItem
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_line_item()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Set the ID of the line_item to get.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-
-  # Get the line item.
-  line_item = line_item_service.get_line_item(line_item_id)
-
-  if line_item
-    puts "Line item with ID: %d, name: %s and order id: %d was found." %
-        [line_item[:id], line_item[:name], line_item[:order_id]]
-  else
-    puts 'No line item found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_line_item()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201311/order_service/get_order.rb

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets an order by its ID. To determine which orders exist, run
-# get_all_orders.rb.
-#
-# Tags: OrderService.getOrder
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_order()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
-
-  # Set the ID of the order to get.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Get the order.
-  order = order_service.get_order(order_id)
-
-  if order
-    puts "Order with ID: %d, advertiser ID: %d and name %s was found." %
-        [order[:id], order[:advertiser_id], order[:name]]
-  else
-    puts 'No order found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_order()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201311/placement_service/get_placement.rb

@@ -1,74 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example gets a placement by its ID. To determine which placements exist,
-# run get_all_placements.rb.
-#
-# Tags: PlacementService.getPlacement
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-
-def get_placement()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the PlacementService.
-  placement_service = dfp.service(:PlacementService, API_VERSION)
-
-  # Set the ID of the placement to get.
-  placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
-
-  # Get the placement.
-  placement = placement_service.get_placement(placement_id)
-
-  if placement
-    puts "Placement with ID: %d, name: %s and status %s was found." %
-        [placement[:id], placement[:name], placement[:status]]
-  else
-    puts 'No placement found for this ID.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_placement()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end

data/examples/v201311/report_service/run_report_with_custom_fields.rb

@@ -1,135 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# This example runs a report that includes custom fields found in the line items
-# of an order. To download the report see download_report.rb.
-#
-# Tags: LineItemService.getLineItemByStatement
-# Tags: ReportService.runReportJob, ReportService.getReportJob
-
-require 'dfp_api'
-
-API_VERSION = :v201311
-PAGE_SIZE = 500
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def run_report_with_custom_fields()
-  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
-  dfp = DfpApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # dfp.logger = Logger.new('dfp_xml.log')
-
-  # Get the LineItemService.
-  line_item_service = dfp.service(:LineItemService, API_VERSION)
-
-  # Get the ReportService.
-  report_service = dfp.service(:ReportService, API_VERSION)
-
-  # Set the ID of the order to get line items from.
-  order_id = 'INSERT_ORDER_ID_HERE'.to_i
-
-  # Define initial values.
-  offset = 0
-  page = {}
-  custom_field_ids = []
-
-  # Create a statement to only select line items from a given order.
-  statement = {
-      :values => [
-          {:key => 'order_id',
-           :value => {:value => order_id, :xsi_type => 'NumberValue'}}
-      ]
-  }
-  query_text = 'WHERE orderId = :order_id LIMIT %d OFFSET %d'
-
-  begin
-    # Update the statement to get one page with current offset.
-    statement[:query] = query_text % [PAGE_SIZE, offset]
-
-    # Get line items by statement.
-    page = line_item_service.get_line_items_by_statement(statement)
-
-    if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get custom field IDs from the line items of an order.
-      page[:results].each do |line_item|
-        if line_item[:custom_field_values]
-          line_item[:custom_field_values].each do |value|
-            custom_field_ids |= [value[:custom_field_id]]
-          end
-        end
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Create report query.
-  statement[:query] = 'WHERE ORDER_ID = :order_id'
-  report_query = {
-    :date_range_type => 'LAST_MONTH',
-    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
-    :custom_field_ids => custom_field_ids,
-    :columns => ['AD_SERVER_IMPRESSIONS'],
-    :statement => statement
-  }
-
-  # Create report job.
-  report_job = {:report_query => report_query}
-
-  # Run report job.
-  report_job = report_service.run_report_job(report_job);
-
-  MAX_RETRIES.times do |retry_count|
-    # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
-
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
-    puts "Report with ID: %d is still running." % report_job[:id]
-    sleep(RETRY_INTERVAL)
-  end
-
-  puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
-end
-
-if __FILE__ == $0
-  begin
-    run_report_with_custom_fields()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue DfpApi::Errors::ApiException => e
-    puts "Message: %s" % e.message
-    puts 'Errors:'
-    e.errors.each_with_index do |error, index|
-      puts "\tError [%d]:" % (index + 1)
-      error.each do |field, value|
-        puts "\t\t%s: %s" % [field, value]
-      end
-    end
-  end
-end