google-dfp-api 0.12.1 → 0.13.0

data/ChangeLog

@@ -1,3 +1,9 @@
+0.13.0:
+  - Added support for DFP v201602.
+  - Removed support for DFP v201411.
+  - Removed examples for v201502.
+  - Removed SharedAdUnitService.
+
 0.12.1:
   - Fix environment default to use DFP v201511.
 

data/examples/{v201502 → v201602}/activity_group_service/create_activity_groups.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_group_service/get_active_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_active_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_group_service/get_all_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_group_service/update_activity_groups.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_service/create_activities.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_service/get_active_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_active_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_service/get_all_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/activity_service/update_activities.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/audience_segment_service/create_audience_segments.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_audience_segments(custom_targeting_key_id, custom_targeting_value_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/audience_segment_service/get_all_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/audience_segment_service/get_first_party_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_first_party_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/audience_segment_service/populate_first_party_audience_segments.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def populate_first_party_audience_segments(audience_segment_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/audience_segment_service/update_audience_segments.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/common/error_handling.rb

@@ -20,7 +20,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/common/oauth2_jwt_handling.rb

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

data/examples/{v201502 → v201602}/common/setup_oauth2.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def setup_oauth2()
   # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml

data/examples/{v201502 → v201602}/company_service/create_companies.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 # Number of companies to create.
 ITEM_COUNT = 5
 
@@ -38,7 +38,8 @@ def create_companies()
 
   # Create an array to store local company objects.
   companies = (1..ITEM_COUNT).map do |index|
-    {:name => "Advertiser #%d" % index, :type => 'ADVERTISER'}
+    {:name => "Advertiser #%d-%d" % [Time.new.to_f * 1000, index],
+     :type => 'ADVERTISER'}
   end
 
   # Create the companies on the server.

data/examples/{v201502 → v201602}/company_service/get_all_companies.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/company_service/get_companies_by_statement.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/company_service/update_companies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/contact_service/create_contacts.rb

@@ -21,7 +21,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/contact_service/get_all_contacts.rb

@@ -21,7 +21,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/contact_service/get_uninvited_contacts.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 PAGE_SIZE = 500
 
 def get_uninvited_contacts()

data/examples/{v201502 → v201602}/contact_service/update_contacts.rb

@@ -22,7 +22,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_contacts()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_metadata_key_hierarchy_service/create_content_metadata_key_hierarchies.rb

@@ -22,7 +22,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_metadata_key_hierarchy_service/delete_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def delete_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_metadata_key_hierarchy_service/get_all_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def update_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_service/get_all_content.rb

@@ -23,7 +23,7 @@
 require 'dfp_api'
 
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/content_service/get_content_by_category.rb

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

data/examples/{v201502 → v201602}/creative_service/copy_image_creatives.rb

@@ -24,7 +24,7 @@ require 'dfp_api'
 
 require 'base64'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/creative_service/create_creative_from_template.rb

@@ -24,7 +24,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_creative_from_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201502 → v201602}/creative_service/create_creatives.rb

@@ -23,7 +23,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201502 → v201602}/creative_service/create_custom_creative.rb

@@ -25,7 +25,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201502
+API_VERSION = :v201602
 
 def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -54,11 +54,14 @@ def create_custom_creative()
       :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}
