google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/creative_service/create_creative_from_template.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -22,13 +20,11 @@
 # determine which companies are advertisers, run get_companies_by_statement.rb.
 # To determine which creatives already exist, run get_all_creatives.rb. To
 # determine which creative templates run get_all_creative_templates.rb.
-#
-# Tags: CreativeService.createCreative
 
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_creative_from_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -105,7 +101,7 @@ def create_creative_from_template()
       url_variable_value, target_window_variable_value]
 
   # Create the creatives on the server.
-  return_creative = creative_service.create_creative(creative)
+  return_creative = creative_service.create_creatives([creative])[0]
 
   if return_creative
     puts(("Template creative with ID: %d, name: %s and type '%s' was " +

data/examples/{v201408 → v201508}/creative_service/create_creatives.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -21,13 +19,11 @@
 # This example creates new image creatives 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
 
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201408 → v201508}/creative_service/create_custom_creative.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -23,13 +21,11 @@
 # determine which creatives already exist, run get_all_creatives.rb.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: CreativeService.createCreative
 
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/v201508/creative_service/create_native_creative.rb

@@ -0,0 +1,195 @@
+#!/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 = :v201508
+
+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},
+      :is_native_eligible => True,
+      :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_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_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'
+  }
+
+  # Create the FallbackclickactionURL variable value.
+  fallbackurl_variable_value= {
+      :xsi_type => 'UrlCreativeTemplateVariableValue',
+      :unique_name => 'FallbackclickactionURL',
+      :value => 'https://play.google.com/store/apps/details?id=' +
+                'com.google.fpl.pie_noon'
+  }
+
+  creative[:creative_template_variable_values] = [
+      fallbackurl_variable_value,
+      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

data/examples/{v201408 → v201508}/creative_service/get_all_creatives.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -19,13 +17,11 @@
 #           limitations under the License.
 #
 # This example gets all creatives. To create creatives, run create_creatives.rb.
-#
-# Tags: CreativeService.getCreativesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,33 +34,23 @@ def get_all_creatives()
   # Get the CreativeService.
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get one page with current offset.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "ORDER BY id ASC LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]}
-
     # Get creatives by statement.
-    page = creative_service.get_creatives_by_statement(statement)
+    page = creative_service.get_creatives_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each creative in results.
       page[:results].each_with_index do |creative, index|
         puts "%d) Creative ID: %d, name: %s, type: %s" %
-            [index + start_index, creative[:id],
+            [index + statement.offset, creative[:id],
              creative[:name], creative[:creative_type]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201408 → v201508}/creative_service/get_creatives_by_statement.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -21,12 +19,11 @@
 # This example gets all image creatives. The statement retrieves up to the
 # maximum page size limit of 500. To create an image creative, run
 # create_creatives.rb.
-#
-# Tags: CreativeService.getCreativesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,24 +37,28 @@ def get_creatives_by_statement()
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
   # Create a statement to only select image creatives.
-  statement = {
-     :query => 'WHERE creativeType = :creative_type ORDER BY id ASC LIMIT 500',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE creativeType = :creative_type ORDER BY id ASC',
+     [
          {:key => 'creative_type',
           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
      ]
-  }
+  )
 
-  # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  begin
+    # Get creatives by statement.
+    page = creative_service.get_creatives_by_statement(statement.toStatement())
 
-  if page[:results]
-    # Print details about each creative in results.
-    page[:results].each_with_index do |creative, index|
-      puts "%d) Creative ID: %d, name: %s, type: %s" %
-          [index, creative[:id], creative[:name], creative[:creative_type]]
+    if page[:results]
+      # Print details about each creative in results.
+      page[:results].each_with_index do |creative, index|
+        puts "%d) Creative ID: %d, name: %s, type: %s" %
+            [index + statement.offset,
+             creative[:id], creative[:name], creative[:creative_type]]
+      end
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201408 → v201508}/creative_service/update_creatives.rb

@@ -1,8 +1,6 @@
 #!/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");
@@ -18,14 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the destination URL of all image creatives up to the
-# first 500. To determine which image creatives exist, run get_all_creatives.rb.
-#
-# Tags: CreativeService.getCreativesByStatement, CreativeService.updateCreatives
+# This example updates the destination URL of a single creative searching by ID.
+# To determine which image creatives exist, run get_all_creatives.rb.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,17 +35,21 @@ def update_creatives()
   # Get the CreativeService.
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
+  # Specify creative ID to update.
+  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+
   # Create a statement to get first 500 image creatives.
-  statement = {
-      :query => "WHERE creativeType = :creative_type LIMIT 500",
-      :values => [
-          {:key => 'creative_type',
-           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-      ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value =>  creative_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
+  page = creative_service.get_creatives_by_statement(statement.toStatement())
 
   if page[:results]
     creatives = page[:results]