google-dfp-api 0.2.8 → 0.3.0

data/examples/{v201107 → v201203}/creative_service/create_creatives.rb

@@ -26,7 +26,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201103/creative_service/create_creatives.rb → v201203/creative_service/create_custom_creative.rb}

@@ -17,20 +17,20 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example creates new image creatives for a given advertiser. To determine
+# This example creates a custom creative for a given advertiser. To determine
 # which companies are advertisers, run get_companies_by_statement.rb. To
 # determine which creatives already exist, run get_all_creatives.rb.
 #
-# Tags: CreativeService.createCreatives
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: CreativeService.createCreative
 
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201103
-# Number of creatives to create.
-ITEM_COUNT = 5
+API_VERSION = :v201203
 
-def create_creatives()
+def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -52,32 +52,30 @@ def create_creatives()
   image_data_base64 = Base64.encode64(image_data)
 
   # Create an array to store local creative objects.
-  creatives = (1..ITEM_COUNT).map do |index|
-    {:xsi_type => 'ImageCreative',
-     :name => "Image creative #%d" % index,
-     :advertiser_id => advertiser_id,
-     :destination_url => 'http://www.google.com',
-     :image_name => 'image.jpg',
-     :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
-     :image_byte_array => image_data_base64}
-  end
+  custom_creative = {
+      :xsi_type => 'CustomCreative',
+      :name => 'Custom creative',
+      :advertiser_id => advertiser_id,
+      :destination_url => 'http://www.google.com',
+      :custom_creative_assets => [
+          {:macro_name => 'IMAGE_ASSET',
+           :file_name => "image%d.jpg" % Time.new.to_i,
+           :asset_byte_array => image_data_base64}
+      ],
+      # Set the HTML snippet using the custom creative asset macro.
+      :html_snippet => "<a href='%%CLICK_URL_UNESC%%%%DEST_URL%%'>" +
+        "<img src='%%FILE:IMAGE_ASSET%%'/></a><br>Click above for great deals!",
+      # Set the creative size.
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+  }
 
   # Create the creatives on the server.
-  return_creatives = creative_service.create_creatives(creatives)
+  return_creative = creative_service.create_creative(custom_creative)
 
-  if return_creatives
-    return_creatives.each do |creative|
-      if creative[:creative_type] == 'ImageCreative'
-        puts ("Image creative with ID: %d, name: %s, size: %dx%d was " +
-            "created and can be previewed at: [%s]") %
-            [creative[:id], creative[:name],
-             creative[:size][:width], creative[:size][:height],
-             creative[:preview_url]]
-      else
-        puts "Creative with ID: %d, name: %s and type: %s was created." %
-            [creative[:id], creative[:name], creative[:creative_type]]
-      end
-    end
+  if return_creative
+    puts "Custom creative with ID: %d, name: '%s' and type: '%s' was created." %
+        [return_creative[:id], return_creative[:name],
+         return_creative[:creative_type]]
   else
     raise 'No creatives were created.'
   end
@@ -85,7 +83,7 @@ end
 
 if __FILE__ == $0
   begin
-    create_creatives()
+    create_custom_creative()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103 → v201203}/creative_service/get_all_creatives.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_creatives()

data/examples/{v201104 → v201203}/creative_service/get_creative.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/creative_service/get_creatives_by_statement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201103 → v201203}/creative_service/update_creatives.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201103/inventory_service/get_all_ad_units.rb → v201203/creative_template_service/get_all_creative_templates.rb}

@@ -17,16 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all ad units. To create ad units, run create_ad_units.rb.
+# This example gets all creative templates.
 #
-# Tags: InventoryService.getAdUnitsByStatement
+# Tags: CreativeTemplateService.getCreativeTemplatesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_ad_units()
+def get_all_creative_templates()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,8 +34,8 @@ def get_all_ad_units()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
+  # Get the CreativeTemplateService.
+  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -45,8 +45,9 @@ def get_all_ad_units()
     # Create a statement to get one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    # Get creative templates by statement.
+    page =
+        creative_template_service.get_creative_templates_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -55,24 +56,24 @@ def get_all_ad_units()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each ad unit in results.
-      page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-            [index + start_index, ad_unit[:id],
-             ad_unit[:name], ad_unit[:status]]
+      # Print details about each creative template in results.
+      page[:results].each_with_index do |template, index|
+        puts "%d) Creative template ID: %d, name: %s, type: %s" %
+            [index + start_index, template[:id],
+             template[:name], template[:type]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Total number of ad units: %d" % page[:total_result_set_size]
+    puts "Total number of creative templates: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_ad_units()
+    get_all_creative_templates()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103/creative_service/get_creative.rb → v201203/creative_template_service/get_creative_template.rb}

@@ -17,16 +17,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets a creative by its ID. To determine which creatives exist,
-# run get_all_creatives.rb.
+# This example gets a creative template by its ID. To determine which creative
+# templates exist, run get_all_creative_templates.rb.
 #
