google-adwords-api 0.6.2 → 0.6.3

data/lib/adwords_api/version.rb

@@ -21,6 +21,6 @@
 
 module AdwordsApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.6.2'
+    CLIENT_LIB_VERSION = '0.6.3'
   end
 end

data/test/adwords_api/test_api_config.rb

@@ -32,35 +32,35 @@ class TestApiConfig < Test::Unit::TestCase
 
   # Tests correct require path.
   def test_do_require()
-    name1 = @config.do_require(:v201109, :InfoService)
-    assert_equal('adwords_api/v201109/info_service', name1)
+    name1 = @config.do_require(:v201206, :InfoService)
+    assert_equal('adwords_api/v201206/info_service', name1)
   end
 
   # Tests correct module name.
   def test_module_name()
-    name1 = @config.module_name(:v201109, :InfoService)
-    assert_equal('AdwordsApi::V201109::InfoService', name1)
+    name1 = @config.module_name(:v201206, :InfoService)
+    assert_equal('AdwordsApi::V201206::InfoService', name1)
   end
 
   # Tests correct interface name.
   def test_interface_name()
-    name1 = @config.interface_name(:v201109, :InfoService)
-    assert_equal('AdwordsApi::V201109::InfoService::InfoService', name1)
+    name1 = @config.interface_name(:v201206, :InfoService)
+    assert_equal('AdwordsApi::V201206::InfoService::InfoService', name1)
   end
 
   # Tests AdHoc report URL generator (prod).
   def test_adhoc_report_download_url_prod()
-    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:PRODUCTION, :v201109)
+    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:PRODUCTION, :v201206)
     expected_url =
-        'https://adwords.google.com/api/adwords/reportdownload/v201109'
+        'https://adwords.google.com/api/adwords/reportdownload/v201206'
     assert_equal(expected_url, url)
   end
 
   # Tests AdHoc report URL generator (sandbox).
   def test_adhoc_report_download_url_sandbox()
-    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:SANDBOX, :v201109)
+    url = AdwordsApi::ApiConfig.adhoc_report_download_url(:SANDBOX, :v201206)
     expected_url =
-        'https://adwords-sandbox.google.com/api/adwords/reportdownload/v201109'
+        'https://adwords-sandbox.google.com/api/adwords/reportdownload/v201206'
     assert_equal(expected_url, url)
   end
 end

data/test/adwords_api/test_report_utils.rb

@@ -24,7 +24,7 @@ require 'test/unit'
 
 require 'adwords_api'
 
-API_VERSION = :v201109
+API_VERSION = :v201206
 
 # Overriding default access levels to public for tests.
 module AdwordsApi

data/test/bugs/test_issue_00000031.rb

@@ -25,12 +25,12 @@ require 'test/unit'
 
 require 'ads_common/parameters_validator'
 require 'adwords_api'
-require 'adwords_api/v201109/targeting_idea_service_registry'
+require 'adwords_api/v201206/targeting_idea_service_registry'
 
 class TestIssue31 < Test::Unit::TestCase
   def setup()
     @registry =
-        AdwordsApi::V201109::TargetingIdeaService::TargetingIdeaServiceRegistry
+        AdwordsApi::V201206::TargetingIdeaService::TargetingIdeaServiceRegistry
   end
 
   def run_test(selector)
@@ -42,34 +42,34 @@ class TestIssue31 < Test::Unit::TestCase
   def test_issue_31_single_xsi_type()
     selector = {
         :search_parameters => [
-            {:xsi_type => 'KeywordMatchTypeSearchParameter',
-             :keyword_match_types => ['BROAD']}
+            {:xsi_type => 'RelatedToQuerySearchParameter',
+             :queries => ['test']}
         ]
     }
     result_xml = run_test(selector)
