google-adwords-api 0.1.0

data/examples/v201101/download_mcc_report.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/ruby
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2010, 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 a report from a report definition. To get a
+# report definition, run add_keywords_performance_report_definition.rb.
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+
+def download_mcc_report()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+
+  report_definition_id = 'INSERT_REPORT_ID_HERE'.to_i
+
+  # Initially run with qt = 'new'
+  qt = 'new'
+  retries_count = 0
+
+  begin
+    # Acquire report or report status with "download_mcc_report" extension
+    # method.
+    report_data = report_def_srv.download_mcc_report(report_definition_id, qt)
+    # Saving query id for following queries.
+    qt = report_data[:body]['qt']
+    # Checking the response code.
+    case report_data[:code]
+      when 200
+        puts "Acquired report of size: %d" % report_data[:body].size
+        break
+      when 206
+        puts "Received a status update: %s" % report_data[:body]['stateName']
+        puts "Waiting for %d seconds to retry..." % RETRY_INTERVAL
+      when 500
+        puts "Received a failure: %s" % report_data[:body]['stateName']
+        break
+    end
+    sleep(RETRY_INTERVAL)
+    retries_count += 1
+  end while retries_count < MAX_RETRIES
+end
+
+if __FILE__ == $0
+  begin
+    download_mcc_report()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201101/download_report.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby
+#
+# 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 gets and downloads a report from a report definition. To get a
+# report definition, run add_keywords_performance_report_definition.rb.
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def download_report()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+
+  report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
+  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
+
+  # Download report, using "download_report_as_file" extension method.
+  report_def_srv.download_report_as_file(report_definition_id, file_name)
+  puts 'Report with definition id %d was downloaded to \'%s\'.' %
+      [report_definition_id, file_name]
+end
+
+if __FILE__ == $0
+  begin
+    download_report()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201101/get_account_hierarchy.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/ruby
+#
+# 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 retrieve the account hierarchy under an
+# account.
+#
+# Tags: ServicedAccountService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def get_account_hierarchy()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
+
+  # Get the account hierarchy for this account.
+  selector = {
+    :service_types => ['UI_AND_API', 'API_ONLY'],
+    :enable_paging => false
+  }
+
+  graph = nil
+
+  # Run with MCC account.
+  adwords.use_mcc do
+    graph = serviced_account_srv.get(selector)
+  end
+
+  if graph
+    # Display the accounts.
+    account_number = graph[:accounts] ? graph[:accounts].size : 0
+    puts "There are %d customers under this account hierarchy." %
+        account_number
+    if graph[:accounts]
+      graph[:accounts].each_with_index do |account, index|
+        puts "#{index + 1}) Customer id: " +
+            AdwordsApi::Utils.format_id(account[:customer_id])
+        puts "Login email: #{account[:login]}"
+        puts "Company Name: #{account[:company_name]}"
+        puts "IsMcc: #{account[:can_manage_clients]}"
+        puts ''
+      end
+
+      puts ''
+
+      # Display the links.
+      graph[:links].each do |link|
+        puts "There is a #{link[:type_of_link]} link of type " +
+            "#{link[:service_type]} from " +
+            "#{AdwordsApi::Utils.format_id(link[:manager_id][:id])} to " +
+            "#{AdwordsApi::Utils.format_id(link[:client_id][:id])}"
+      end
+    end
+  else
+    puts "No accounts were found."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_account_hierarchy()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201101/get_ad_group_bid_landscape.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby
+#
+# 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 gets bid landscapes for an ad group. To get ad groups,
+# run get_all_ad_groups.rb.
+#
+# Tags: DataService.getAdGroupBidLandscape
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def get_ad_group_bid_landscapes()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  data_srv = adwords.service(:DataService, API_VERSION)
+
+  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
+  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+
+  # Get bid landscape for ad group.
+  selector = {
+    :fields => ["AdGroupId", "LandscapeType", "LandscapeCurrent", "StartDate",
+                "EndDate", "Bid", "LocalClicks", "LocalCost", "MarginalCpc",
+                "LocalImpressions"],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]}
+    ]
+  }
+  page = data_srv.get_criterion_bid_landscape(selector)
+  if page and page[:entries]
+    puts "#{page[:entries].length} bid landscape(s) retrieved."
+    page[:entries].each do |bid_landscape|
+      puts "Found ad group bid landscape with ad group id " +
+          "'#{bid_landscape[:ad_group_id]}', type " +
+          "'#{bid_landscape[:type]}', current " +
+          "'#{bid_landscape[:landscape_current]}', start date " +
+          "'#{bid_landscape[:start_date]}', end date "+
+          "'#{bid_landscape[:end_date]}', with landscape points:"
+      bid_landscape[:landscape_points].each do |point|
+        puts "  #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
+            "cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
+            "#{point[:marginal_cpc][:micro_amount]}, impressions: " +
+            "#{point[:impressions]}"
+      end
+    end
+  else
+    puts "No ad group bid landscapes retrieved."
+  end
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_ad_group_bid_landscapes()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201101/get_all_account_changes.rb

