google-adwords-api 0.7.0 → 0.7.1

data/test/examples/v201209/utils.rb

@@ -0,0 +1,238 @@
+# 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 = :v201209
+PAGE_SIZE = 500
+
+class UtilsV201209
+  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 => true
+      }
+    }
+    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

data/test/suite_exampletests_v201209.rb

@@ -0,0 +1,37 @@
+#!/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.
+#
+# Test suite for v201209 example tests.
+
+require 'test/unit'
+
+$:.unshift File.expand_path('../../lib/', __FILE__)
+$:.unshift File.expand_path('../../', __FILE__)
+
+version = 'v201209'
+
+examples_path =
+    File.expand_path(File.join('..', '..', 'examples', version), __FILE__)
+$:.unshift(examples_path)
+
+tests_path = File.join(File.dirname(__FILE__), 'examples', version)
+require File.join(tests_path, 'utils.rb')
+tests_mask = File.join(tests_path, 'test_*.rb')
+Dir.glob(tests_mask).each {|file| require file}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-adwords-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-ads-common
@@ -158,6 +158,60 @@ files:
 - lib/adwords_api/v201109/data_service.rb
 - lib/adwords_api/errors.rb
 - lib/adwords_api/client_login_header_handler.rb
+- lib/adwords_api/v201209/mutate_job_service.rb
+- lib/adwords_api/v201209/conversion_tracker_service_registry.rb
+- lib/adwords_api/v201209/info_service_registry.rb
+- lib/adwords_api/v201209/budget_service.rb
+- lib/adwords_api/v201209/ad_extension_override_service_registry.rb
+- lib/adwords_api/v201209/customer_service.rb
+- lib/adwords_api/v201209/experiment_service_registry.rb
+- lib/adwords_api/v201209/alert_service_registry.rb
+- lib/adwords_api/v201209/campaign_criterion_service.rb
+- lib/adwords_api/v201209/budget_order_service.rb
+- lib/adwords_api/v201209/ad_group_ad_service_registry.rb
+- lib/adwords_api/v201209/customer_sync_service_registry.rb
+- lib/adwords_api/v201209/budget_order_service_registry.rb
+- lib/adwords_api/v201209/experiment_service.rb
+- lib/adwords_api/v201209/alert_service.rb
+- lib/adwords_api/v201209/customer_sync_service.rb
+- lib/adwords_api/v201209/location_criterion_service_registry.rb
+- lib/adwords_api/v201209/targeting_idea_service.rb
+- lib/adwords_api/v201209/geo_location_service.rb
+- lib/adwords_api/v201209/ad_group_criterion_service.rb
+- lib/adwords_api/v201209/managed_customer_service.rb
+- lib/adwords_api/v201209/user_list_service_registry.rb
+- lib/adwords_api/v201209/constant_data_service_registry.rb
+- lib/adwords_api/v201209/ad_group_ad_service.rb
+- lib/adwords_api/v201209/traffic_estimator_service_registry.rb
+- lib/adwords_api/v201209/campaign_service.rb
+- lib/adwords_api/v201209/conversion_tracker_service.rb
+- lib/adwords_api/v201209/media_service_registry.rb
+- lib/adwords_api/v201209/campaign_ad_extension_service_registry.rb
+- lib/adwords_api/v201209/campaign_service_registry.rb
+- lib/adwords_api/v201209/user_list_service.rb
+- lib/adwords_api/v201209/location_criterion_service.rb
+- lib/adwords_api/v201209/ad_group_service.rb
+- lib/adwords_api/v201209/ad_group_service_registry.rb
+- lib/adwords_api/v201209/ad_param_service.rb
+- lib/adwords_api/v201209/traffic_estimator_service.rb
+- lib/adwords_api/v201209/info_service.rb
+- lib/adwords_api/v201209/data_service_registry.rb
+- lib/adwords_api/v201209/ad_extension_override_service.rb
+- lib/adwords_api/v201209/report_definition_service.rb
+- lib/adwords_api/v201209/ad_param_service_registry.rb
+- lib/adwords_api/v201209/budget_service_registry.rb
+- lib/adwords_api/v201209/mutate_job_service_registry.rb
+- lib/adwords_api/v201209/constant_data_service.rb
+- lib/adwords_api/v201209/ad_group_criterion_service_registry.rb
+- lib/adwords_api/v201209/customer_service_registry.rb
+- lib/adwords_api/v201209/campaign_ad_extension_service.rb
+- lib/adwords_api/v201209/campaign_criterion_service_registry.rb
+- lib/adwords_api/v201209/managed_customer_service_registry.rb
+- lib/adwords_api/v201209/report_definition_service_registry.rb
+- lib/adwords_api/v201209/media_service.rb
+- lib/adwords_api/v201209/geo_location_service_registry.rb
+- lib/adwords_api/v201209/targeting_idea_service_registry.rb
+- lib/adwords_api/v201209/data_service.rb
 - lib/adwords_api/v201206/mutate_job_service.rb
 - lib/adwords_api/v201206/conversion_tracker_service_registry.rb
 - lib/adwords_api/v201206/info_service_registry.rb