-    r = /searchParameters xsi:type="KeywordMatchTypeSearchParameter"/ =~
+    r = /searchParameters xsi:type="RelatedToQuerySearchParameter"/ =~
         result_xml
     assert_not_nil(r, 'Unable to find item with xsi_type ' +
-        'KeywordMatchTypeSearchParameter')
+        'RelatedToQuerySearchParameter')
   end
 
   def test_issue_31_multiple_xsi_types()
     selector = {
         :search_parameters => [
-            {:xsi_type => 'AverageTargetedMonthlySearchesSearchParameter',
-             :operation => { :minimum => 10000, :maximum => 100000000}},
-            {:xsi_type => 'KeywordMatchTypeSearchParameter',
-             :keyword_match_types => ['BROAD']}
+            {:xsi_type => 'CategoryProductsAndServicesSearchParameter',
+             :category_id => 42},
+            {:xsi_type => 'RelatedToQuerySearchParameter',
+             :queries => ['test']}
         ]
     }
     result_xml = run_test(selector)
-    r1 = /searchParameters xsi:type="KeywordMatchTypeSearchParameter"/ =~
+    r1 = /searchParameters xsi:type="CategoryProductsAndServicesSearchParameter"/ =~
         result_xml
-    r2 = /searchParameters xsi:type="AverageTargetedMonthlySearchesSearchParameter"/ =~
+    r2 = /searchParameters xsi:type="RelatedToQuerySearchParameter"/ =~
         result_xml
     assert_not_nil(r1, 'Unable to find item with xsi_type ' +
-        'KeywordMatchTypeSearchParameter')
+        'CategoryProductsAndServicesSearchParameter')
     assert_not_nil(r2, 'Unable to find item with xsi_type ' +
-        'AverageTargetedMonthlySearchesSearchParameter')
+        'RelatedToQuerySearchParameter')
   end
 end

data/test/bugs/test_issue_00000063.rb

@@ -26,12 +26,12 @@ require 'test/unit'
 
 require 'ads_common/results_extractor'
 require 'adwords_api'
-require 'adwords_api/v201109_1/mutate_job_service_registry'
+require 'adwords_api/v201206/mutate_job_service_registry'
 
 class TestIssue63 < Test::Unit::TestCase
   def setup()
     @registry =
-        AdwordsApi::V201109_1::MutateJobService::MutateJobServiceRegistry
+        AdwordsApi::V201206::MutateJobService::MutateJobServiceRegistry
   end
 
   def run_test(xml_text)
@@ -59,7 +59,7 @@ class TestIssue63 < Test::Unit::TestCase
 <?xml version="1.0"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
-    <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201109_1">
+    <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201206">
       <requestId>123</requestId>
       <serviceName>MutateJobService</serviceName>
       <methodName>getResult</methodName>
@@ -69,7 +69,7 @@ class TestIssue63 < Test::Unit::TestCase
     </ResponseHeader>
   </soap:Header>
   <soap:Body>
-    <getResultResponse xmlns="https://adwords.google.com/api/adwords/cm/v201109_1">
+    <getResultResponse xmlns="https://adwords.google.com/api/adwords/cm/v201206">
       <rval>
         <SimpleMutateResult>
           <results>
@@ -98,7 +98,7 @@ EOT
 <?xml version="1.0"?>
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
-    <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201109_1">
+    <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201206">
       <requestId>123</requestId>
       <serviceName>MutateJobService</serviceName>
       <methodName>getResult</methodName>
@@ -108,7 +108,7 @@ EOT
     </ResponseHeader>
   </soap:Header>
   <soap:Body>
-    <getResultResponse xmlns="https://adwords.google.com/api/adwords/cm/v201109_1">
+    <getResultResponse xmlns="https://adwords.google.com/api/adwords/cm/v201206">
       <rval>
         <SimpleMutateResult>
           <results>

data/test/examples/v201206/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 TestAccountManagementV201206 < 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/v201206/test_basic_operations.rb

@@ -0,0 +1,177 @@
+#!/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_campaigns_with_awql'
+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 TestBasicOperationsV201206 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201206.new(@adwords)
+  end
+
+  def test_add_campaigns
+    add_campaigns()
+  end
+
+  def test_get_campaigns
+    get_campaigns()
+  end
+
+  def test_get_campaigns_with_awql
+    get_campaigns_with_awql()
+  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/v201206/test_campaign_management.rb

@@ -0,0 +1,124 @@
+#!/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/get_all_disapproved_ads_with_awql'
+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 TestCampaignManagementV201206 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201206.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_get_all_disapproved_ads_with_awql
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    get_all_disapproved_ads_with_awql(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