google-dfp-api 0.6.3 → 0.7.0

data/examples/v201203/user_service/update_users.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 updates all users by adding "Sr." to the end of each name (after
-# a very large baby boom and lack of creativity). To determine which users
-# exist, run get_all_users.rb.
-#
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
-
-require 'dfp_api'
-
-API_VERSION = :v201203
-
-def update_users()
-  # 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 UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Create a statement to get all users.
-  statement = {:query => 'LIMIT 500'}
-
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
-
-  if page[:results]
-    users = page[:results]
-
-    # Update each local users object by changing its name.
-    users.each {|user| user[:name] += ' Sr.'}
-
-    # Update the users on the server.
-    return_users = user_service.update_users(users)
-
-    if return_users
-      return_users.each do |user|
-        puts ("User ID: %d, email: %s was updated with name %s") %
-            [user[:id], user[:email], user[:name]]
-      end
-    else
-      raise 'No users were updated.'
-    end
-  else
-    puts 'No users found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_users()
-
-  # 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/v201204/common/oauth2_handling.rb

@@ -1,128 +0,0 @@
-#!/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 shows how to use OAuth2.0 authorization method. It is designed to
-# be run from console and requires user input.
-#
-# Tags: UserService.getUsersByStatement
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-PAGE_SIZE = 500
-MAX_RETRIES = 3
-
-def oauth2_handling()
-  # 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')
-
-  # Forcing authorization. A callback URL and other parameters could be
-  # specified as parameter for OAuth method.
-  token = dfp.authorize({:oauth_callback => 'oob'}) do |oauth_url|
-    # For command-line we ask user to go to URL and type in code.
-    verification_code = get_verification_code(oauth_url)
-    # Return verification code from the block.
-    (verification_code.empty?) ? nil : verification_code
-  end
-
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
-
-  # Define initial values.
-  offset = 0
-  page = Hash.new
-  retry_count = 0
-
-  begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
-    begin
-      # Get users by statement.
-      page = user_service.get_users_by_statement(statement)
-
-    # The second way to do OAuth authentication is to make a request and catch
-    # the OAuthVerificationRequired exception. Add the verification code to the
-    # credentials once acquired.
-    rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-      if retry_count < MAX_RETRIES
-        verification_code = get_verification_code(e.oauth_url)
-        dfp.credential_handler.set_credential(
-            :oauth2_verification_code, verification_code)
-        retry_count += 1
-        retry
-      else
-        raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-      end
-    end
-
-    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 user in results page.
-      page[:results].each_with_index do |user, index|
-        puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + start_index, user[:id], user[:name], user[:email]]
-      end
-    end
-  end while offset < page[:total_result_set_size]
-
-  # Print a footer
-  if page.include?(:total_result_set_size)
-    puts "Total number of users: %d" % page[:total_result_set_size]
-  end
-end
-
-# Misc util to get the verification code from the console.
-def get_verification_code(url)
-  puts "Hit Auth error, please navigate to URL:\n\t%s" % url
-  print 'Log in and type the verification code: '
-  verification_code = gets.chomp
-  return verification_code
-end
-
-if __FILE__ == $0
-  begin
-    oauth2_handling()
-
-  # 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/v201204/company_service/update_companies.rb