-      ],
+      :custom_creative_assets => [{
+           :macro_name => 'IMAGE_ASSET',
+           :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!",

data/examples/v201602/creative_service/create_native_creative.rb

@@ -0,0 +1,189 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2015, 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 a new native 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.
+#
+# The code in this example will use app data from the Google sample app
+# 'Pie Noon':
+#
+# https://play.google.com/store/apps/details?id=com.google.fpl.pie_noon&hl=en
+
+require 'base64'
+require 'dfp_api'
+
+API_VERSION = :v201602
+
+def create_creative_from_template()
+  # 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 CreativeService.
+  creative_service = dfp.service(:CreativeService, API_VERSION)
+
+  # Set the ID of the advertiser (company) that all creatives will be assigned
+  # to.
+  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
+
+  # Set the URLs of the application screenshot and the small application icon to
+  # use and convert them to byte array strings.
+  screenshot_url = 'https://lh4.ggpht.com/GIGNKdGHMEHFDw6TM2bgAUDKPQQRIReKZPq' +
+                   'EpMeEhZOPYnTdOQGaSpGSEZflIFs0iw=h300'
+  screenshot_data = AdsCommon::Http.get(screenshot_url, dfp.config)
+  screenshot_data_base64 = Base64.encode64(screenshot_data)
+
+  app_icon = 'https://lh6.ggpht.com/Jzvjne5CLs6fJ1MHF-XeuUfpABzl0YNMlp4' +
+             'RpHnvPRCIj4--eTDwtyouwUDzVVekXw=w300')
+  app_icon_data = AdsCommon::Http.get(app_icon, dfp.config)
+  app_icon_data_base64 = Base64.encode64(app_icon_data)
+
+  # Use the native creative template.
+  creative_template_id = 10004400
+
+  # Create the local custom creative object.
+  creative = {
+      :xsi_type => 'TemplateCreative',
+      :name => "Native creative %d" % Time.new.to_i,
+      :advertiser_id => advertiser_id,
+      :creative_template_id => creative_template_id,
+      :size => {:width => 1, :height => 1, :is_aspect_ratio => false},
+      :destination_url => 'https://play.google.com/store/apps/details?id=' +
+                          'com.google.fpl.pie_noon'
+  }
+
+  # Create the Image asset variable value.
+  image_variable_value = {
+      :xsi_type => 'AssetCreativeTemplateVariableValue',
+      :unique_name => 'Image',
+      :asset => {
+          :asset_byte_array => screenshot_data_base64,
+          # Filenames must be unique.
+          :file_name => "image%d.png" % Time.new.to_i
+      }
+  }
+
+  # Create the Appicon asset variable value.
+  appicon_variable_value = {
+      :xsi_type => 'AssetCreativeTemplateVariableValue',
+      :unique_name => 'Appicon',
+      :asset => {
+          :asset_byte_array => app_icon_data_base64,
+          # Filenames must be unique.
+          :file_name => "image%d.png" % Time.new.to_i
+      }
+  }
+
+  # Create the Price variable value.
+  price_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Price',
+      :value => 'Free'
+  }
+
+  # Create the Calltoaction variable value.
+  calltoaction_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Calltoaction',
+      :value => 'Install'
+  }
+
+  # Create the Starrating variable value.
+  starrating_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Starrating',
+      :value => '4'
+  }
+
+  # Create the Store variable value.
+  store_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Store',
+      :value => 'Google Play'
+  }
+
+  # Create the Headline variable value.
+  headline_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Headline',
+      :value => 'Pie Noon'
+  }
+
+  # Create the Body variable value.
+  body_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Body',
+      :value => 'Try multi-screen mode!'
+  }
+
+  # Create the DeeplinkclickactionURL variable value.
+  deeplinkurl_variable_value = {
+      :xsi_type => 'UrlCreativeTemplateVariableValue',
+      :unique_name => 'DeeplinkclickactionURL',
+      :value => 'market://details?id=com.google.fpl.pie_noon'
+  }
+
+  creative[:creative_template_variable_values] = [
+      deeplinkurl_variable_value,
+      body_variable_value,
+      headline_variable_value,
+      store_variable_value,
+      starrating_variable_value,
+      calltoaction_variable_value,
+      price_variable_value,
+      appicon_variable_value,
+      image_variable_value
+  ]
+
+  # Create the creatives on the server.
+  return_creative = creative_service.create_creatives([creative])[0]
+
+  if return_creative
+    puts(("Native creative with ID: %d and name: %s was " +
+            "created and can be previewed at: '%s'") %
+            [return_creative[:id], return_creative[:name],
+             return_creative[:preview_url]])
+  else
+    raise 'No creatives were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_creative_from_template()
+
+  # 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