google-adwords-api 0.5.1 → 0.5.2

data/test/examples/v201109/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 < 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
+
+  # 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/test/examples/v201109/test_misc.rb

@@ -0,0 +1,45 @@
+#!/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 misc examples.
+
+require 'test/unit'
+
+require 'misc/get_all_images_and_videos'
+require 'misc/upload_image'
+require 'misc/use_oauth'
+
+class TestMiscV201109 < 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/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 < 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_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/examples/v201109/test_remarketing.rb

@@ -0,0 +1,39 @@
+#!/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 remarketing examples.
+
+require 'test/unit'
+
+require 'remarketing/add_audience'
+require 'remarketing/add_conversion_tracker'
+
+class TestRemarketingV201109 < 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/test_reporting.rb

@@ -0,0 +1,89 @@
+#!/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/download_defined_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 < 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_download_criteria_report
+    file = Tempfile.new('ruby-examples')
+    begin
+      file.close()
+      download_criteria_report(file.path)
+    ensure
+      file.unlink()
+    end
+  end
+
+  def test_download_defined_report
+    report_definition_id = '1234567890'
+    file = Tempfile.new('ruby-examples')
+    begin
+      file.close()
+      download_defined_report(report_definition_id, 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/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 < 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_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

data/test/examples/v201109/utils.rb

@@ -0,0 +1,239 @@
+# 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.
+#
+# Utilities and constants for example tests.
+
+API_VERSION = :v201109
+PAGE_SIZE = 500
+
+class UtilsV201109
+  def initialize(adwords)
+    @adwords = adwords
+  end
+
+  def get_campaign
+    @campaign ||= create_campaign()
+    return @campaign
+  end
+
+  def get_ad_group
+    @ad_group ||= create_ad_group()
+    return @ad_group
+  end
+
+  def get_ad
+    @ad ||= create_ad(get_ad_group()[:id])
+    return @ad
+  end
+
+  def get_keyword
+    @keyword ||= create_keyword(get_ad_group()[:id])
+    return @keyword
+  end
+
+  def get_location_extension
+    @location_extension ||= create_location_extension(get_campaign()[:id])
+    return @location_extension
+  end
+
+  def get_experiment
+    @experiment ||= create_experiment(
+        get_campaign()[:id], get_ad_group()[:id], get_keyword[:criterion][:id])
+    return @experiment
+  end
+
+  private
+
+  def create_campaign
+    campaign_srv = @adwords.service(:CampaignService, API_VERSION)
+    campaign = {
+      :name => "Example tests campaign #%d" % (Time.new.to_f * 1000).to_i,
+      :status => 'PAUSED',
+      :bidding_strategy => {:xsi_type => 'ManualCPC'},
+      :budget => {
+        :period => 'DAILY',
+        :amount => {:micro_amount => 50000000},
+        :delivery_method => 'STANDARD'
+      },
+      :network_setting => {
+        :target_google_search => true,
+        :target_search_network => true,
+        :target_content_network => false,
+        :target_content_contextual => false
+      }
+    }
+    operation = {:operator => 'ADD', :operand => campaign}
+    response = campaign_srv.mutate([operation])
+    return response[:value].first
+  end
+
+  def create_ad_group
+    campaign = get_campaign()
+    ad_group_srv = @adwords.service(:AdGroupService, API_VERSION)
+    ad_group = {
+      :name => "Example tests ad group #%d" % (Time.new.to_f * 1000).to_i,
+      :status => 'ENABLED',
+      :campaign_id => campaign[:id],
+      :bids => {
+        :xsi_type => 'ManualCPCAdGroupBids',
+        :keyword_max_cpc => {:amount => {:micro_amount => 10000000}},
+      }
+    }
+    operation = {:operator => 'ADD', :operand => ad_group}
+    response = ad_group_srv.mutate([operation])
+    return response[:value].first
+  end
+
+  def create_ad(ad_group_id)
+    ad_group_ad_srv = @adwords.service(:AdGroupAdService, API_VERSION)
+    text_ad = {
+      :xsi_type => 'TextAd',
+      :headline => 'Examples test ad %d' % (Time.new.to_f * 1000).to_i,
+      :description1 => 'testing ruby examples',
+      :description2 => 'all your base are belong to us',
+      :url => 'http://www.example.com',
+      :display_url => 'www.example.com'
+    }
+    operation = {:operator => 'ADD',
+                 :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
+    response = ad_group_ad_srv.mutate([operation])
+    return response[:value].first
+  end
+
+  def create_keyword(ad_group_id)
+    ad_group_criterion_srv =
+        @adwords.service(:AdGroupCriterionService, API_VERSION)
+    keyword = {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => 'mars cruise',
+        :match_type => 'BROAD'
+      }
+    }
+    operation = {:operator => 'ADD', :operand => keyword}
+    response = ad_group_criterion_srv.mutate([operation])
+    return response[:value].first
+  end
+
+  def create_location_extension(campaign_id)
+    campaign_ad_ext_srv =
+        @adwords.service(:CampaignAdExtensionService, API_VERSION)
+    geo_location_srv = @adwords.service(:GeoLocationService, API_VERSION)
+
+    selector = {
+      :addresses => [
+        {
+          :street_address => '1600 Amphitheatre Parkway',
+          :city_name => 'Mountain View',
+          :province_code => 'CA',
+          :postal_code => '94043',
+          :country_code => 'US'
+        }
+      ]
+    }
+
+    locations = geo_location_srv.get(selector)
+    raise StandardError, 'Unable to retrieve geo locations.' if locations.nil?
+
+    operations = locations.map do |location|
+      {
+        :operator => 'ADD',
+        :operand => {
+          :campaign_id => campaign_id,
+          :status => 'ACTIVE',
+          :ad_extension => {
+            :xsi_type => 'LocationExtension',
+            :address => location[:address],
+            :geo_point => location[:geo_point],
+            :encoded_location => location[:encoded_location],
+            :source => 'ADWORDS_FRONTEND'
+          }
+        }
+      }
+    end
+
+    response = campaign_ad_ext_srv.mutate(operations)
+    extension = response[:value].first
+    return extension
+  end
+
+  def create_experiment(campaign_id, ad_group_id, criterion_id)
+    experiment_srv = @adwords.service(:ExperimentService, API_VERSION)
+    ad_group_srv = @adwords.service(:AdGroupService, API_VERSION)
+    ad_group_criterion_srv =
+        @adwords.service(:AdGroupCriterionService, API_VERSION)
+
+    operation = {
+      :operator => 'ADD',
+      :operand => {
+        :campaign_id => campaign_id,
+        :name => "Examples test experiment #%d" % (Time.new.to_f * 1000).to_i,
+        :query_percentage => 10,
+        :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
+      }
+    }
+    response = experiment_srv.mutate([operation])
+    experiment = response[:value].first
+
+    raise StandardError, 'Failed to create experiment' if experiment.nil?
+
+    ad_group = {
+      :id => ad_group_id,
+      :experiment_data => {
+        :experiment_id => experiment[:id],
+        :experiment_delta_status => 'MODIFIED',
+        :experiment_bid_multipliers => {
+          :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
+          :max_cpc_multiplier => {:multiplier => 1.5}
+        }
+      }
+    }
+
+    operation = {:operator => 'SET', :operand => ad_group}
+    response = ad_group_srv.mutate([operation])
+    ad_group = response[:value].first
+
+    raise StandardError, 'Failed to assign experiment' if ad_group.nil?
+
+    ad_group_criterion = {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {:id => criterion_id},
+      :experiment_data => {
+        :xsi_type => 'BiddableAdGroupCriterionExperimentData',
+        :experiment_id => experiment[:id],
+        :experiment_delta_status => 'MODIFIED',
+        :experiment_bid_multiplier => {
+          :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
+          :max_cpc_multiplier => {:multiplier => 1.5}
+        }
+      }
+    }
+
+    operation = {:operator => 'SET', :operand => ad_group_criterion}
+    response = ad_group_criterion_srv.mutate([operation])
+    criterion = response[:value].first
+
+    raise StandardError, 'Failed to assign criterion' if criterion.nil?
+
+    return experiment
+  end
+end