google-adx-buyer-api 0.4.2 → 0.4.3

data/examples/v201206/misc/use_oauth.rb

@@ -0,0 +1,97 @@
+#!/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 OAuth authentication method.
+#
+# 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 = :v201206
+  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/v201206/optimization/get_placement_ideas.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 retrieves URLs that have content keywords related to a given
+# website.
+#
+# Tags: TargetingIdeaService.get
+
+require 'adwords_api'
+require 'adwords_api/utils'
+
+def get_placement_ideas(url)
+  # 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')
+
+  targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
+
+  # Construct selector.
+  selector = {
+    :idea_type => 'PLACEMENT',
+    :request_type => 'IDEAS',
+    :requested_attribute_types => ['CRITERION'],
+    :search_parameters => [{
+      # 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 => 'RelatedToUrlSearchParameter',
+      :urls => [url],
+      :include_sub_urls => false
+    }],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Define initial values.
+  offset = 0
+  results = []
+
+  begin
+    # Perform request.
+    page = targeting_idea_srv.get(selector)
+    results += page[:entries] if page and page[:entries]
+
+    # Prepare next page request.
+    offset += PAGE_SIZE
+    selector[:paging][:start_index] = offset
+  end while offset < page[:total_num_entries]
+
+  # Display results.
+  results.each do |result|
+    data = AdwordsApi::Utils.map(result[:data])
+    placement = data['CRITERION'][:value]
+    puts "Related placement found at URL [%s]" % placement[:url]
+  end
+  puts "Total URLs found with keywords related to keywords at [%s]: %d." %
+      [url, results.length]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201206
+  PAGE_SIZE = 100
+
+  begin
+    url = 'INSERT_PLACEMENT_URL_HERE'
+    get_placement_ideas(url)
+
+  # 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/v201206/remarketing/add_audience.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 create a user list (a.k.a. Audience) and shows
+# its associated conversion tracker code snippet.
+#
+# Tags: UserListService.mutate, ConversionTrackerService.get
+
+require 'adwords_api'
+
+def add_audience()
+  # 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')
+
+  user_list_srv = adwords.service(:UserListService, API_VERSION)
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  # Prepare for adding remarketing user list.
+  name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      # 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 => 'RemarketingUserList',
+      :name => name,
+      :description => 'A list of mars cruise customers in the last year',
+      :status => 'OPEN',
+      :membership_life_span => 365,
+      :conversion_types => [{:name => name}],
+      # Optional field.
+      :status => 'OPEN'
+    }
+  }
+
+  # Add user list.
+  response = user_list_srv.mutate([operation])
+  user_list = response[:value].first
+
+  # Get conversion snippets.
+  if user_list and user_list[:conversion_types]
+    conversion_ids = user_list[:conversion_types].map {|type| type[:id]}
+    selector = {
+      # We're actually interested in the 'Snippet' field, which is returned
+      # automatically.
+      :fields => ['Id'],
+      :predicates => [
+        {:field => 'Id', :operator => 'IN', :values => conversion_ids}
+      ]
+    }
+    conv_tracker_response = conv_tracker_srv.get(selector)
+    if conv_tracker_response and conv_tracker_response[:entries]
+      conversions = conv_tracker_response[:entries]
+    end
+  end
+  puts "User list with name '%s' and ID %d was added." %
+      [user_list[:name], user_list[:id]]
+  # Display user list associated conversion code snippets.
+  if conversions
+    conversions.each do |conversion|
+      puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
+        conversion[:snippet]
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201206
+
+  begin
+    add_audience()
+
+  # 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/v201206/remarketing/add_conversion_tracker.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 add an AdWords conversion tracker.
+#
+# Tags: ConversionTrackerService.mutate
+
+require 'adwords_api'
+
+def add_conversion_tracker()
+  # 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')
+
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  # Prepare for adding conversion.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      # 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 => 'AdWordsConversionTracker',
+      :name => "Earth to Mars Cruises Conversion #%d" %
+          (Time.new.to_f * 1000).to_i,
+      :category => 'DEFAULT',
+      :markup_language => 'HTML',
+      :http_protocol => 'HTTP',
+      :text_format => 'HIDDEN',
+      # Optional fields:
+      :status => 'ENABLED',
+      :viewthrough_lookback_window => 15,
+      :viewthrough_conversion_de_dup_search => true,
+      :is_product_ads_chargeable => true,
+      :product_ads_chargeable_conversion_window => 15,
+      :conversion_page_language => 'en',
+      :background_color => '#0000FF',
+      :user_revenue_value => 'someJavascriptVariable'
+    }
+  }
+
+  # Add conversion.
+  response = conv_tracker_srv.mutate([operation])
+  conversion = response[:value].first
+  puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
+      " was added.") % [conversion[:id], conversion[:name],
+                        conversion[:status], conversion[:category]]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201206
+
+  begin
+    add_conversion_tracker()
+
+  # 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/v201206/reporting/download_criteria_report.rb

@@ -0,0 +1,79 @@
+#!/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 and downloads an Ad Hoc report from a XML report definition.
+
+require 'adwords_api'
+
+def download_criteria_report(file_name)
+  # 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')
+
+  # Get report utilities for the version.
+  report_utils = adwords.report_utils(API_VERSION)
+
+  # Define report definition. You can also pass your own XML text as a string.
+  report_definition = {
+    :selector => {
+      :fields => ['CampaignId', 'AdGroupId', 'Id', 'Criteria', 'CriteriaType',
+          'Impressions', 'Clicks', 'Cost'],
+      # Predicates are optional.
+      :predicates => {
+        :field => 'Status',
+        :operator => 'IN',
+        :values => ['ACTIVE', 'PAUSED']
+      }
+    },
+    :report_name => 'Last 7 days CRITERIA_PERFORMANCE_REPORT',
+    :report_type => 'CRITERIA_PERFORMANCE_REPORT',
+    :download_format => 'CSV',
+    :date_range_type => 'LAST_7_DAYS',
+    # Enable to get rows with zero impressions.
+    :include_zero_impressions => false
+  }
+
+  # Download report, using "download_report_as_file" utility method.
+  # To retrieve the report as return value, use "download_report" method.
+  report_utils.download_report_as_file(report_definition, file_name)
+  puts "Report was downloaded to '%s'." % file_name
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201206
+
+  begin
+    # File name to write report to.
+    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
+    download_criteria_report(file_name)
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ReportError => e
+    puts "Reporting Error: %s" % e.message
+  end
+end