google-dfp-api 0.17.0 → 0.19.0

data/examples/v201605/creative_set_service/get_creative_sets_by_statement.rb

@@ -1,92 +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 for a master creative. To create
-# creative sets, run create_creative_sets.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_creative_sets_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')
-
-  master_creative_id = 'INSERT_MASTER_CREATIVE_ID_HERE'.to_i
-
-  # Get the CreativeSetService.
-  creative_set_service = dfp.service(:CreativeSetService, API_VERSION)
-
-  # Create a statement to get all creative sets that have the given master
-  # creative.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE masterCreativeId = :master_creative_id ORDER BY id ASC',
-      [
-          {:key => 'master_creative_id',
-           :value => {:value => master_creative_id, :xsi_type => 'NumberValue'}}
-      ]
-  )
-
-  begin
-    # Get creative sets by statement.
-    page = creative_set_service.get_creative_sets_by_statement(
-        statement.toStatement())
-
-    if page and page[:results]
-      page[:results].each_with_index do |creative_set, index|
-        puts ('%d) Creative set ID: %d, master creative ID: %d and companion ' +
-            'creative IDs: [%s]') %
-            [index + statement.offset, creative_set[:id],
-             creative_set[:master_creative_id],
-             creative_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 'Number of results found: %d' % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_creative_sets_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/v201605/creative_set_service/update_creative_sets.rb

@@ -1,98 +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 code example updates a creative set by adding a companion creative. To
-# determine which creative sets exist, run get_all_creative_sets.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def update_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')
-
-  # Set the IDs of the creative set to get and companion creative ID to add.
-  creative_set_id = 'INSERT_CREATIVE_SET_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 a statement to only select a single creative set.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE id = :id'
-      [
-          {:key => 'id',
-           :value => {:value => creative_set_id, :xsi_type => 'NumberValue'}}
-      ],
-      1
-  )
-
-  # Get creative sets by statement.
-  page = creative_set_service.get_creative_sets_by_statement(
-      statement.toStatement())
-
-  if page[:results]
-    creative_sets = page[:results]
-
-    creative_sets.each do |creative_set|
-      # Update the creative set locally.
-      creative_set[:companion_creative_ids] << companion_creative_id
-    end
-
-    # Update the creative set on the server.
-    return_creative_set = creative_set_service.update_creative_set(creative_set)
-
-    if return_creative_set
-       puts ('Creative set ID: %d, master creative ID: %d was updated with ' +
-           'companion creative IDs: [%s]') %
-           [creative_set[:id],
-            creative_set[:master_creative_id],
-            creative_set[:companion_creative_ids].join(', ')]
-    else
-      raise 'No creative sets were updated.'
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_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

data/examples/v201605/creative_template_service/get_all_creative_templates.rb

@@ -1,82 +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 creative templates.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-def get_all_creative_templates()
-  # 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 get one page with current offset.
-  statement = DfpApi::FilterStatement.new(ORDER BY id ASC)
-
-  begin
-
-    # Get creative templates by statement.
-    page = creative_template_service.get_creative_templates_by_statement(
-        statement.toStatement())
-
-    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 + statement.offset, template[:id],
-             template[:name], template[: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 creative templates: %d" % page[:total_result_set_size]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_creative_templates()
-
-  # 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/v201605/creative_template_service/get_system_defined_creative_templates.rb

@@ -1,87 +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 system defined creative templates.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 system defined creative_templates.
-  statement = DfpApi::FilterStatement.new(
-      'WHERE type = :type ORDER BY id ASC',
-      [
-          {:key => 'type',
-           :value => {:value => 'SYSTEM_DEFINED', :xsi_type => 'TextValue'}}
-      ]
-  )
-
-  begin
-    # Get creative templates by statement.
-    page = creative_template_service.get_creative_templates_by_statement(
-        statement.toStatement())
-
-    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 + statement.offset,
-             template[:id], template[:name], template[: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 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/v201605/creative_wrapper_service/create_creative_wrappers.rb

@@ -1,85 +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 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.
-
-require 'dfp_api'
-
-API_VERSION = :v201605
-
-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/v201605/creative_wrapper_service/deactivate_creative_wrapper.rb

@@ -1,99 +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 example deactivates a creative wrapper belonging to a label.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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 = DfpApi::FilterStatement.new(
-      'WHERE labelId = :label_id AND status = :status',
-      [
-        {
-          :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.toStatement())
-
-  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.toStatement())
-
-    # 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/v201605/creative_wrapper_service/get_all_creative_wrappers.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 example gets all creative wrappers for an account. To create creative
-# wrappers, run create_creative_wrappers.rb.
-
-require 'dfp_api'
-
-
-API_VERSION = :v201605
-
-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)
-
-  # Create statement for one page with current offset.
-  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
-
-  begin
-    # Get creative wrappers by statement.
-    page = creative_wrapper_service.get_creative_wrappers_by_statement(
-        statement.toStatement())
-
-    if page[:results]
-      # 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 + statement.offset,
-            creative_wrapper[:id], creative_wrapper[:label_id]]
-      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 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