@@ -0,0 +1,146 @@
+#!/usr/bin/ruby
+#
+# 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 gets all account changes between the two dates specified, for
+# all campaigns.
+#
+# Tags: CustomerSyncService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+require 'pp'
+
+API_VERSION = :v201101
+
+def get_all_account_changes()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+  customer_sync_srv = adwords.service(:CustomerSyncService, API_VERSION)
+
+  today_at_midnight = DateTime.parse(Date.today.to_s)
+  yesterday_at_midnight = DateTime.parse((Date.today - 1).to_s)
+  min_date_time = yesterday_at_midnight.strftime("%Y%m%d %H%M%S")
+  max_date_time = today_at_midnight.strftime("%Y%m%d %H%M%S")
+
+  # Get all the campaigns for this account.
+  selector = {
+    :fields => ['Id']
+  }
+  response = campaign_srv.get(selector)
+
+  campaign_ids = []
+
+  if response and response[:entries]
+    campaigns = response[:entries]
+    campaign_ids = campaigns.map { |campaign| campaign[:id] }
+  else
+    puts "No campaigns were found."
+    return
+  end
+
+  # Create selector for CustomerSyncService.
+  selector = {
+    :campaign_ids => campaign_ids,
+    :date_time_range => {
+      :min => min_date_time,
+      :max => max_date_time
+    }
+  }
+
+  # Get all account changes for campaigns.
+  campaign_changes = customer_sync_srv.get(selector)
+
+  # Display changes.
+  if campaign_changes
+    puts "Most recent change: #{campaign_changes[:last_change_timestamp]}"
+    campaign_changes[:changed_campaigns].each do |campaign|
+      puts "Campaign with id #{campaign[:campaign_id]} was changed:"
+      puts "  Campaign changed status: #{campaign[:campaign_change_status]}"
+      if campaign[:campaign_change_status] != 'NEW'
+        puts "  Added ad extensions: %s" %
+            campaign[:added_ad_extensions].pretty_inspect
+        puts "  Added campaign criteria: %s" %
+            campaign[:added_campaign_criteria].pretty_inspect
+        puts "  Added campaign targeting: %s" %
+            campaign[:campaign_targeting_changed].pretty_inspect
+        puts "  Deleted ad extensions: %s" %
+            campaign[:deleted_ad_extensions].pretty_inspect
+        puts "  Deleted campaign criteria: %s" %
+            campaign[:deleted_campaign_criteria].pretty_inspect
+
+        if campaign[:changed_ad_groups]
+          campaign[:changed_ad_groups].each do |ad_group|
+            puts "  Ad group with id #{ad_group[:ad_group_id]} was changed:"
+            puts "    Ad group changed status: " +
+                "#{ad_group[:ad_group_change_status]}"
+            if ad_group[:ad_group_change_status] != 'NEW'
+              puts "    Ads changed: %s" % ad_group[:changed_ads].pretty_inspect
+              puts "    Criteria changed: %s" %
+                  ad_group[:changed_criteria].pretty_inspect
+              puts "    Criteria deleted: %s" %
+                  ad_group[:deleted_criteria].pretty_inspect
+            end
+          end
+        end
+      end
+      puts ''
+    end
+  else
+    puts "No account changes were found."
+  end
+
+
+end
+
+if __FILE__ == $0
+  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
+  # variable to 'true'. This can be done either from your operating system
+  # environment or via code, as done below.
+  ENV['ADWORDSAPI_DEBUG'] = 'false'
+
+  begin
+    get_all_account_changes()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end