google-adwords-api 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916926a4584ed9782e9efb72932b0c39b90473cc
-  data.tar.gz: 48a8aa5a00664fb2116662b84df12d07a9845e10
+  metadata.gz: 0b3619b9d24f1262a816603d456c34a24e17716c
+  data.tar.gz: 6858e302ec4dc3bb31185f668838c65521aac21d
 SHA512:
-  metadata.gz: 5b87032f752d27c955deedeee692a1db207e4d8d96050be8d3c1cb2b70a1dfb12eaa0b0e77324a18fb8ee4f503003af3e48d33637cc41293b7bc7572eb811ca3
-  data.tar.gz: 1847b728836bbad92cac627a709f3e8a4b7e574009143507d6b48f99179b66f5593ce68c2d6e695730702faa2abb4ae7a3c9aed3b9ad0d30cbc6489f6d79fceb
+  metadata.gz: 5221c7253f3ccd0b8fd8abd6b86c84b0d38f7f1d04ce92ea2c2cbf904142825f5ca23b04643c2d607a958a07f0f34a29441ff4f3972314a4c34d08a509ec7251
+  data.tar.gz: 8104643988f0a04e5cbc7ec230da9e24f10db81d01a9fc03f957bb767a70099b613725ec5cd50cd745add20ccfeea28f005174c481113fbf5ebfb0e54d13d3a1

data/ChangeLog

@@ -1,7 +1,15 @@
+0.18.1:
+  - Support and examples for v201601.
+  - Updated batch_job_utils to handle API changes in v201601.
+  - Require google-ads-common 0.11.2 or later from now on.
+
 0.18.0:
   - Removed deprecated API version v201502.
   - Support for streaming report requests in report_utils.
   - Require google-ads-common 0.11.1 or later from now on.
+  - Updated batch_job_utils to support incremental uploads.
+  - Changed interface of batch_job_utils to avoid requiring users to manually
+    manage SOAP XML.
 
 0.17.0:
   - Support and examples for v201509.

data/examples/v201509/basic_operations/add_ad_groups.rb

