google-adwords-api 0.18.1 → 0.18.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b3619b9d24f1262a816603d456c34a24e17716c
-  data.tar.gz: 6858e302ec4dc3bb31185f668838c65521aac21d
+  metadata.gz: 7770c867249d1ad815e6793b03b574f7f3319a93
+  data.tar.gz: 79f859742263d8b9cdbe931057eaadaff638bde3
 SHA512:
-  metadata.gz: 5221c7253f3ccd0b8fd8abd6b86c84b0d38f7f1d04ce92ea2c2cbf904142825f5ca23b04643c2d607a958a07f0f34a29441ff4f3972314a4c34d08a509ec7251
-  data.tar.gz: 8104643988f0a04e5cbc7ec230da9e24f10db81d01a9fc03f957bb767a70099b613725ec5cd50cd745add20ccfeea28f005174c481113fbf5ebfb0e54d13d3a1
+  metadata.gz: 54d069af788276c67b229c3d08fb99468ca2f8f9b5be543b6925e1ebba74f47d4ddd526f4de3ffe4564530ff2c5e64aba35d2b3b4380522d6d21aafa45257002
+  data.tar.gz: 6263e6fa041ee1d61d535d52ebabddb3c03683854d4301a28648a992334f245daeecd2df27a79509b428a94a109fac82ed30e9a022a2b8ca41b240fb470670fb

data/ChangeLog

@@ -1,3 +1,10 @@
+0.18.3:
+  - Support and examples for v201603.
+
+0.18.2:
+  - Require google-ads-common 0.11.3 or later from now on.
+  - Added support for custom user agent strings to include utility usage.
+
 0.18.1:
   - Support and examples for v201601.
   - Updated batch_job_utils to handle API changes in v201601.

data/README.md

@@ -1,7 +1,7 @@
-# Google AdWords and DoubleClick Ad Exchange Buyer Client Library
+# Google AdWords Client Library
 
 Welcome to the next generation Google-developed Ruby client library for the
-AdWords and DoubleClick Ad Exchange Buyer API!
+AdWords API!
 
 It contains full support for all API services with full stubs, and a simplified
 programming interface that lets you handle everything in native Ruby
@@ -12,17 +12,12 @@ collections.
 
 ## 1 - Installation
 
-`google-adwords-api` and `google-adx-buyer-api` are ruby gems. See
-[http://docs.rubygems.org/read/book/1]().
+`google-adwords-api` is a ruby gem. See
+[http://guides.rubygems.org/rubygems-basics/]().
 
-Install them using the gem install command:
+Install it using the gem install command:
 
     $ gem install --remote google-adwords-api
-    $ gem install --remote google-adx-buyer-api
-
-Please note the `google-adx-buyer-api` gem contains only DoubleClick Ad
-Exchange Buyer client library examples. The gem also depends on the
-AdWords library, which will be installed automatically.
 
 The following gem libraries are required:
 
@@ -92,21 +87,6 @@ For example:
       :proxy => 'http://user:password@proxy_hostname:8080'
     }
 
-*Note*: If you are using Ruby 1.8 you may need to include RubyGems to be able
-to require other gems code. There are several ways to do it, the easiest one is
-to pass '-rubygems' parameter to the ruby interpreter:
-
-    $ ruby -rubygems my_program_that_uses_gems
-
-you can also set this up in the environment:
-
-    $ export RUBYOPT="rubygems"
-
-or add it to the bash configuration file:
-
-    $ echo 'export RUBYOPT="rubygems"' >> ~/.bashrc
-
-
 ### 2.1 - Ruby names for a Ruby library
 
 In order to make things more Ruby-like for our Ruby developers, we've renamed
@@ -211,7 +191,7 @@ To target a specific version:
 
 For example:
 
-    $ rake generate[v201509]
+    $ rake generate[v201601]
 
 To target a specific service in a specific version:
 
@@ -219,12 +199,11 @@ To target a specific service in a specific version:
 
 For example:
 
-    $ rake generate[v201509,CampaignService]
+    $ rake generate[v201601,CampaignService]
 
 To build the gems:
 
     $ gem build google-adwords-api.gemspec
-    $ gem build google-adx-buyer-api.gemspec
 
 To run unit tests on the library:
 
@@ -247,7 +226,7 @@ announcements and other news.
 
 ## Licence
 
-Copyright 2010-2015, Google Inc. All Rights Reserved.
+Copyright 2010-2016, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/adwords_api.yml

@@ -51,3 +51,5 @@
   #:skip_report_header: true
   #:skip_report_summary: true
   #:skip_column_header: true
+  # Optional: uncomment to disable user agent showing used utilities.
+  #:include_utilities_in_user_agent: false

data/examples/v201506/reporting/parallel_report_download.rb

@@ -70,9 +70,7 @@ def parallel_report_download()
       :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
       :report_type => 'ADGROUP_PERFORMANCE_REPORT',
       :download_format => 'CSV',
-      :date_range_type => 'LAST_7_DAYS',
-      # Enable to get rows with zero impressions.
-      :include_zero_impressions => false
+      :date_range_type => 'LAST_7_DAYS'
   }
 
   puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]

data/examples/v201509/reporting/parallel_report_download.rb

@@ -70,9 +70,7 @@ def parallel_report_download()
       :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
       :report_type => 'ADGROUP_PERFORMANCE_REPORT',
       :download_format => 'CSV',
-      :date_range_type => 'LAST_7_DAYS',
-      # Enable to get rows with zero impressions.
-      :include_zero_impressions => false
+      :date_range_type => 'LAST_7_DAYS'
   }
 
   puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]

data/examples/v201601/reporting/parallel_report_download.rb

@@ -70,9 +70,7 @@ def parallel_report_download()
       :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
       :report_type => 'ADGROUP_PERFORMANCE_REPORT',
       :download_format => 'CSV',
-      :date_range_type => 'LAST_7_DAYS',
-      # Enable to get rows with zero impressions.
-      :include_zero_impressions => false
+      :date_range_type => 'LAST_7_DAYS'
   }
 
   puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]

data/examples/v201603/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 = :v201603
+
+  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/v201603/account_management/get_account_changes.rb

@@ -0,0 +1,135 @@
+#!/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 campaign criteria: '%s'" %
+            campaign[:added_campaign_criteria].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 = :v201603
+
+  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/v201603/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 = :v201603
+  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