google-dfp-api 0.10.1 → 0.12.0

data/examples/{v201411 → v201511}/content_metadata_key_hierarchy_service/update_content_metadata_key_hierarchies.rb

@@ -21,9 +21,9 @@
 # This feature is only available to DFP video publishers.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def update_content_metadata_key_hierarchies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,7 +44,7 @@ def update_content_metadata_key_hierarchies()
   custom_targeting_key_id = "INSERT_CUSTOM_TARGETING_KEY_ID_HERE"
 
   # Create a statement to only select a single content metadata key hierarchy.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE id = :id ORDER BY id ASC',
       [
           {:key => 'id',

data/examples/{v201411 → v201511}/content_service/get_all_content.rb

@@ -21,9 +21,9 @@
 # This feature is only available to DFP video publishers.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,7 +37,7 @@ def get_all_content()
   content_service = dfp.service(:ContentService, API_VERSION)
 
   # Create statement for one page with current offset.
-  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
+  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
 
   begin
     # Get content by statement.
@@ -50,7 +50,7 @@ def get_all_content()
              content[:id], content[:name], content[:status]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer

data/examples/{v201411 → v201511}/content_service/get_content_by_category.rb

@@ -22,9 +22,9 @@
 # This feature is only available to DFP video publishers.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_content_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +46,7 @@ def get_content_by_statement()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to select the categories matching the name comedy.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE customTargetingKeyId = :targeting_key_id' +
       ' and name = :category ORDER BY id ASC',
       [
@@ -71,7 +71,7 @@ def get_content_by_statement()
     # Get the ContentService.
     content_service = dfp.service(:ContentService, API_VERSION)
 
-    statement = DfpApiStatement::FilterStatement.new(
+    statement = DfpApi::FilterStatement.new(
         'WHERE status = :status ORDER BY id ASC',
         [
             {:key => 'status',
@@ -92,7 +92,7 @@ def get_content_by_statement()
                content[:status]]
         end
       end
-      statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+      statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
     end while statement.offset < page[:total_result_set_size]
 
     # Print a footer.

data/examples/{v201411 → v201511}/creative_service/copy_image_creatives.rb

@@ -21,10 +21,10 @@
 # creatives exist, run get_all_creatives.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
+
 require 'base64'
 
-API_VERSION = :v201411
+API_VERSION = :v201511
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,7 +46,7 @@ def copy_image_creatives()
   ]
 
   # Create the statement to filter image creatives by ID.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       "WHERE id IN (%s) AND creativeType = :creative_type" %
           image_creative_ids.join(', '),
       [

data/examples/{v201411 → v201511}/creative_service/create_creative_from_template.rb

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

data/examples/{v201411 → v201511}/creative_service/create_creatives.rb

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

data/examples/{v201411 → v201511}/creative_service/create_custom_creative.rb

@@ -25,7 +25,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201411
+API_VERSION = :v201511
 
 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/v201511/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 = :v201511
+
+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

data/examples/{v201411 → v201511}/creative_service/get_all_creatives.rb

@@ -19,9 +19,9 @@
 # This example gets all creatives. To create creatives, run create_creatives.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_all_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -35,7 +35,7 @@ def get_all_creatives()
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
   # Create a statement to get one page with current offset.
-  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
+  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
 
   begin
     # Get creatives by statement.
@@ -49,7 +49,7 @@ def get_all_creatives()
              creative[:name], creative[:creative_type]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.

data/examples/{v201411 → v201511}/creative_service/get_creatives_by_statement.rb

@@ -21,9 +21,9 @@
 # create_creatives.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,7 +37,7 @@ def get_creatives_by_statement()
   creative_service = dfp.service(:CreativeService, API_VERSION)
 
   # Create a statement to only select image creatives.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
      'WHERE creativeType = :creative_type ORDER BY id ASC',
      [
          {:key => 'creative_type',
@@ -57,7 +57,7 @@ def get_creatives_by_statement()
              creative[:id], creative[:name], creative[:creative_type]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.

data/examples/{v201411 → v201511}/creative_service/update_creatives.rb

@@ -20,9 +20,9 @@
 # To determine which image creatives exist, run get_all_creatives.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,7 +39,7 @@ def update_creatives()
   creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
 
   # Create a statement to get first 500 image creatives.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE id = :id ORDER BY id ASC',
       [
           {:key => 'id',

data/examples/{v201411 → v201511}/creative_set_service/associate_creative_set_to_line_item.rb

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

data/examples/{v201411 → v201511}/creative_set_service/create_creative_set.rb

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