google-adwords-api 0.7.2 → 0.8.0

data/examples/v201109_1/error_handling/handle_two_factor_authorization_error.rb

@@ -1,87 +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 illustrates how to handle 'two factor' authorization error.
-
-require 'adwords_api'
-
-def handle_two_factor_authorization_error()
-  # Set up credentials with an account that has 2Factor enabled.
-  config = {
-      :authentication => {
-          :method => 'ClientLogin',
-          :email => '2steptester@gmail.com',
-          :password => 'testaccount',
-          :user_agent => 'Ruby 2 Factor Sample'
-      },
-      :service => {
-          :environment => 'PRODUCTION'
-      }
-  }
-  adwords = AdwordsApi::Api.new(config)
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  begin
-    # Forcing library to request authorization token.
-    auth_token = adwords.authorize()
-    puts 'Successfully retrieved the token.'
-
-  # Second factor error is one of AuthErrors.
-  rescue AdsCommon::Errors::AuthError => e
-    puts "Authorization failed with message:"
-    puts "\t%s" % e.message
-    # Checking 'Info' field for particular auth error type.
-    if e.info and e.info.casecmp('InvalidSecondFactor') == 0
-      puts "The user has enabled two factor authentication in this account." +
-      " Please use OAuth authentication method or have the user generate an" +
-      " application-specific password to make calls against the AdWords" +
-      " API. See \n" +
-      "    http://adwordsapi.blogspot.com/2011/02/authentication-changes-with" +
-      "-2-step.html\n" +
-      "for more details."
-    end
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  begin
-    handle_two_factor_authorization_error()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::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/v201109_1/misc/get_all_images_and_videos.rb

@@ -1,100 +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 illustrates how to retrieve all images and videos. To upload an
-# image, run upload_image.rb. To upload video, see:
-#   http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454.
-#
-# Tags: MediaService.get
-
-require 'adwords_api'
-
-def get_all_images_and_videos()
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  media_srv = adwords.service(:MediaService, API_VERSION)
-
-  # Get all the images and videos.
-  selector = {
-    :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
-    :ordering => [
-      {:field => 'MediaId', :sort_order => 'ASCENDING'}
-    ],
-    :predicates => [
-      {:field => 'Type', :operator => 'IN', :values => ['IMAGE', 'VIDEO']}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = media_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |entry|
-        full_dimensions = entry[:dimensions]['FULL']
-        puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
-            [entry[:media_id], full_dimensions[:height],
-             full_dimensions[:width], entry[:mime_type]]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  if page.include?(:total_num_entries)
-    puts "\tFound %d entries." % page[:total_num_entries]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-  PAGE_SIZE = 500
-
-  begin
-    get_all_images_and_videos()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::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/v201109_1/misc/upload_image.rb

@@ -1,89 +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 uploads an image. To get images, run get_all_images.rb.
-#
-# Tags: MediaService.upload
-
-require 'adwords_api'
-require 'base64'
-
-def upload_image()
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  media_srv = adwords.service(:MediaService, API_VERSION)
-
-  # Create image.
-  image_url =
-      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
-  # This utility method retrieves the contents of a URL using all of the config
-  # options provided to the Api object.
-  image_data = AdsCommon::Http.get(image_url, adwords.config)
-  base64_image_data = Base64.encode64(image_data)
-  image = {
-    # The 'xsi_type' field allows you to specify the xsi:type of the object
-    # being created. It's only necessary when you must provide an explicit
-    # type that the client library can't infer.
-    :xsi_type => 'Image',
-    :data => base64_image_data,
-    :type => 'IMAGE'
-  }
-
-  # Upload image.
-  response = media_srv.upload([image])
-  if response and !response.empty?
-    ret_image = response.first
-    full_dimensions = ret_image[:dimensions]['FULL']
-    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
-        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
-         full_dimensions[:width], ret_image[:mime_type]]
-  else
-    puts 'No images uploaded.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-
-  begin
-    upload_image()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::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/v201109_1/misc/use_oauth.rb

@@ -1,100 +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 illustrates how to use OAuth1.0a authentication method.
-#
-# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
-#       See use_oauth2.rb for an example.
-#
-# Tags: CampaignService.get
-
-require 'adwords_api'
-
-def use_oauth()
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Get all the campaigns for this account; empty selector.
-  selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [
-      {:field => 'Name', :sort_order => 'ASCENDING'}
-    ]
-  }
-
-  retry_count = 0
-
-  begin
-    response = campaign_srv.get(selector)
-  rescue AdsCommon::Errors::OAuthVerificationRequired => e
-    if retry_count < MAX_RETRIES
-      puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
-      print 'log in and type the verification code: '
-      verification_code = gets.chomp
-      adwords.credential_handler.set_credential(
-          :oauth_verification_code, verification_code)
-      retry_count += 1
-      retry
-    else
-      raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-    end
-  end
-
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaigns.each do |campaign|
-      puts "Campaign ID %d, name '%s' and status '%s'" %
-          [campaign[:id], campaign[:name], campaign[:status]]
-    end
-  else
-    puts 'No campaigns were found.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-  MAX_RETRIES = 3
-
-  begin
-    use_oauth()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::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/v201109_1/misc/use_oauth2.rb

@@ -1,97 +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 illustrates how to use OAuth2.0 authentication method.
-#
-# Tags: CampaignService.get
-
-require 'adwords_api'
-
-def use_oauth2()
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the configuration file or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Get all the campaigns for this account; empty selector.
-  selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [
-      {:field => 'Name', :sort_order => 'ASCENDING'}
-    ]
-  }
-
-  retry_count = 0
-
-  begin
-    response = campaign_srv.get(selector)
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    if retry_count < MAX_RETRIES
-      puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
-      print 'log in and type the verification code: '
-      verification_code = gets.chomp
-      adwords.credential_handler.set_credential(
-          :oauth2_verification_code, verification_code)
-      retry_count += 1
-      retry
-    else
-      raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-    end
-  end
-
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaigns.each do |campaign|
-      puts "Campaign ID %d, name '%s' and status '%s'" %
-          [campaign[:id], campaign[:name], campaign[:status]]
-    end
-  else
-    puts 'No campaigns were found.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109_1
-  MAX_RETRIES = 3
-
-  begin
-    use_oauth2()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::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