google-adwords-api 0.5.1 → 0.5.2

data/examples/v201109/reporting/get_report_fields.rb

@@ -24,9 +24,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_report_fields()
+def get_report_fields(report_type)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -37,12 +35,10 @@ def get_report_fields()
 
   report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
 
-  report_type = 'INSERT_REPORT_TYPE_HERE'
-
   # Get report fields.
   fields = report_def_srv.get_report_fields(report_type)
   if fields
-    puts 'Report type \'%s\' contains the following fields:' % report_type
+    puts "Report type '%s' contains the following fields:" % report_type
     fields.each do |field|
       puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
       puts '  := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
@@ -51,8 +47,11 @@ def get_report_fields()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_report_fields()
+    report_type = 'INSERT_REPORT_TYPE_HERE'
+    get_report_fields(report_type)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/reporting/parallel_report_download.rb

@@ -25,14 +25,6 @@ require 'thread'
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-# Number of parallel threads to spawn.
-THREADS = 10
-# Maximum number of retries for 500 errors.
-MAX_RETRIES = 5
-# Timeout between retries in seconds.
-BACKOFF_FACTOR = 5
-
 def parallel_report_download()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -145,6 +137,14 @@ def parallel_report_download()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  # Number of parallel threads to spawn.
+  THREADS = 10
+  # Maximum number of retries for 500 errors.
+  MAX_RETRIES = 5
+  # Timeout between retries in seconds.
+  BACKOFF_FACTOR = 5
+
   begin
     parallel_report_download()
 

