google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/creative_template_service/get_creative_template.rb

@@ -0,0 +1,74 @@
+#!/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");
+#           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 a creative template by its ID. To determine which creative
+# templates exist, run get_all_creative_templates.rb.
+#
+# Tags: CreativeTemplateService.getCreativeTemplate
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def get_creative_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 CreativeTemplateService.
+  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
+
+  # Set the ID of the creative_template to get.
+  creative_template_id = 'INSERT_CREATIVE_ID_HERE'.to_i
+
+  # Get the creative_template.
+  creative_template =
+      creative_template_service.get_creative_template(creative_template_id)
+
+  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_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/v201311/creative_template_service/get_creative_templates_by_statement.rb

@@ -0,0 +1,80 @@
+#!/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");
+#           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 up to 500 system defined creative templates.
+#
+# Tags: CreativeTemplateService.getCreativeTemplatesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def get_creative_templates_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 CreativeTemplateService.
+  creative_template_service = dfp.service(:CreativeTemplateService, API_VERSION)
+
+  # Create a statement to only select image creative_templates.
+  statement = {:query => 'LIMIT 500'}
+
+  # Get creative templates by statement.
+  page =
+      creative_template_service.get_creative_templates_by_statement(statement)
+
+  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 "Total number of creative templates: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_creative_templates_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/v201311/creative_wrapper_service/create_creative_wrappers.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 wrapper.
+#
+# Creative wrappers must be associated with a LabelType.CREATIVE_WRAPPER label
+# and applied to ad units by AdUnit.appliedLabels. To determine which creative
+# wrappers exist, run get_all_creative_wrappers.rb.
+#
+# Tags: CreativeWrapperService.createCreativeWrappers
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def create_creative_wrappers()
+  # 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 CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
+
+  # Set the creative wrapper label ID.
+  label_id = 'INSERT_CREATIVE_WRAPPER_LABEL_ID_HERE'.to_i
+
+  # Create creative wrapper objects.
+  creative_wrapper = {
+    # A label can only be associated with one creative wrapper.
+    :label_id => label_id,
+    :ordering => 'INNER',
+    :header => {:html_snippet => '<b>My creative wrapper header</b>'},
+    :footer => {:html_snippet => '<b>My creative wrapper footer</b>'}
+  }
+
+  # Create the creative wrapper on the server.
+  return_creative_wrappers =
+      creative_wrapper_service.create_creative_wrappers([creative_wrapper])
+
+  if return_creative_wrappers
+    return_creative_wrappers.each do |creative_wrapper|
+      puts "Creative wrapper with ID: %d applying to label: %d was created." %
+          [creative_wrapper[:id], creative_wrapper[:label_id]]
+    end
+  else
+    raise 'No creative wrappers were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_creative_wrappers()
+
+  # 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/v201311/creative_wrapper_service/deactivate_creative_wrapper.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 example deactivates a creative wrapper belonging to a label.
+#
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
+# Tags: CreativeWrapperService.performCreativeWrapperAction
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def deactivate_creative_wrappers()
+  # 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 CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
+
+  # Set the ID of the label for the creative wrapper to deactivate.
+  label_id = 'INSERT_CREATIVE_WRAPPER_LABEL_ID_HERE'.to_i
+
+  # Create statement to select creative wrappers by label id and status.
+  statement = {
+      :query => 'WHERE labelId = :label_id AND status = :status',
+      :values => [
+        {
+          :key => 'label_id',
+          :value => {:value => label_id, :xsi_type => 'NumberValue'}
+        },
+        {
+          :key => 'status',
+          :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+        }
+      ]
+  }
+
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
+
+  if page[:results]
+    page[:results].each do |creative_wrapper|
+      puts 'Creative wrapper ID: %d, label: %d will be deactivated.' %
+          [creative_wrapper[:id], creative_wrapper[:label_id]]
+    end
+
+    # Perform action.
+    result = creative_wrapper_service.perform_creative_wrapper_action(
+        {:xsi_type => 'DeactivateCreativeWrappers'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts 'Number of creative wrappers deactivated: %d' % result[:num_changes]
+    else
+      puts 'No creative wrappers were deactivated.'
+    end
+  else
+    puts 'No creative wrapper found to deactivate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    deactivate_creative_wrappers()
+
+  # 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/v201311/creative_wrapper_service/get_all_creative_wrappers.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 example gets all creative wrappers for an account. To create creative
+# wrappers, run create_creative_wrappers.rb.
+#
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def get_all_creative_wrappers()
+  # 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 CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get creative wrappers by statement.
+    page =
+      creative_wrapper_service.get_creative_wrappers_by_statement(statement)
+
+    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 wrapper in results page.
+      page[:results].each_with_index do |creative_wrapper, index|
+        puts "%d) Creative wrapper ID: %d, label ID: %d" % [index + start_index,
+            creative_wrapper[:id], creative_wrapper[:label_id]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of creative wrappers: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_creative_wrappers()
+
+  # 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/v201311/creative_wrapper_service/get_creative_wrappers_by_statement.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 active creative wrappers. To create creative
+# wrappers, run create_creative_wrappers.rb.
+#
+# Tags: CreativeWrapperService.getCreativeWrappersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def get_creative_wrappers_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 CreativeWrapperService.
+  creative_wrapper_service = dfp.service(:CreativeWrapperService, API_VERSION)
+
+  # Create filter text to select active creative wrappers.
+  statement = {
+      :query => 'WHERE status = :status',
+      :values => [
+        {
+          :key => 'status',
+          :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+        }
+      ]
+  }
+
+  # Get creative wrappers by statement.
+  page = creative_wrapper_service.get_creative_wrappers_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |creative_wrapper, index|
+      puts "%d) Creative wrapper ID: %d, label ID: %d, status: '%s'." %
+          [index, creative_wrapper[:id], creative_wrapper[:label_id],
+           creative_wrapper[:status]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_creative_wrappers_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