google-adwords-api 0.5.1 → 0.5.2

data/ChangeLog

@@ -1,3 +1,7 @@
+0.5.2:
+  - Rework on examples.
+  - Tests for all examples.
+
 0.5.1:
   - Require google-ads-common 0.6.3 or later from now on.
   - Support for CAPTCHA challenge handling.

data/README

@@ -178,7 +178,8 @@ respond in gzipped format. All requests are sent uncompressed regardless.
 to regenerate the stubs if needed
 
  $ gem build google-adwords-api.gemspec
-to build the gem
+ $ gem build google-adx-buyer-api.gemspec
+to build the gems
 
  $ rake test
 to run unit tests on the library

data/examples/v201109/account_management/create_account.rb

@@ -26,8 +26,6 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-
 def create_account()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -59,6 +57,8 @@ def create_account()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     create_account()
 

data/examples/v201109/account_management/get_account_alerts.rb

@@ -26,9 +26,6 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-PAGE_SIZE = 500
-
 def get_account_alerts()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -90,6 +87,9 @@ def get_account_alerts()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 500
+
   begin
     get_account_alerts()
 

data/examples/v201109/account_management/get_account_changes.rb

@@ -27,8 +27,6 @@ require 'adwords_api'
 require 'date'
 require 'pp'
 
-API_VERSION = :v201109
-
 def get_account_changes()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -116,6 +114,8 @@ def get_account_changes()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     get_account_changes()
 

data/examples/v201109/account_management/get_account_hierarchy.rb

@@ -26,8 +26,6 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-
 def get_account_hierarchy()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -72,6 +70,8 @@ def get_account_hierarchy()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     get_account_hierarchy()
 

data/examples/v201109/account_management/get_client_customer_id.rb

@@ -27,9 +27,7 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-
-def get_client_customer_id()
+def get_client_customer_id(client_email)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,11 +38,7 @@ def get_client_customer_id()
 
   info_srv = adwords.service(:InfoService, API_VERSION)
 
-  # Email address to find ID for.
-  client_email = 'INSERT_EMAIL_ADDRESS_HERE'
-
   today = Time.new.strftime('%Y%m%d')