data/examples/v201109/targeting/add_campaign_targeting_criteria.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def add_campaign_targeting_criteria()
+def add_campaign_targeting_criteria(campaign_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_campaign_targeting_criteria()
   campaign_criterion_srv =
       adwords.service(:CampaignCriterionService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
-
   # Create campaign criteria.
   campaign_criteria = [
     # Location criteria. The IDs can be found in the documentation or retrieved
@@ -98,8 +94,11 @@ def add_campaign_targeting_criteria()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_campaign_targeting_criteria()
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
+    add_campaign_targeting_criteria(campaign_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/targeting/get_campaign_targeting_criteria.rb

@@ -25,10 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-PAGE_SIZE = 500
-
-def get_campaign_targeting_criteria()
+def get_campaign_targeting_criteria(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,9 +37,6 @@ def get_campaign_targeting_criteria()
   campaign_criterion_srv =
       adwords.service(:CampaignCriterionService, API_VERSION)
 
-  # Specify campaign ID to get targeting for.
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
   # Selector to get all the targeting for this campaign.
   selector = {
     :fields => ['Id', 'CriteriaType', 'KeywordText'],
@@ -82,8 +76,13 @@ def get_campaign_targeting_criteria()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 500
+
   begin
-    get_campaign_targeting_criteria()
+    # Specify campaign ID to get targeting for.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    get_campaign_targeting_criteria(campaign_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/targeting/get_targetable_languages_and_carriers.rb

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

data/examples/v201109/targeting/lookup_location.rb

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

data/lib/adwords_api/version.rb

@@ -21,6 +21,6 @@
 
 module AdwordsApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.5.1'
+    CLIENT_LIB_VERSION = '0.5.2'
   end
 end

data/test/examples/v201109/test_account_management.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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.
+#
+# Tests the account managements examples.
+
+require 'test/unit'
+
+require 'account_management/create_account'
+require 'account_management/get_account_alerts'
+require 'account_management/get_account_changes'
+require 'account_management/get_account_hierarchy'
+require 'account_management/get_client_customer_id'
+require 'account_management/get_client_unit_usage'
+
+class TestAccountManagementV201109 < Test::Unit::TestCase
+  def setup
+  end
+
+  # This test is disabled to avoid creating too many accounts.
+  def disabled_test_create_account
+    create_account()
+  end
+
+  def test_get_account_alerts
+    get_account_alerts()
+  end
+
+  def test_get_account_changes
+    get_account_changes()
+  end
+
+  def test_get_account_hierarchy
+    get_account_hierarchy()
+  end
+
+  def test_get_client_customer_id
+    get_client_customer_id('user@example.com')
+  end
+
+  def test_get_client_unit_usage
+    get_client_unit_usage(1234567890)
+  end
+end

data/test/examples/v201109/test_basic_operations.rb

@@ -0,0 +1,172 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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.
+#
+# Tests the basic operations examples.
+
+require 'test/unit'
+
+require 'basic_operations/add_ad_groups'
+require 'basic_operations/add_campaigns'
+require 'basic_operations/add_keywords'
+require 'basic_operations/add_text_ads'
+require 'basic_operations/delete_ad_group'
+require 'basic_operations/delete_ad'
+require 'basic_operations/delete_campaign'
+require 'basic_operations/delete_keyword'
+require 'basic_operations/get_ad_groups'
+require 'basic_operations/get_campaigns'
+require 'basic_operations/get_keywords'
+require 'basic_operations/get_text_ads'
+require 'basic_operations/pause_ad'
+require 'basic_operations/update_ad_group'
+require 'basic_operations/update_campaign'
+require 'basic_operations/update_keyword'
+
+class TestBasicOperationsV201109 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109.new(@adwords)
+  end
+
+  def test_add_campaigns
+    add_campaigns()
+  end
+
+  def test_get_campaigns
+    get_campaigns()
+  end
+
+  def test_add_ad_groups
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    add_ad_groups(campaign[:id])
+  end
+
+  def test_add_keywords
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    add_keywords(ad_group[:id])
+  end
+
+  def test_get_keywords
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    get_keywords(ad_group[:id])
+  end
+
+  def test_add_text_ads
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    add_text_ads(ad_group[:id])
+  end
+
+  def test_get_text_ads
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    get_text_ads(ad_group[:id])
+  end
+
+  def test_pause_ad
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    ad = @utils.get_ad()
+    assert_not_nil(ad)
+    assert_not_nil(ad[:ad])
+    assert_not_nil(ad[:ad][:id])
+    pause_ad(ad_group[:id], ad[:ad][:id])
+  end
+
+  def test_update_ad_group
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    update_ad_group(ad_group[:id])
+  end
+
+  def test_update_campaign
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    update_campaign(campaign[:id])
+  end
+
+  def test_update_keyword
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    keyword = @utils.get_keyword()
+    assert_not_nil(keyword)
+    assert_not_nil(keyword[:criterion])
+    assert_not_nil(keyword[:criterion][:id])
+    update_keyword(ad_group[:id], keyword[:criterion][:id])
+  end
+
+  def test_delete_keyword
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    keyword = @utils.get_keyword()
+    assert_not_nil(keyword)
+    assert_not_nil(keyword[:criterion])
+    assert_not_nil(keyword[:criterion][:id])
+    delete_keyword(ad_group[:id], keyword[:criterion][:id])
+  end
+
+  def test_delete_ad
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    ad = @utils.get_ad()
+    assert_not_nil(ad)
+    assert_not_nil(ad[:ad])
+    assert_not_nil(ad[:ad][:id])
+    delete_ad(ad_group[:id], ad[:ad][:id])
+  end
+
+  def test_delete_ad_group
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    delete_ad_group(ad_group[:id])
+  end
+
+  def test_delete_campaign
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    delete_campaign(campaign[:id])
+  end
+
+  def test_get_ad_groups
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    get_ad_groups(campaign[:id])
+  end
+end

data/test/examples/v201109/test_campaign_management.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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.
+#
+# Tests the campaign management examples.
+
+require 'test/unit'
+
+require 'campaign_management/add_experiment'
+require 'campaign_management/add_keywords_in_bulk'
+require 'campaign_management/add_location_extension'
+require 'campaign_management/add_location_extension_override'
+require 'campaign_management/get_all_disapproved_ads'
+require 'campaign_management/promote_experiment'
+require 'campaign_management/set_ad_parameters'
+require 'campaign_management/validate_text_ad'
+
+RETRY_INTERVAL = 5
+RETRIES_COUNT = 3
+KEYWORD_NUMBER = 3
+
+class TestCampaignManagementV201109 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109.new(@adwords)
+  end
+
+  def test_add_experiment
+    campaign = @utils.get_campaign()
+    ad_group = @utils.get_ad_group()
+    criterion = @utils.get_keyword()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    assert_not_nil(criterion)
+    assert_not_nil(criterion[:criterion])
+    assert_not_nil(criterion[:criterion][:id])
+    add_experiment(campaign[:id], ad_group[:id], criterion[:criterion][:id])
+  end
+
+  def test_add_keywords_in_bulk
+    add_keywords_in_bulk()
+  end
+
+  def test_add_location_extension
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    add_location_extension(campaign[:id])
+  end
+
+  def test_add_location_extension_override
+    ad = @utils.get_ad()
+    location_extension = @utils.get_location_extension()
+    assert_not_nil(ad)
+    assert_not_nil(ad[:ad])
+    assert_not_nil(ad[:ad][:id])
+    assert_not_nil(location_extension)
+    assert_not_nil(location_extension[:ad_extension])
+    assert_not_nil(location_extension[:ad_extension][:id])
+    add_location_extension_override(
+        ad[:ad][:id], location_extension[:ad_extension][:id])
+  end
+
+  def test_get_all_disapproved_ads
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    get_all_disapproved_ads(ad_group[:id])
+  end
+
+  def test_promote_experiment
+    experiment = @utils.get_experiment()
+    assert_not_nil(experiment)
+    assert_not_nil(experiment[:id])
+    promote_experiment(experiment[:id])
+  end
+
+  def test_set_ad_parameters
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    criterion = @utils.get_keyword()
+    assert_not_nil(criterion)
+    assert_not_nil(criterion[:criterion])
+    assert_not_nil(criterion[:criterion][:id])
+    set_ad_parameters(ad_group[:id], criterion[:criterion][:id])
+  end
+
+  def test_validate_text_ad
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    validate_text_ad(ad_group[:id])
+  end
+end