google-adwords-api 0.20.0 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32f88b8471e480819e915ae7a922502f13fbbda5
-  data.tar.gz: 84b1dd8a184f46e958fb33817c3ce4a92ff9d3fd
+  metadata.gz: 136760f6dc477dd93488173dcb9a11a8808820cc
+  data.tar.gz: 27e092050cf90e18598a55347d87efc3ffe98d8f
 SHA512:
-  metadata.gz: 0dbaeae2395c6228e7b961308488b99d89eca1c5020bfa9f8e5f801a679c84c0d81b4b994f40975f525f35eb557e24a5f2b64ab8e3220a21e25a67aa9937d97b
-  data.tar.gz: f8bb807b10714263aa34877bafde8cbb938921642c44919caa58d981f6ebe337bfb9e9e224070a592c648821cb1ecb1d50ae0a13b8d260653aed5f96ab1151e1
+  metadata.gz: 133410f71db8da7aca450cabeac85e174feb8732124aeceed986c2720a3b80f4e444ed34741ffe2600b53178ab3fb1ecf9a86d9fc267b67fc7525a24873f4d93
+  data.tar.gz: 4d2056f3a4fa4b1101b42b54d9693b7a4930d9631824f7166078b17a7280f5a7daa83c16fdd13870ffddf921112bd993afd741e75d5de6e8274f00d34b284679

data/ChangeLog

@@ -1,3 +1,7 @@
+0.20.1:
+  - Support and examples for v201607.
+  - Fixed issue #91 related to BJS utilities handling special characters.
+
 0.20.0:
   - Started enforcing minumum Ruby runtime version via gemspec.
   - Removed deprecated API version v201509.
@@ -14,6 +18,9 @@
 
 0.18.3:
   - Support and examples for v201603.
+  - The include_zero_impressions field is no longer settable on a report
+    definition hash directly. Updated utilities and examples to set
+    corresponding HTTP level header instead.
 
 0.18.2:
   - Require google-ads-common 0.11.3 or later from now on.

data/examples/v201601/remarketing/add_crm_based_user_list.rb

@@ -16,8 +16,8 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example adds a remarketing user list (a.k.a. audience) and uploads
-# hashed email addresses to populate the list.
+# This example adds a user list (a.k.a. audience) and uploads hashed email
+# addresses to populate the list.
 #
 # Note: It may take several hours for the list to be populated with members.
 # Email addresses must be associated with a Google account. For privacy

data/examples/v201603/remarketing/add_crm_based_user_list.rb

@@ -16,8 +16,8 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example adds a remarketing user list (a.k.a. audience) and uploads
-# hashed email addresses to populate the list.
+# This example adds a user list (a.k.a. audience) and uploads hashed email
+# addresses to populate the list.
 #
 # Note: It may take several hours for the list to be populated with members.
 # Email addresses must be associated with a Google account. For privacy

data/examples/v201605/advanced_operations/add_click_to_download_ad.rb

@@ -91,8 +91,8 @@ def add_click_to_download_ad(ad_group_id)
   ])
   if response and response[:value]
     response[:value].each do |ad|
-      puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
-          [ad[:ad][:id], ad[:ad][:final_urls[0]]]
+      puts 'Added new click-to-download ad with ID %d and final url "%s".' %
+          [ad[:ad][:id], ad[:ad][:final_urls][0]]
     end
   else
     raise StandardError, 'No ads were added.'

data/examples/v201605/advanced_operations/add_html5_ad.rb

@@ -38,13 +38,13 @@ def add_html5_ad(ad_group_id)
   # Designer (https://www.google.com/webdesigner).
   html5_url = 'http://goo.gl/9Y7qI2'
   html5_data = AdsCommon::Http.get(html5_url, adwords.config)
-  base64_html5_data = Base64.encode64(html5_data)
+  html5_data_base64 = Base64.encode64(html5_data)
 
   # Create a media bundle containing the zip file with all the HTML5
   # components.
   media_bundle = {
     :xsi_type => 'MediaBundle',
-    :data => base64_html5_data,
+    :data => html5_data_base64,
     :entry_point => 'carousel/index.html',
     :type => 'MEDIA_BUNDLE'
   }

data/examples/v201605/remarketing/add_crm_based_user_list.rb

@@ -16,8 +16,8 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example adds a remarketing user list (a.k.a. audience) and uploads
-# hashed email addresses to populate the list.
+# This example adds a user list (a.k.a. audience) and uploads hashed email
+# addresses to populate the list.
 #
 # Note: It may take several hours for the list to be populated with members.
 # Email addresses must be associated with a Google account. For privacy

data/examples/v201607/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 = :v201607
+
+  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/v201607/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 = :v201607
+
+  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/v201607/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 = :v201607
+  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