google-dfp-api 0.17.0 → 0.19.0

data/examples/v201602/creative_service/create_native_creative.rb

@@ -1,189 +0,0 @@
-#!/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

data/examples/v201602/creative_service/get_all_creatives.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 gets all creatives. To create creatives, run create_creatives.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_all_creatives()
-  # 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)
-
-  # Create a statement to get one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  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 + statement.offset, creative[:id],
-             creative[:name], creative[:creative_type]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of creatives: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_creatives()
-
-  # 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/v201602/creative_service/get_creatives_by_statement.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 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.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_creatives_by_statement()
-  # 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)
-
-  # Create a statement to only select image creatives.
-  statement = DfpApi::FilterStatement.new(
-     'WHERE creativeType = :creative_type ORDER BY id ASC',
-     [
-         {:key => 'creative_type',
-          :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-     ]
-  )
-
-  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 + statement.offset,
-             creative[:id], creative[:name], creative[:creative_type]]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer.
-  if page.include?(:total_result_set_size)
-    puts "Total number of creatives: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creatives_by_statement()
-
-  # 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/v201602/creative_service/update_creatives.rb

@@ -1,97 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 destination URL of a single creative searching by ID.
-# To determine which image creatives exist, run get_all_creatives.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def update_creatives()
-  # 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)
-
-  # Specify creative ID to update.
-  creative_id = 'INSERT_CREATIVE_ID_HERE'.to_i
-
-  # Create a statement to get first 500 image creatives.
-  statement = DfpApi::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.toStatement())
-
-  if page[:results]
-    creatives = page[:results]
-
-    # Update each local creative object by changing its destination URL.
-    creatives.each do |creative|
-      creative[:destination_url] = 'http://news.google.com'
-    end
-
-    # Update the creatives on the server.
-    return_creatives = creative_service.update_creatives(creatives)
-
-    if return_creatives
-      return_creatives.each do |creative|
-        puts "Creative with ID: %d, name: %s and url: [%s] was updated." %
-            [creative[:id], creative[:name], creative[:destination_url]]
-      end
-    else
-      raise 'No creatives were updated.'
-    end
-  else
-    puts 'No creatives found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_creatives()
-
-  # 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/v201602/creative_set_service/associate_creative_set_to_line_item.rb

@@ -1,73 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2012, 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 code example creates a line item creative association for a creative
-# set. To create creative sets, run create_creative_set.rb. To create creatives,
-# run create_creatives.rb. To determine which LICAs exist, run get_all_licas.rb.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def associate_creative_set_to_line_item()
-  # 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')
-
-  # Set the line item ID and creative set ID to associate.
-  line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
-  creative_set_id = 'INSERT_CREATIVE_SET_ID_HERE'.to_i
-
-  # Get the LineItemCreativeAssociationService.
-  lica_service = dfp.service(:LineItemCreativeAssociationService, API_VERSION)
-
-  lica = {
-    :creative_set_id => creative_set_id,
-    :line_item_id => line_item_id
-  }
-
-  # Create the LICAs on the server.
-  return_lica = lica_service.create_line_item_creative_associations([lica])
-
-  puts 'A LICA with line item ID %d and creative set ID %d was created.' %
-      [return_lica[:line_item_id], return_lica[:creative_set_id]]
-end
-
-if __FILE__ == $0
-  begin
-    associate_creative_set_to_line_item()
-
-  # 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/v201602/creative_set_service/create_creative_set.rb

@@ -1,79 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2012, 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 code example creates a new creative set.
-
-require 'dfp_api'
-
-API_VERSION = :v201602
-
-def create_creative_set()
-  # 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')
-
-  master_creative_id = 'INSERT_MASTER_CREATIVE_ID_HERE'.to_i
-  companion_creative_id = 'INSERT_COMPANION_CREATIVE_ID_HERE'.to_i
-
-  # Get the CreativeSetService.
-  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
-
-  # Create an array to store local creative set object.
-  creative_set = {
-      :name => 'Creative set #%d' % (Time.new.to_f * 1000),
-      :master_creative_id => master_creative_id,
-      :companion_creative_ids => [companion_creative_id]
-  }
-
-  # Create the creative set on the server.
-  return_set = creative_set_service.create_creative_set(creative_set)
-
-  if return_set
-    puts ('Creative set with ID: %d, master creative ID: %d and companion ' +
-        'creative IDs: [%s] was created') %
-        [return_set[:id], return_set[:master_creative_id],
-         return_set[:companion_creative_ids].join(', ')]
-  else
-    raise 'No creative set was created.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    create_creative_set()
-
-  # 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/v201602/creative_set_service/get_all_creative_sets.rb

@@ -1,82 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2012, 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 code example gets all creative sets. To create creative sets run
-# create_creative_set.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201602
-
-def get_all_creative_sets()
-  # 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 CreativeSetService.
-  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get creative sets by statement.
-    page = creative_set_service.get_creative_sets_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # Print details about each creative set in results page.
-      page[:results].each_with_index do |set, index|
-        puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
-            'creative IDs: [%s]') % [index + statement.offset, set[:id],
-            set[:master_creative_id], set[:companion_creative_ids].join(', ')]
-      end
-    end
-    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
-  end while statement.offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts "Total number of creative sets: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_creative_sets()
-
-  # 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