google-dfp-api 0.2.3 → 0.2.4

data/examples/v201108/label_service/update_labels.rb

@@ -0,0 +1,104 @@
+#!/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 descriptions of all labels that are competitive
+# exclusion by updating its description up to the first 500. To determine which
+# labels exist, run get_all_labels.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: LabelService.getLabelsByStatement, LabelService.updateLabels
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+
+def update_labels()
+  # 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 LabelService.
+  label_service = dfp.service(:LabelService, API_VERSION)
+
+  # Create a statement to only select labels that are competitive exclusion and
+  # active.
+  statement = {
+      :query => 'WHERE type = :type and isActive = true LIMIT 500',
+      :values => [
+          {:key => 'type',
+           :value => {
+               :value => 'COMPETITIVE_EXCLUSION',
+               :xsi_type => 'TextValue'}
+          }
+      ]
+  }
+
+  # Get labels by statement.
+  page = label_service.get_labels_by_statement(statement)
+
+  if page[:results]
+    labels = page[:results]
+
+    # Update each local label object by changing its description.
+    labels.each do |label|
+      label[:description] =
+          'These labels are still competiting with each other'
+    end
+
+    # Update the labels on the server.
+    return_labels = label_service.update_labels(labels)
+
+    if return_labels
+      return_labels.each do |label|
+        puts ("Label ID: %d, name: %s was updated with description: %s.") %
+            [label[:id], label[:name], label[:description]]
+      end
+    else
+      raise 'No labels were updated.'
+    end
+  else
+    puts 'No labels found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_labels()
+
+  # 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/{v201101 → v201108}/line_item_creative_association_service/create_licas.rb

@@ -29,7 +29,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def create_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_creative_association_service/deactivate_licas.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def deactivate_licas()

data/examples/{v201101 → v201108}/line_item_creative_association_service/get_all_licas.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_licas()

data/examples/{v201101 → v201108}/line_item_creative_association_service/get_lica.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_lica()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_creative_association_service/get_licas_by_statement.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_licas_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_creative_association_service/update_licas.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_licas()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_service/activate_line_items.rb

@@ -30,7 +30,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def activate_line_items()

data/examples/{v201101 → v201108}/line_item_service/create_line_items.rb

@@ -20,14 +20,16 @@
 # 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.
+# 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 = :v201101
+API_VERSION = :v201108
 # Number of line items to create.
 ITEM_COUNT = 5
 
@@ -53,23 +55,48 @@ def create_line_items()
   inventory_targeting = {:targeted_placement_ids => targeted_placement_ids}
 
   # Create geographical targeting.
-  geo_targeting = {}
-  # Include the US and Quebec, Canada.
-  geo_targeting[:targeted_locations] = [
-      {:xsi_type => 'CountryLocation', :country_code => 'US'},
-      {:xsi_type => 'RegionLocation', :region_code => 'CA-QC'}
-  ]
-
-  # Exclude Chicago and the New York metro area.
-  geo_targeting[:excluded_locations] = [
-      {:xsi_type => 'CityLocation',
-          :city_name => 'Chicago', :country_code => 'US'},
-      {:xsi_type => 'MetroLocation', :metro_code => '501'}
-  ]
+  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 technology targeting.
+  technology_targeting = {
+      # Create browser targeting.
+      :browser_targeting => {
+        :is_targeted => true,
+        # Target just the Chrome browser.
+        :browsers => [{:id => 500072}]
+      }
+  }
 
   # Create targeting.
   targeting = {:geo_targeting => geo_targeting,
-               :inventory_targeting => inventory_targeting}
+               :inventory_targeting => inventory_targeting,
+               :user_domain_targeting => user_domain_targeting,
+               :day_part_targeting => day_part_targeting,
+               :technology_targeting => technology_targeting
+  }
 
   # Create an array to store local line item objects.
   line_items = (1..ITEM_COUNT).map do |index|
@@ -81,10 +108,13 @@ def create_line_items()
     # Set the creative rotation type to even.
     line_item[:creative_rotation_type] = 'EVEN'
 
