google-adwords-api 0.5.3 → 0.6.0

data/test/examples/v201109_1/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_1 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109_1.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

data/test/examples/v201109_1/test_error_handling.rb

@@ -0,0 +1,63 @@
+#!/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 error handling examples.
+
+require 'test/unit'
+
+require 'error_handling/handle_captcha_challenge'
+require 'error_handling/handle_partial_failures'
+require 'error_handling/handle_policy_violation_error'
+require 'error_handling/handle_two_factor_authorization_error'
+
+MAX_RETRIES = 50
+
+class TestErrorHandlingV201109_1 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109_1.new(@adwords)
+  end
+
+  # This test is disabled as it requires user input.
+  def disabled_test_handle_captcha_challenge
+    handle_captcha_challenge()
+  end
+
+  def test_handle_partial_failures
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    handle_partial_failures(ad_group[:id])
+  end
+
+  def test_handle_policy_violation_error
+    ad_group = @utils.get_ad_group()
+    assert_not_nil(ad_group)
+    assert_not_nil(ad_group[:id])
+    handle_policy_violation_error(ad_group[:id])
+  end
+
+  def test_handle_two_factor_authorization_error
+    handle_two_factor_authorization_error()
+  end
+end

data/{lib/adwords_api/v13_login_handler.rb → test/examples/v201109_1/test_misc.rb}

@@ -1,8 +1,9 @@
+#!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -17,15 +18,28 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# Handles v13 authentication.
+# Tests the misc examples.
 
-require 'ads_common/auth/base_handler'
+require 'test/unit'
 
-module AdwordsApi
-  class V13LoginHandler < AdsCommon::Auth::BaseHandler
-    def header_list(credentials)
-      # Ensure that clientEmail and clientCustomerId are always present.
-      return credentials.keys.dup() | [:clientEmail, :clientCustomerId]
-    end
+require 'misc/get_all_images_and_videos'
+require 'misc/upload_image'
+require 'misc/use_oauth'
+
+class TestMiscV201109_1 < Test::Unit::TestCase
+  def setup
+  end
+
+  def test_get_all_images_and_videos
+    get_all_images_and_videos()
+  end
+
+  def test_upload_image
+    upload_image()
+  end
+
+  # This test is disabled as it requires user input.
+  def disabled_test_use_oauth
+    use_oauth()
   end
 end

data/test/examples/v201109_1/test_optimization.rb

@@ -0,0 +1,63 @@
+#!/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 optimization examples.
+
+require 'test/unit'
+
+require 'optimization/estimate_keyword_traffic'
+require 'optimization/get_keyword_bid_simulations'
+require 'optimization/get_keyword_ideas'
+require 'optimization/get_placement_ideas'
+
+class TestOptimizationV201109_1 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109_1.new(@adwords)
+  end
+
+  def test_estimate_keyword_traffic
+    estimate_keyword_traffic()
+  end
+
+  def test_get_keyword_bid_simulations
+    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])
+    get_criterion_bid_landscapes(ad_group[:id], keyword[:criterion][:id])
+  end
+
+  def test_get_keyword_ideas
+    keyword_text = 'orion tours'
+    get_keyword_ideas(keyword_text)
+  end
+
+  def test_get_placement_ideas
+    url = 'http://example.google.com'
+    get_placement_ideas(url)
+  end
+end

data/test/{suite_exampletests.rb → examples/v201109_1/test_remarketing.rb}

@@ -18,14 +18,22 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# Test suite for example tests.
-
-lib = File.expand_path('../../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
+# Tests the remarketing examples.
 
 require 'test/unit'
 
-# v201109 example tests.
-$:.unshift File.expand_path('../../examples/v201109', __FILE__)
-Dir.glob('./test/examples/v201109/utils.rb').each {|file| require file}
-Dir.glob('./test/examples/v201109/test*.rb').each {|file| require file}
+require 'remarketing/add_audience'
+require 'remarketing/add_conversion_tracker'
+
+class TestRemarketingV201109_1 < Test::Unit::TestCase
+  def setup
+  end
+
+  def test_add_audience
+    add_audience()
+  end
+
+  def test_add_conversion_tracker
+    add_conversion_tracker()
+  end
+end

data/test/examples/v201109_1/test_reporting.rb

@@ -0,0 +1,77 @@
+#!/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 reporting examples.
+
+require 'test/unit'
+require 'tempfile'
+
+require 'reporting/download_criteria_report'
+require 'reporting/get_campaign_stats'
+require 'reporting/get_defined_reports'
+require 'reporting/get_report_fields'
+require 'reporting/parallel_report_download'
+
+THREADS = 3
+MAX_RETRIES = 3
+BACKOFF_FACTOR = 3
+
+class TestReportingV201109_1 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109_1.new(@adwords)
+  end
+
+  def test_download_criteria_report
+    file = Tempfile.new('ruby-examples')
+    begin
+      file.close()
+      download_criteria_report(file.path)
+    ensure
+      file.unlink()
+    end
+  end
+
+  def test_get_campaign_stats
+    get_campaign_stats()
+  end
+
+  def test_get_defined_reports
+    get_defined_reports()
+  end
+
+  def test_get_report_fields
+    report_type = 'ACCOUNT_PERFORMANCE_REPORT'
+    get_report_fields(report_type)
+  end
+
+  def test_parallel_report_download
+    old_dir = Dir.pwd
+    Dir.chdir('/tmp')
+    begin
+      parallel_report_download()
+    ensure
+      Dir.chdir(old_dir)
+    end
+  end
+end

data/test/examples/v201109_1/test_targeting.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 targeting examples.
+
+require 'test/unit'
+
+require 'targeting/add_campaign_targeting_criteria'
+require 'targeting/get_campaign_targeting_criteria'
+require 'targeting/get_targetable_languages_and_carriers'
+require 'targeting/lookup_location'
+
+class TestTargetingV201109_1 < Test::Unit::TestCase
+  def setup
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::ERROR
+    @adwords = AdwordsApi::Api.new
+    @adwords.logger = @logger
+    @utils = UtilsV201109_1.new(@adwords)
+  end
+
+  def test_add_campaign_targeting_criteria
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    add_campaign_targeting_criteria(campaign[:id])
+  end
+
+  def test_get_campaign_targeting_criteria
+    campaign = @utils.get_campaign()
+    assert_not_nil(campaign)
+    assert_not_nil(campaign[:id])
+    get_campaign_targeting_criteria(campaign[:id])
+  end
+
+  def test_get_targetable_languages_and_carriers
+    get_targetable_languages_and_carriers()
+  end
+
+  def test_lookup_location
+    lookup_location()
+  end
+end