google-adwords-api 0.5.1 → 0.5.2

data/examples/v201109/basic_operations/update_keyword.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def update_keyword()
+def update_keyword(ad_group_id, criterion_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,9 +37,6 @@ def update_keyword()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
   # Prepare for updating a keyword.
   operation = {
     :operator => 'SET',
@@ -78,8 +73,13 @@ def update_keyword()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    update_keyword()
+    # IDs of a criterion to update and its ad group.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    update_keyword(ad_group_id, criterion_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/add_experiment.rb

@@ -27,10 +27,9 @@
 # Tags: ExperimentService.mutate
 
 require 'adwords_api'
+require 'date'
 
-API_VERSION = :v201109
-
-def add_experiment()
+def add_experiment(campaign_id, ad_group_id, criterion_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -44,10 +43,6 @@ def add_experiment()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
   # Prepare for adding experiment.
   operation = {
     :operator => 'ADD',
@@ -55,7 +50,11 @@ def add_experiment()
       :campaign_id => campaign_id,
       :name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
       :query_percentage => 10,
-      :start_date_time => Time.now.strftime('%Y%m%d %H%M%S')
+      :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
+      # Optional fields:
+      :status => 'ACTIVE',
+      :end_date_time =>
+         DateTime.parse((Date.today + 30).to_s).strftime('%Y%m%d %H%M%S')
     }
   }
 
@@ -132,8 +131,14 @@ def add_experiment()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_experiment()
+    # IDs of the required objects.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    add_experiment(campaign_id, ad_group_id, criterion_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/add_keywords_in_bulk.rb

@@ -26,11 +26,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-RETRY_INTERVAL = 30
-RETRIES_COUNT = 30
-KEYWORD_NUMBER = 100
-
 def add_keywords_in_bulk()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -129,6 +124,11 @@ def add_keywords_in_bulk()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  RETRY_INTERVAL = 30
+  RETRIES_COUNT = 30
+  KEYWORD_NUMBER = 100
+
   begin
     add_keywords_in_bulk()
 

data/examples/v201109/campaign_management/add_location_extension.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def add_location_extension()
+def add_location_extension(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,8 +38,6 @@ def add_location_extension()
       adwords.service(:CampaignAdExtensionService, API_VERSION)
   geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
   selector = {
     :addresses => [
       {
@@ -78,7 +74,13 @@ def add_location_extension()
          :address => location[:address],
          :geo_point => location[:geo_point],
          :encoded_location => location[:encoded_location],
-         :source => 'ADWORDS_FRONTEND'}}}
+         :source => 'ADWORDS_FRONTEND',
+         # Optional fields:
+         #:company_name => 'ACME Inc.',
+         #:phone_number => '+1-650-253-0000'
+       }
+     }
+    }
   end
 
   # Add location ad extensions.
@@ -90,8 +92,12 @@ def add_location_extension()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_location_extension()
+    # ID of campaign to add location extension to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_location_extension(campaign_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/add_location_extension_override.rb