-
   selector = {
     :client_emails => [client_email],
     :api_usage_type => 'UNIT_COUNT_FOR_CLIENTS',
@@ -66,8 +60,12 @@ def get_client_customer_id()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_client_customer_id()
+    # Email address to find ID for.
+    client_email = 'INSERT_EMAIL_ADDRESS_HERE'
+    get_client_customer_id(client_email)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/account_management/get_client_unit_usage.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_client_unit_usage()
+def get_client_unit_usage(client_customer_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -38,9 +36,6 @@ def get_client_unit_usage()
 
   info_srv = adwords.service(:InfoService, API_VERSION)
 
-  # Specify client customer ID for the account to get usage for.
-  client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'.to_i
-
   start_date = Time.now.strftime('%Y%m01')
   end_date = Time.now.strftime('%Y%m%d')
 
@@ -67,8 +62,12 @@ def get_client_unit_usage()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_client_unit_usage()
+    # Specify client customer ID for the account to get usage for.
+    client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'.to_i
+    get_client_unit_usage(client_customer_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/basic_operations/add_ad_groups.rb

@@ -0,0 +1,111 @@
+#!/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 create ad groups. To get a list of existing
+# campaigns run get_campaigns.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'adwords_api'
+
+def add_ad_groups(campaign_id)
+  # 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')
+
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+
+  ad_groups = [
+    {:name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
+     :status => 'ENABLED',
+     :campaign_id => campaign_id,
+     :bids => {
+       # 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 => 'ManualCPCAdGroupBids',
+       :keyword_max_cpc => {
+         :amount => {
+           :micro_amount => 10000000
+         }
+       },
+       # Optional field.
+       :keyword_content_max_cpc => {:amount => {:micro_amount => 2000000}}
+     }},
+    {:name => "Earth to Pluto Cruises #%d" % (Time.new.to_f * 1000).to_i,
+     :status => 'ENABLED',
+     :campaign_id => campaign_id,
+     :bids => {
+       # 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 => 'ManualCPCAdGroupBids',
+       :keyword_max_cpc => {
+         :amount => {
+           :micro_amount => 10000000
+         }
+       }
+     }}
+  ]
+
+  # Prepare operations for adding ad groups.
+  operations = ad_groups.map do |ad_group|
+    {:operator => 'ADD', :operand => ad_group}
+  end
+
+  # Add ad groups.
+  response = ad_group_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |ad_group|
+      puts "Ad group ID %d was successfully added." % ad_group[:id]
+    end
+  else
+    raise StandardError, 'No ad group was added'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+
+  begin
+    # Campaign ID to add ad group to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_ad_groups(campaign_id)
+
+  # 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/v201109/basic_operations/add_campaigns.rb

@@ -0,0 +1,125 @@
+#!/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 create campaigns.
+#
+# Tags: CampaignService.mutate
+
+require 'adwords_api'
+require 'date'
+
+def add_campaigns()
+  # 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)
+
+  campaigns = [
+    {:name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
+     :status => 'PAUSED',
+     :bidding_strategy => {
+       # 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 => 'ManualCPC'
+     },
+     :budget => {
+       :period => 'DAILY',
+       :amount => {:micro_amount => 50000000},
+       :delivery_method => 'STANDARD'
+     },
+     # Set the campaign network options to Search and Search Network.
+     :network_setting => {
+       :target_google_search => true,
+       :target_search_network => true,
+       :target_content_network => false,
+       :target_content_contextual => false
+     },
+     # Optional fields:
+     :start_date =>
+         DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
+     :ad_serving_optimization_status => 'ROTATE',
+     :frequency_cap => {
+       :impressions => '5',
+       :time_unit => 'DAY',
+       :level => 'ADGROUP'
+     }},
+    {:name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
+     :status => 'PAUSED',
+     :bidding_strategy => {
+       :xsi_type => 'ManualCPM'
+     },
+     :budget => {
+       :period => 'DAILY',
+       :amount => {:micro_amount => 150000000},
+       :delivery_method => 'STANDARD'
+     },
+     :network_setting => {
+       :target_google_search => false,
+       :target_search_network => false,
+       :target_content_network => true,
+       :target_content_contextual => false
+     }}
+  ]
+
+  # Prepare for adding campaign.
+  operations = campaigns.map do |campaign|
+    {:operator => 'ADD', :operand => campaign}
+  end
+
+  # Add campaign.
+  response = campaign_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |campaign|
+      puts "Campaign with name '%s' and ID %d was added." %
+          [campaign[:name], campaign[:id]]
+    end
+  else
+    raise new StandardError, 'No campaigns were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+
+  begin
+    add_campaigns()
+
+  # 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/v201109/basic_operations/add_keywords.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def add_keywords()
+def add_keywords(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +37,6 @@ def add_keywords()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Create keywords.
   # 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
@@ -51,7 +47,12 @@ def add_keywords()
      :criterion => {
        :xsi_type => 'Keyword',
        :text => 'mars cruise',
-       :match_type => 'BROAD'}},
+       :match_type => 'BROAD'
+     },
+     # Optional fields:
+     :user_status => 'PAUSED',
+     :destination_url => 'http://example.com/mars'
+    },
     {:xsi_type => 'BiddableAdGroupCriterion',
      :ad_group_id => ad_group_id,
      :criterion => {
@@ -65,25 +66,29 @@ def add_keywords()
     {:operator => 'ADD', :operand => keyword}
   end
 
-  # Add criteria.
+  # Add keywords.
   response = ad_group_criterion_srv.mutate(operations)
   if response and response[:value]
     ad_group_criteria = response[:value]
-    puts "Added %d criteria to ad group ID %d:" %
+    puts "Added %d keywords to ad group ID %d:" %
         [ad_group_criteria.length, ad_group_id]
     ad_group_criteria.each do |ad_group_criterion|
-      puts "\tCriterion ID is %d and type is '%s'" %
+      puts "\tKeyword ID is %d and type is '%s'" %
           [ad_group_criterion[:criterion][:id],
            ad_group_criterion[:criterion][:type]]
     end
   else
-    puts 'No criteria were added.'
+    raise StandardError, 'No keywords were added.'
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_keywords()
+    # Ad group ID to add keywords to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_keywords(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e