@@ -49,8 +49,10 @@ def add_ad_groups(campaign_id)
         ]
       },
       :settings => [
-        # Targeting restriction settings - these settings only affect serving
-        # for the Display Network.
+        # Targeting restriction settings. Depending on the :criterion_type_group
+        # value, most TargetingSettingDetail only affect Display campaigns.
+        # However, the USER_INTEREST_AND_LIST value works for RLSA campaigns -
+        # Search campaigns targeting using a remarketing list.
         {
           :xsi_type => 'TargetingSetting',
           :details => [

data/examples/v201509/remarketing/add_crm_based_user_list.rb

@@ -45,10 +45,8 @@ def add_crm_based_user_list(emails)
     :description => 'A list of customers that originated from email addresses',
     # Maximum life span is 180 days.
     :membership_life_span => 180,
-    # This field is required. It links to a service you created that allows
-    # members of this list to remove themselves. It will be shown in the
-    # "Why This Ad?" of an ad and so it needs to be verified. Read more about
-    # "Why This Ad?" here https://support.google.com/ads/answer/2662850.
+    # This field is optional. It links to a service you created that allows
+    # members of this list to remove themselves.
     :opt_out_link => 'http://endpoint1.example.com/optout'
   }
 

data/examples/v201509/{advanced_operations → remarketing}/upload_offline_conversions.rb

@@ -18,7 +18,8 @@
 #
 # This code example imports offline conversion values for specific clicks to
 # your account. To get Google Click ID for a click, run
-# CLICK_PERFORMANCE_REPORT.
+# CLICK_PERFORMANCE_REPORT. To set up a conversion tracker, run the
+# add_conversion_tracker.rb example.
 
 require 'adwords_api'
 require 'date'
@@ -33,28 +34,12 @@ def upload_offline_conversions(conversion_name, google_click_id,
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  conversion_tracker_srv =
-      adwords.service(:ConversionTrackerService, API_VERSION)
   conversion_feed_srv =
       adwords.service(:OfflineConversionFeedService, API_VERSION)
 
-  # Create an upload conversion. Once created, this entry will be visible under
-  # Tools and Analysis->Conversion and will have Source = Import.
-  upload_conversion = {
-    :xsi_type => 'UploadConversion',
-    :category => 'PAGE_VIEW',
-    :name => conversion_name,
-    :viewthrough_lookback_window => 30,
-    :ctc_lookback_window => 90
-  }
-  return_conversions = conversion_tracker_srv.mutate([
-    {:operator => 'ADD', :operand => upload_conversion}])
-  return_conversions[:value].each do |tracker|
-    puts "Upload conversion tracker with name '%s' and ID %d was created." %
-      [tracker[:name], tracker[:id]]
-  end
-
-  # Associate offline conversions with the upload conversion tracker we created.
+  # Associate offline conversions with the existing named conversion tracker. If
+  # this tracker was newly created, it may be a few hours before it can accept
+  # conversions.
   feed = {
     :conversion_name => conversion_name,
     :google_click_id => google_click_id,
@@ -75,7 +60,7 @@ if __FILE__ == $0
   API_VERSION = :v201509
 
   begin
-    # Name of the upload conversion to be created.
+    # Name of the conversion tracker to upload to.
     conversion_name = 'INSERT_CONVERSION_NAME_HERE'
     # Google Click ID of the click for which offline conversions are uploaded.
     google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'

data/examples/v201601/account_management/create_account.rb

@@ -0,0 +1,88 @@
+#!/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 illustrates how to create an account. Note by default this
+# account will only be accessible via parent AdWords manager account.
+
+require 'adwords_api'
+require 'adwords_api/utils'
+
+def create_account()
+  # 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')
+
+  managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
+
+  # Create a local Customer object.
+  customer = {
+    :name => 'Account created with ManagedCustomerService',
+    :currency_code => 'EUR',
+    :date_time_zone => 'Europe/London'
+  }
+
+  # Prepare operation to create an account.
+  operation = {
+      :operator => 'ADD',
+      :operand => customer
+  }
+
+  # Create the account. It is possible to create multiple accounts with one
+  # request by sending an array of operations.
+  response = managed_customer_srv.mutate([operation])
+
+  response[:value].each do |new_account|
+    puts "Account with customer ID '%s' was successfully created." %
+        AdwordsApi::Utils.format_id(new_account[:customer_id])
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+
+  begin
+    create_account()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/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

data/examples/v201601/account_management/get_account_changes.rb

@@ -0,0 +1,139 @@
+#!/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 account changes that happened within the last 24 hours,
+# for all your campaigns.
+
+require 'adwords_api'
+require 'date'
+require 'pp'
+
+def get_account_changes()
+  # 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)
+  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]
+    campaign_ids = response[:entries].map { |campaign| campaign[:id] }
+  else
+    raise StandardError, 'No campaigns were found.'
+  end
+
+  # Create a selector for CustomerSyncService.
+  selector = {
+    :campaign_ids => campaign_ids,
+    :date_time_range => {
+      :min => min_date_time,
+      :max => max_date_time
+    }
+  }
+
+  # Get all account changes for the campaigns.
+  campaign_changes = customer_sync_srv.get(selector)
+
+  # Display changes.
+  if campaign_changes
+    puts "Most recent change: %s" % campaign_changes[:last_change_timestamp]
+    campaign_changes[:changed_campaigns].each do |campaign|
+      puts "Campaign with ID %d was changed:" % campaign[:campaign_id]
+      puts "\tCampaign change status: '%s'" % campaign[:campaign_change_status]
+      unless ['NEW', 'FIELDS_UNCHANGED'].include?(
+          campaign[:campaign_change_status])
+        puts "\tAdded ad extensions: '%s'" %
+            campaign[:added_ad_extensions].pretty_inspect.chomp
+        puts "\tAdded campaign criteria: '%s'" %
+            campaign[:added_campaign_criteria].pretty_inspect.chomp
+        puts "\tRemoved ad extensions: '%s'" %
+            campaign[:removed_ad_extensions].pretty_inspect.chomp
+        puts "\tRemoved campaign criteria: '%s'" %
+            campaign[:removed_campaign_criteria].pretty_inspect.chomp
+
+        if campaign[:changed_ad_groups]
+          campaign[:changed_ad_groups].each do |ad_group|
+            puts "\tAd group with ID %d was changed:" % ad_group[:ad_group_id]
+            puts "\t\tAd group changed status: '%s'" %
+                ad_group[:ad_group_change_status]
+            unless ['NEW', 'FIELDS_UNCHANGED'].include?(
+                ad_group[:ad_group_change_status])
+              puts "\t\tAds changed: '%s'" %
+                  ad_group[:changed_ads].pretty_inspect.chomp
+              puts "\t\tCriteria changed: '%s'" %
+                  ad_group[:changed_criteria].pretty_inspect.chomp
+              puts "\t\tCriteria removed: '%s'" %
+                  ad_group[:removed_criteria].pretty_inspect.chomp
+            end
+          end
+        end
+      end
+      puts
+    end
+  else
+    puts 'No account changes were found.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+
+  begin
+    get_account_changes()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/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

data/examples/v201601/account_management/get_account_hierarchy.rb

@@ -0,0 +1,132 @@
+#!/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 illustrates how to retrieve the account hierarchy under an
+# account. This example needs to be run against an AdWords manager account.
+
+require 'adwords_api'
+require 'adwords_api/utils'
+
+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
+
+  # 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')
+
+  managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
+
+  # Get the account hierarchy for this account.
+  selector = {
+    :fields => ['CustomerId',  'Name'],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values
+  offset, page = 0, {}
+
+  accounts = {}
+  child_links = {}
+  parent_links = {}
+  root_account = nil
+
+  begin
+    page = managed_customer_srv.get(selector)
+
+    if page and page[:entries]
+      if page[:links]
+        page[:links].each do |link|
+          unless child_links.include?(link[:manager_customer_id])
+            child_links[link[:manager_customer_id]] = []
+          end
+          child_links[link[:manager_customer_id]] << link
+          unless parent_links.include?(link[:client_customer_id])
+            parent_links[link[:client_customer_id]] = []
+          end
+          parent_links[link[:client_customer_id]] << link
+        end
+      end
+
+      page[:entries].each do |account|
+        accounts[account[:customer_id]] = account
+        unless parent_links.include?(account[:customer_id])
+          root_account = account
+        end
+      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 root_account.nil?
+    puts "Unable to determine a root account."
+  else
+    puts "CustomerId, Name"
+    display_account_tree(root_account, accounts, child_links, 0)
+  end
+end
+
+def display_account_tree(account, accounts, links, depth)
+  prefix = '-' * depth * 2
+  puts '%s%s, %s' % [prefix, account[:customer_id], account[:name]]
+  if links.include?(account[:customer_id])
+    links[account[:customer_id]].each do |child_link|
+      child_account = accounts[child_link[:client_customer_id]]
+      display_account_tree(child_account, accounts, links, depth + 1)
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+  PAGE_SIZE = 500
+
+  begin
+    get_account_hierarchy()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/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