@@ -234,6 +288,16 @@ files:
 - test/examples/v201109/test_reporting.rb
 - test/examples/v201109/test_basic_operations.rb
 - test/examples/v201109/test_campaign_management.rb
+- test/examples/v201209/utils.rb
+- test/examples/v201209/test_error_handling.rb
+- test/examples/v201209/test_targeting.rb
+- test/examples/v201209/test_misc.rb
+- test/examples/v201209/test_remarketing.rb
+- test/examples/v201209/test_account_management.rb
+- test/examples/v201209/test_optimization.rb
+- test/examples/v201209/test_reporting.rb
+- test/examples/v201209/test_basic_operations.rb
+- test/examples/v201209/test_campaign_management.rb
 - test/examples/v201206/utils.rb
 - test/examples/v201206/test_error_handling.rb
 - test/examples/v201206/test_targeting.rb
@@ -244,6 +308,7 @@ files:
 - test/examples/v201206/test_reporting.rb
 - test/examples/v201206/test_basic_operations.rb
 - test/examples/v201206/test_campaign_management.rb
+- test/suite_exampletests_v201209.rb
 - test/suite_exampletests_v201109.rb
 - test/bugs/test_issue_00000063.rb
 - test/bugs/test_issue_00000031.rb
@@ -361,6 +426,62 @@ files:
 - examples/v201109/misc/use_oauth2.rb
 - examples/v201109/remarketing/add_conversion_tracker.rb
 - examples/v201109/remarketing/add_audience.rb
+- examples/v201209/reporting/download_criteria_report.rb
+- examples/v201209/reporting/get_campaign_stats.rb
+- examples/v201209/reporting/parallel_report_download.rb
+- examples/v201209/reporting/get_report_fields.rb
+- examples/v201209/reporting/download_criteria_report_with_awql.rb
+- examples/v201209/error_handling/handle_policy_violation_error.rb
+- examples/v201209/error_handling/handle_two_factor_authorization_error.rb
+- examples/v201209/error_handling/handle_captcha_challenge.rb
+- examples/v201209/error_handling/handle_partial_failures.rb
+- examples/v201209/targeting/lookup_location.rb
+- examples/v201209/targeting/get_targetable_languages_and_carriers.rb
+- examples/v201209/targeting/add_campaign_targeting_criteria.rb
+- examples/v201209/targeting/get_campaign_targeting_criteria.rb
+- examples/v201209/targeting/add_demographic_targeting_criteria.rb
+- examples/v201209/campaign_management/validate_text_ad.rb
+- examples/v201209/campaign_management/add_experiment.rb
+- examples/v201209/campaign_management/set_ad_parameters.rb
+- examples/v201209/campaign_management/get_all_disapproved_ads_with_awql.rb
+- examples/v201209/campaign_management/add_location_extension.rb
+- examples/v201209/campaign_management/add_keywords_in_bulk.rb
+- examples/v201209/campaign_management/promote_experiment.rb
+- examples/v201209/campaign_management/get_all_disapproved_ads.rb
+- examples/v201209/campaign_management/add_location_extension_override.rb
+- examples/v201209/account_management/get_account_hierarchy.rb
+- examples/v201209/account_management/get_account_changes.rb
+- examples/v201209/account_management/get_client_unit_usage.rb
+- examples/v201209/account_management/get_client_customer_id.rb
+- examples/v201209/account_management/get_account_alerts.rb
+- examples/v201209/account_management/create_account.rb
+- examples/v201209/optimization/estimate_keyword_traffic.rb
+- examples/v201209/optimization/get_keyword_bid_simulations.rb
+- examples/v201209/optimization/get_keyword_ideas.rb
+- examples/v201209/optimization/get_placement_ideas.rb
+- examples/v201209/basic_operations/update_campaign.rb
+- examples/v201209/basic_operations/get_campaigns.rb
+- examples/v201209/basic_operations/get_ad_groups.rb
+- examples/v201209/basic_operations/add_campaigns.rb
+- examples/v201209/basic_operations/delete_ad_group.rb
+- examples/v201209/basic_operations/delete_keyword.rb
+- examples/v201209/basic_operations/delete_ad.rb
+- examples/v201209/basic_operations/add_ad_groups.rb
+- examples/v201209/basic_operations/update_ad_group.rb
+- examples/v201209/basic_operations/get_keywords.rb
+- examples/v201209/basic_operations/delete_campaign.rb
+- examples/v201209/basic_operations/get_text_ads.rb
+- examples/v201209/basic_operations/add_keywords.rb
+- examples/v201209/basic_operations/add_text_ads.rb
+- examples/v201209/basic_operations/get_campaigns_with_awql.rb
+- examples/v201209/basic_operations/pause_ad.rb
+- examples/v201209/basic_operations/update_keyword.rb
+- examples/v201209/misc/upload_image.rb
+- examples/v201209/misc/get_all_images_and_videos.rb
+- examples/v201209/misc/use_oauth.rb
+- examples/v201209/misc/use_oauth2.rb
+- examples/v201209/remarketing/add_conversion_tracker.rb
+- examples/v201209/remarketing/add_audience.rb
 - examples/v201206/reporting/download_criteria_report.rb
 - examples/v201206/reporting/get_campaign_stats.rb
 - examples/v201206/reporting/parallel_report_download.rb