-# Tags: CreativeService.getCreative
+# Tags: CreativeTemplateService.getCreativeTemplate
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
-def get_creative()
+def get_creative_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,24 +34,26 @@ def get_creative()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the CreativeService.
-  creative_service = dfp.service(:CreativeService, API_VERSION)
+  # Get the CreativeTemplateService.
+  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
 
-  # Set the ID of the creative to get.
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+  # Set the ID of the creative_template to get.
+  creative_template_id = 'INSERT_CREATIVE_ID_HERE'.to_i
 
-  # Get the creative.
-  creative = creative_service.get_creative(creative_id)
+  # Get the creative_template.
+  creative_template =
+      creative_template_service.get_creative_template(creative_template_id)
 
-  if creative
-    puts "Creative with ID: %d, name: %s and type: %s was found." %
-        [creative[:id], creative[:name], creative[:type]]
+  if creative_template
+    puts "Creative template with ID: %d, name: '%s' and type: '%s' was found." %
+        [creative_template[:id], creative_template[:name],
+         creative_template[:type]]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_creative()
+    get_creative_template()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201107/user_service/get_users_by_statement.rb → v201203/creative_template_service/get_creative_templates_by_statement.rb}

@@ -17,16 +17,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users sorted by name. The statement retrieves up to the
-# maximum page size limit of 500. To create new users, run create_users.rb.
+# This example gets up to 500 system defined creative templates.
 #
-# Tags: UserService.getUsersByStatement
+# Tags: CreativeTemplateService.getCreativeTemplatesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
-def get_users_by_statement()
+def get_creative_templates_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,31 +33,33 @@ def get_users_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
+  # Get the CreativeTemplateService.
+  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
 
-  # Create a statement to get all users sorted by name.
-  statement = {:query => 'ORDER BY name LIMIT 500'}
+  # Create a statement to only select image creative_templates.
+  statement = {:query => 'LIMIT 500'}
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  # Get creative templates by statement.
+  page =
+      creative_template_service.get_creative_templates_by_statement(statement)
 
-  if page and page[:results]
-    page[:results].each_with_index do |user, index|
-      puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [index,
-          user[:id], user[:name], user[:email], user[:role_name]]
+  if page[:results]
+    # Print details about each creative template in results.
+    page[:results].each_with_index do |template, index|
+      puts "%d) Creative template ID: %d, name: %s, type: %s" %
+          [index, template[:id], template[:name], template[:type]]
     end
   end
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Number of results found: %d" % page[:total_result_set_size]
+    puts "Total number of creative templates: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_users_by_statement()
+    get_creative_templates_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201107 → v201203}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -47,9 +47,13 @@ def create_custom_targeting_keys_and_values()
   car_model_key = {:display_name => 'car model', :name => 'c',
       :type => 'FREEFORM'}
 
+  # Create predefined key that may be used for content targeting.
+  genre_key = {:display_name => 'genre', :name => 'genre',
+      :type => 'PREDEFINED'}
+
   # Create the custom targeting keys on the server.
   return_keys = custom_targeting_service.create_custom_targeting_keys(
-      [gender_key, car_model_key])
+      [gender_key, car_model_key, gender_key])
 
   if return_keys
     return_keys.each do |key|
@@ -75,13 +79,31 @@ def create_custom_targeting_keys_and_values()
   # with a free-form custom criterion.
   car_model_honda_civic_value = {
       :custom_targeting_key_id => return_keys[1][:id],
-      :display_name => 'honda civic', :name => 'honda civic'}
-  # Setting match type to exact will match exactly "honda civic".
-  car_model_honda_civic_value[:match_type] = 'EXACT'
+      :display_name => 'honda civic',
+      :name => 'honda civic',
+      # Setting match type to exact will match exactly "honda civic".
+      :match_type => 'EXACT'
+  }
+
+  # Create custom targeting values for the predefined genre key.
+  genre_comedy_value = {
+      :custom_targeting_key_id => return_keys[2][:id],
+      :display_name => 'comedy',
+      :name => 'comedy',
+      :match_type => 'EXACT'
+  }
+
+  genre_drama_value = {
+      :custom_targeting_key_id => return_keys[2][:id],
+      :display_name => 'drama',
+      :name => 'drama',
+      :match_type => 'EXACT'
+  }
 
   # Create the custom targeting values on the server.
   return_values = custom_targeting_service.create_custom_targeting_values(
-      [gender_male_value, gender_female_value, car_model_honda_civic_value])
+      [gender_male_value, gender_female_value, car_model_honda_civic_value,
+       genre_comedy_value, genre_drama_value])
 
   if return_values
     return_values.each do |value|

data/examples/{v201103 → v201203}/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def delete_custom_targeting_keys()

data/examples/{v201107 → v201203}/custom_targeting_service/delete_custom_targeting_values.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def delete_custom_targeting_values()

data/examples/{v201103 → v201203}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_custom_targeting_keys_and_values()

data/examples/{v201104 → v201203}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_custom_targeting_values_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/custom_targeting_service/update_custom_targeting_keys.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.