+    # Create the creative placeholder.
+    creative_placeholder = {
+        :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+    }
+
     # 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}
-    ]
+    line_item[:creative_placeholders] = [creative_placeholder]
 
     # Set the length of the line item to run.
     line_item[:start_date_time_type] = 'IMMEDIATELY'

data/examples/{v201101 → v201108}/line_item_service/get_all_line_items.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_line_items()

data/examples/{v201101 → v201108}/line_item_service/get_line_item.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_service/get_line_items_by_statement.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_line_items_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/line_item_service/target_custom_criteria.rb

@@ -29,7 +29,7 @@ require 'dfp_api'
 
 require 'pp'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def target_custom_criteria()
@@ -47,51 +47,45 @@ def target_custom_criteria()
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
   # Set the IDs of the custom targeting keys.
-  free_form_custom_targeting_key_id1 =
-      'INSERT_FREE_FORM_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-  free_form_custom_targeting_key_id2 =
-      'INSERT_FREE_FORM_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
-
-  # Create the free-form custom criteria for targeting "toyota".
-  toyota_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS',
-      :key_id => free_form_custom_targeting_key_id1,
-      :values => [{:name => 'toyota', :match_type => 'EXACT'}]
-  }
-
-  # Create the free-form custom criteria for targeting "honda".
-  honda_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS_NOT',
-      :key_id => free_form_custom_targeting_key_id1,
-      :values => [{:name => 'honda', :match_type => 'EXACT'}]
-  }
-
-  # Create the free-form custom criteria for targeting "ford".
-  ford_free_form_custom_criteria = {
-      :xsi_type => 'FreeFormCustomCriteria',
-      :operator => 'IS',
-      :key_id => free_form_custom_targeting_key_id2,
-      :values => [{:name => 'ford', :match_type => 'EXACT'}]
-  }
+  custom_criteria_ids = [
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]},
+      {:key => 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i,
+       :values => ['INSERT_CUSTOM_TARGETING_VALUE_IDS_HERE'.to_i]}
+  ]
+
+  # Create custom criteria.
+  custom_criteria = [
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[0][:key],
+       :value_ids => custom_criteria_ids[0][:values],
+       :operator => 'IS'},
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[1][:key],
+       :value_ids => custom_criteria_ids[1][:values],
+       :operator => 'IS_NOT'},
+      {:xsi_type => 'CustomCriteria',
+       :key_id => custom_criteria_ids[2][:key],
+       :value_ids => custom_criteria_ids[2][:values],
+       :operator => 'IS'}
+  ]
 
   # Create the custom criteria set that will resemble:
   #
-  # (freeFormCustomTargetingKeyId1 == toyota OR
-  #     (freeFormCustomTargetingKeyId1 != honda AND
-  #      freeFormCustomTargetingKeyId2 == ford))
+  # (custom_criteria[0].key == custom_criteria[0].values OR
+  #     (custom_criteria[1].key != custom_criteria[1].values AND
+  #         custom_criteria[2].key == custom_criteria[2].values))
   sub_custom_criteria_set = {
       :xsi_type => 'CustomCriteriaSet',
       :logical_operator => 'AND',
-      :children => [honda_free_form_custom_criteria,
-                    ford_free_form_custom_criteria]
+      :children => [custom_criteria[1], custom_criteria[2]]
   }
   top_custom_criteria_set = {
       :xsi_type => 'CustomCriteriaSet',
       :logical_operator => 'OR',
-      :children => [toyota_free_form_custom_criteria,
-                    sub_custom_criteria_set]
+      :children => [custom_criteria[0], sub_custom_criteria_set]
   }
 
   # Get the line item.

data/examples/{v201101 → v201108}/line_item_service/update_line_items.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_line_items()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/network_service/get_all_networks.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_all_networks()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/network_service/get_current_network.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_current_network()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/order_service/approve_orders.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def approve_orders()

data/examples/{v201101 → v201108}/order_service/create_orders.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 # Number of orders to create.
 ITEM_COUNT = 5
 

data/examples/{v201101 → v201108}/order_service/get_all_orders.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_orders()