@@ -26,9 +26,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def add_location_extension_override()
+def add_location_extension_override(ad_id, location_extension_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,9 +38,6 @@ def add_location_extension_override()
   ad_ext_override_srv =
       adwords.service(:AdExtensionOverrideService, API_VERSION)
 
-  ad_id = 'INSERT_AD_ID_HERE'.to_i
-  location_extension_id = 'INSERT_LOCATION_EXTENSION_ID_HERE'.to_i
-
   # Create operation.
   operation = {
     :operator => 'ADD',
@@ -62,8 +57,13 @@ def add_location_extension_override()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_location_extension_override()
+    # IDs of ad and location extension override to add.
+    ad_id = 'INSERT_AD_ID_HERE'.to_i
+    location_extension_id = 'INSERT_LOCATION_EXTENSION_ID_HERE'.to_i
+    add_location_extension_override(ad_id, location_extension_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/get_all_disapproved_ads.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_all_disapproved_ads()
+def get_all_disapproved_ads(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -38,8 +36,6 @@ def get_all_disapproved_ads()
 
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Get all the disapproved ads for this campaign.
   selector = {
     :fields => ['Id', 'DisapprovalReasons'],
@@ -72,8 +68,12 @@ def get_all_disapproved_ads()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_all_disapproved_ads()
+    # ID of an ad group to get disapproved ads for.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_all_disapproved_ads(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/promote_experiment.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def promote_experiment()
+def promote_experiment(experiment_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -38,8 +36,6 @@ def promote_experiment()
 
   experiment_srv = adwords.service(:ExperimentService, API_VERSION)
 
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
-
   # Prepare for updating experiment.
   operation = {
     :operator => 'SET',
@@ -57,8 +53,11 @@ def promote_experiment()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    promote_experiment()
+    experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
+    promote_experiment(experiment_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/set_ad_parameters.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def set_ad_parameters()
+def set_ad_parameters(ad_group_id, criterion_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,9 +37,6 @@ def set_ad_parameters()
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
   ad_param_srv = adwords.service(:AdParamService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
   # Prepare for adding ad.
   ad_operation = {
     :operator => 'ADD',
@@ -64,7 +59,7 @@ def set_ad_parameters()
   # Add ad.
   response = ad_group_ad_srv.mutate([ad_operation])
   ad = response[:value].first[:ad]
-  puts 'Text ad id %d was successfully added.' % ad[:id]
+  puts "Text ad ID %d was successfully added." % ad[:id]
 
   # Prepare for setting ad parameters.
   price_operation = {
@@ -93,8 +88,13 @@ def set_ad_parameters()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    set_ad_parameters()
+    # IDs of ad group and criterion to set ad parameter for.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    set_ad_parameters(ad_group_id, criterion_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/campaign_management/validate_text_ad.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def validate_text_ad()
+def validate_text_ad(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -38,8 +36,6 @@ def validate_text_ad()
 
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Enable 'validate only' option.
   adwords.validate_only = true
 
@@ -77,18 +73,20 @@ def validate_text_ad()
     response = ad_group_ad_srv.mutate([operation])
     if response and response[:value]
       ad = response[:value].first
-      puts "Unexpected ad creation! Name '%s', ID %d and status '%s'." %
-          [campaign[:name], campaign[:id], campaign[:status]]
+      raise StandardError, ("Unexpected ad creation! Name '%s', ID %d and " +
+          "status '%s'.") % [campaign[:name], campaign[:id], campaign[:status]]
     end
   rescue AdwordsApi::Errors::ApiException => e
     puts "Validation correctly failed with an exception: %s" % e.class
-    raise e
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    validate_text_ad()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    validate_text_ad(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/error_handling/handle_captcha_challenge.rb

@@ -25,10 +25,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-MAX_RETRIES = 500
-
 def handle_captcha_challenge()
   # Initialize token variable.
   logintoken = nil
@@ -73,6 +69,9 @@ def handle_captcha_challenge()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  MAX_RETRIES = 500
+
   begin
     handle_captcha_challenge()
 

data/examples/v201109/error_handling/handle_partial_failures.rb

@@ -25,9 +25,7 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-
-def handle_partial_failures()
+def handle_partial_failures(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 handle_partial_failures()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Set partial failures flag.
   adwords.partial_failure = true
 
@@ -106,8 +102,11 @@ def handle_partial_failures()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    handle_partial_failures()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    handle_partial_failures(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/error_handling/handle_policy_violation_error.rb

@@ -26,9 +26,7 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-
-def handle_policy_violation_error()
+def handle_policy_violation_error(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 handle_policy_violation_error()
 
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Create text ad.
   text_ad_operation = {
     :operator => 'ADD',
@@ -117,8 +113,11 @@ def handle_policy_violation_error()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    handle_policy_violation_error()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    handle_policy_violation_error(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/error_handling/handle_two_factor_authorization_error.rb

@@ -22,8 +22,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
 def handle_two_factor_authorization_error()
   # Set up credentials with an account that has 2Factor enabled.
   config = {
@@ -66,6 +64,8 @@ def handle_two_factor_authorization_error()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     handle_two_factor_authorization_error()