@@ -1,95 +0,0 @@
-#!/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 updates the names of all companies that are advertisers by
-# appending "LLC." up to the first 500. To determine which companies exist, run
-# get_all_companies.rb.
-#
-# Tags: CompanyService.getCompaniesByStatement, CompanyService.updateCompanies
-
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-def update_companies()
-  # 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 CompanyService.
-  company_service = dfp.service(:CompanyService, API_VERSION)
-
-  # Create a statement to only select companies that are advertisers.
-  statement = {
-      :query => "WHERE type = :type LIMIT 500",
-      :values => [
-          {:key => 'type',
-           :value => {:value => 'ADVERTISER', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get companies by statement.
-  page = company_service.get_companies_by_statement(statement)
-
-  if page[:results]
-    companies = page[:results]
-
-    # Update each local company object by appending ' LLC.' to its name.
-    companies.each {|company| company[:name] += ' LLC.'}
-
-    # Update the companies on the server.
-    return_companies = company_service.update_companies(companies)
-
-    if return_companies
-      return_companies.each do |company|
-        puts "A company with ID [%d], name: %s and type %s was updated." %
-            [company[:id], company[:name], company[:type]]
-      end
-    else
-      raise 'No companies were updated.'
-    end
-  else
-    puts 'No companies found to update.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    update_companies()
-
-  # 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/v201204/creative_service/copy_image_creatives.rb

@@ -1,115 +0,0 @@
-#!/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 copies a given set of image creatives. This would typically be
-# done to reuse creatives in a small business network. To determine which
-# creatives exist, run get_all_creatives.rb.
-#
-# Tags: CreativeService.getCreativesByStatement, CreativeService.createCreatives
-
-require 'dfp_api'
-
-require 'base64'
-
-API_VERSION = :v201204
-
-def copy_image_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 list of creative ids to copy.
-  image_creative_ids = [
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i,
-      'INSERT_IMAGE_CREATIVE_ID_HERE'.to_i
-  ]
-
-  # Create the statement to filter image creatives by ID.
-  statement = {
-      :query => "WHERE id IN (%s) AND creativeType = :creative_type" %
-          image_creative_ids.join(', '),
-      :values => [
-          {:key => 'creative_type',
-           :value => {:value => 'ImageCreative', :xsi_type => 'TextValue'}}
-      ]
-  }
-
-  # Get creatives by statement.
-  page = creative_service.get_creatives_by_statement(statement)
-
-  if page[:results]
-    creatives = page[:results]
-
-    # Copy each local creative object and change its name.
-    new_creatives = creatives.map do |creative|
-      new_creative = creative.dup()
-      old_id = new_creative.delete(:id)
-      new_creative[:name] += " (Copy of %d)" % old_id
-      image_url = new_creative.delete(:image_url)
-      new_creative[:image_byte_array] =
-          Base64.encode64(AdsCommon::Http.get(image_url))
-      new_creative
-    end
-
-    # Create the creatives on the server.
-    return_creatives = creative_service.create_creatives(new_creatives)
-
-    # Display copied creatives.
-    if return_creatives
-      return_creatives.each_with_index do |creative, index|
-        puts "A creative with ID [%d] was copied to ID [%d], name: %s" %
-            [creatives[index][:id], creative[:id], creative[:name]]
-      end
-    else
-      raise 'No creatives were copied.'
-    end
-  else
-    puts 'No creatives found to copy.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    copy_image_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/v201204/creative_service/create_creative_from_template.rb

@@ -1,139 +0,0 @@
-#!/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 creates a new template 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. To
-# determine which creative templates run get_all_creative_templates.rb.
-#
-# Tags: CreativeService.createCreative
-
-require 'base64'
-require 'dfp_api'
-
-API_VERSION = :v201204
-
-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
-
-  # Use the image banner with optional third party tracking template.
-  creative_template_id = 10000680
-
-  # Create the local custom creative object.
-  creative = {
-      :xsi_type => 'TemplateCreative',
-      :name => 'Template creative',
-      :advertiser_id => advertiser_id,
-      :creative_template_id => creative_template_id,
-      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
-  }
-
-  # Prepare image data for asset value.
-  image_url =
-      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  image_data = AdsCommon::Http.get(image_url)
-  image_data_base64 = Base64.encode64(image_data)
-
-  # Create the asset variable value.
-  asset_variable_value = {
-      :xsi_type => 'AssetCreativeTemplateVariableValue',
-      :unique_name => 'Imagefile',
-      :asset_byte_array => image_data_base64,
-      # Filenames must be unique.
-      :file_name => "image%d.jpg" % Time.new.to_i
-  }
-
-  # Create the image width variable value.
-  image_width_variable_value = {
-      :xsi_type => 'LongCreativeTemplateVariableValue',
-      :unique_name => 'Imagewidth',
-      :value => 300
-  }
-
-  # Create the image height variable value.
-  image_height_variable_value = {
-      :xsi_type => 'LongCreativeTemplateVariableValue',
-      :unique_name => 'Imageheight',
-      :value => 250
-  }
-
-  # Create the URL variable value.
-  url_variable_value = {
-      :xsi_type => 'UrlCreativeTemplateVariableValue',
-      :unique_name => 'ClickthroughURL',
-      :value => 'www.google.com'
-  }
-
-  # Create the target window variable value.
-  target_window_variable_value = {
-      :xsi_type => 'StringCreativeTemplateVariableValue',
-      :unique_name => 'Targetwindow',
-      :value => '__blank'
-  }
-
-  creative[:creative_template_variable_values] = [asset_variable_value,
-      image_width_variable_value, image_height_variable_value,
-      url_variable_value, target_window_variable_value]
-
-  # Create the creatives on the server.
-  return_creative = creative_service.create_creative(creative)
-
-  if return_creative
-    puts(("Template creative with ID: %d, name: %s and type '%s' was " +
-            "created and can be previewed at: '%s'") %
-            [return_creative[:id], return_creative[:name],
-             return_creative[:creative_type], 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