google-dfp-api 0.2.0 → 0.2.1

data/examples/v201104/line_item_creative_association_service/get_lica.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby
+#
+# 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 creative association (LICA) by the line item and
+# creative ID. To determine which line items exist, run get_all_line_items.rb.
+# To determine which creatives exit, run get_all_creatives.rb.
+#
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociation
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+def get_lica()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Set the line item and creative IDs to use to retrieve the LICA.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+
+  # Get the LICA.
+  lica =
+      lica_service.get_line_item_creative_association(line_item_id, creative_id)
+
+  if lica
+    puts ("LICA with line item ID: %d, creative ID: %d and status: %s was " +
+        "found.") % [lica[:line_item_id], lica[:creative_id], lica[:status]]
+  else
+    puts 'No lica found for this ID.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_lica()
+
+  # 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/v201104/line_item_creative_association_service/get_licas_by_statement.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby
+#
+# 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 all line item creative associations for a given line item
+# ID. The statement retrieves up to the maximum page size limit of 500. To
+# create LICAs, run create_licas.rb. To determine which line items exist, run
+# get_all_line_items.rb.
+#
+# Tags: LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+def get_licas_by_statement()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Set the line item to get LICAs by.
+  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
+
+  # Create a statement to only select LICAs for the given line item ID.
+  statement = {
+      :query => 'WHERE lineItemId = :line_item_id LIMIT 500',
+      :values => [
+          {:key => 'line_item_id',
+           :value => {:value => line_item_id, :xsi_type => 'NumberValue'}}
+      ]
+  }
+
+  # Get LICAs by statement.
+  page =
+      lica_service.get_line_item_creative_associations_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |lica, index|
+      puts "%d) LICA with line item ID: %d, creative ID: %d and status: %s." %
+          [index, lica[:line_item_id], lica[:creative_id], lica[:status]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_licas_by_statement()
+
+  # 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/v201104/line_item_creative_association_service/update_licas.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby
+#
+# 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 updates the destination URL of all LICAs up to the first 500. To
+# determine which LICAs exist, run get_all_licas.rb.
+#
+# Tags:
+#   LineItemCreativeAssociationService.getLineItemCreativeAssociationsByStatement,
+#   LineItemCreativeAssociationService.updateLineItemCreativeAssociations
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+
+def update_licas()
+  # 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 LineItemCreativeAssociationService.
+  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
+
+  # Create a statement to get all LICAs.
+  statement = {:query => 'LIMIT 500'}
+
+  # Get LICAs by statement.
+  page =
+      lica_service.get_line_item_creative_associations_by_statement(statement)
+
+  if page[:results]
+    licas = page[:results]
+
+    # Update each local LICA object by changing its destination URL.
+    licas.each {|lica| lica[:destination_url] = 'http://news.google.com'}
+
+    # Update the LICAs on the server.
+    return_licas = lica_service.update_line_item_creative_associations(licas)
+
+    if return_licas
+      return_licas.each do |lica|
+        puts ("LICA with line item ID: %d and creative ID: %d was updated " +
+              "with destination url [%s]") %
+              [lica[:line_item_id], lica[:creative_id], lica[:destination_url]]
+      end
+    else
+      raise 'No LICAs were updated.'
+    end
+  else
+    puts 'No LICAs found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_licas()
+
+  # 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/v201104/line_item_service/activate_line_items.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/ruby
+#
+# 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 activates all line items for the given order. To be activated,
+# line items need to be in the approved (needs creatives) state and have at
+# least one creative associated with them. To approve line items, approve the
+# order to which they belong by running approve_orders.rb. To create LICAs, run
+# create_licas.rb. To determine which line items exist, run
+# get_all_line_items.rb. To determine which orders exist, run get_all_orders.rb.
+#
+# Tags: LineItemService.getLineItemsByStatement,
+#       LineItemService.performLineItemAction
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+PAGE_SIZE = 500
+
+def activate_line_items()
+  # 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 order to get line items from.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+
+  # Create a statement to only select line items from the specified order that
+  # are in the approved (needs creatives) state.
+  statement_text = 'WHERE orderID = :order_id AND status = :status'
+  statement = {
+      :values => [
+          {:key => 'order_id',
+           :value => {:value => order_id, :xsi_type => 'NumberValue'}},
+          {:key => 'status',
+           :value => {:value => 'NEEDS_CREATIVES', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  # Define initial values.
+  offset = 0
+  page = Hash.new
+  line_item_ids = Array.new
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement[:query] = statement_text +
+        " LIMIT %d OFFSET %d" % [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
+
+      page[:results].each do |line_item|
+        if !line_item[:is_archived]
+          puts ("%d) Line item with ID: %d, order ID: %d and name: %s will " +
+              "be activated.") % [line_item_ids.size, line_item[:id],
+              line_item[:order_id], line_item[:name]]
+          line_item_ids << line_item[:id]
+        end
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  puts "Number of line items to be activated: %d" % line_item_ids.size
+
+  if !line_item_ids.empty?
+    # Modify statement for action. Note, the values are still present.
+    statement[:query] = statement_text + " AND id IN (%s)" %
+        line_item_ids.join(', ')
+
+    # Perform action.
+    result = line_item_service.perform_line_item_action(
+        {:xsi_type => 'ActivateLineItems'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of line items activated: %d" % result[:num_changes]
+    else
+      puts 'No line items were activated.'
+    end
+  else
+    puts 'No line items found to activate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    activate_line_items()
+
+  # 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/v201104/line_item_service/create_line_items.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/ruby
+#
+# 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 creates new line items. To determine which line items exist, run
+# get_all_line_items.rb. To determine which orders exist, run
+# get_all_orders.rb. To determine which placements exist, run
+# get_all_placements.rb. To determine the IDs for locations, run
+# get_all_cities.rb, get_all_countries.rb, get_all_metros.rb and
+# get_all_regions.rb.
+#
+# Tags: LineItemService.createLineItems
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201104
+# Number of line items to create.
+ITEM_COUNT = 5
+
+def create_line_items()
+  # 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
+  # ID to target.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+  targeted_placement_ids = Array.new(ITEM_COUNT) do
+    'INSERT_PLACEMENT_ID_HERE'.to_i
+  end
+
+  # Create inventory targeting.
+  inventory_targeting = {:targeted_placement_ids => targeted_placement_ids}
+
+  # Create geographical targeting.
+  geo_targeting = {
+      # Include the US and Quebec, Canada.
+      :targeted_locations => [{:id => 2840}, {:id => 20123}],
+      # Exclude Chicago and the New York metro area.
+      :excluded_locations => [{:id => 1016367}, {:id => 200501}]
+  }
+
+  # Create user domain targeting. Exclude domains that are not under the
+  # network's control.
+  user_domain_targeting = {:domains => ['usa.gov'], :targeted => false}
+
+  # Create day-part targeting.
+  day_part_targeting = {
+      # Target only the weekend in the browser's timezone.
+      :time_zone => 'BROWSER',
+      :day_parts => [
+          {:day_of_week => 'SATURDAY',
+           :start_time => {:hour => 0, :minute => 'ZERO'},
+           :end_time => {:hour => 24, :minute => 'ZERO'}},
+          {:day_of_week => 'SUNDAY',
+           :start_time => {:hour => 0, :minute => 'ZERO'},
+           :end_time => {:hour => 24, :minute => 'ZERO'}}
+      ]
+  }
+
+  # Create targeting.
+  targeting = {:geo_targeting => geo_targeting,
+               :inventory_targeting => inventory_targeting,
+               :user_domain_targeting => user_domain_targeting,
+               :day_part_targeting => day_part_targeting
+  }
+
+  # Create an array to store local line item objects.
+  line_items = Array.new
+  ITEM_COUNT.times do |index|
+    line_item = {:name => "Line item #%d" % index,
+                 :order_id => order_id,
+                 :targeting => targeting,
+                 :line_item_type => 'STANDARD',
+                 :allow_overbook => true}
+    # Set the creative rotation type to even.
+    line_item[:creative_rotation_type] = 'EVEN'
+
+    # Set the size of creatives that can be associated with this line item.
+    line_item[:creative_sizes] = [
+        {:width => 300, :height => 250, :is_aspect_ratio => false}
+    ]
+
+    # Set the length of the line item to run.
+    line_item[:start_date_time_type] = 'IMMEDIATELY'
+    line_item[:end_date_time] = Time.new + 60 * 60 * 24 * 7
+
+    # Set the cost per unit to $2.
+    line_item[:cost_type] = 'CPM'
+    line_item[: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.
+    line_item[:units_bought] = 500000
+    line_item[:unit_type] = 'IMPRESSIONS'
+
+    line_items << line_item
+  end
+
+  # Create the line items on the server.
+  return_line_items = line_item_service.create_line_items(line_items)
+
+  if return_line_items
+    return_line_items.each do |line_item|
+      puts ("Line item with ID: %d, belonging to order ID: %d, " +
+          "and named: %s was created.") %
+          [line_item[:id], line_item[:order_id], line_item[:name]]
+    end
+  else
+    raise 'No line items were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_line_items()
+
+  # 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