google-adwords-api 0.9.3 → 0.10.0

data/examples/v201309/advanced_operations/use_shared_bidding_strategy.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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.
+#
+# This example adds a Shared Bidding Strategy and uses it to construct a
+# campaign.
+#
+# Tags: BiddingStrategyService.mutate, CampaignService.mutate
+# Tags: BudgetService.mutate
+
+require 'adwords_api'
+require 'date'
+
+def use_shared_bidding_strategy()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  budget_srv = adwords.service(:BudgetService, API_VERSION)
+  bidding_srv = adwords.service(:BiddingStrategyService, API_VERSION)
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Create a budget, which can be shared by multiple campaigns.
+  budget = {
+    :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
+    :amount => {:micro_amount => 50000000},
+    :delivery_method => 'STANDARD',
+    :period => 'DAILY',
+    :is_explicitly_shared => true
+  }
+  return_budget = budget_srv.mutate([
+    {:operator => 'ADD', :operand => budget}])
+  budget_id = return_budget[:value].first[:budget_id]
+
+  # Create a shared bidding strategy.
+  shared_bidding_strategy = {
+    :name => 'Maximize Clicks #%d' % (Time.new.to_f * 1000).to_i,
+    :bidding_scheme => {
+      :xsi_type => 'TargetSpendBiddingScheme',
+      # Optionally set additional bidding scheme parameters.
+      :bid_ceiling => {:micro_amount => 20000000},
+      :spend_target => {:micro_amount => 40000000}
+    }
+  }
+  return_strategy = bidding_srv.mutate([
+    {:operator => 'ADD', :operand => shared_bidding_strategy}])
+
+  bidding_strategy = return_strategy[:value].first
+  puts ("Shared bidding strategy with name '%s' and ID %d of type '%s' was " +
+      'created') %
+      [bidding_strategy[:name], bidding_strategy[:id], bidding_strategy[:type]]
+
+  # Create campaigns.
+  campaigns = [
+    {
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
+      :status => 'PAUSED',
+      :bidding_strategy_configuration => {
+        :bidding_strategy_id => bidding_strategy[:id]
+      },
+      # Budget (required) - note only the budget ID is required.
+      :budget => {:budget_id => budget_id},
+      # Set the campaign network options to Search, Content and Search Network.
+      :network_setting => {
+        :target_google_search => true,
+        :target_search_network => true,
+        :target_content_network => true
+      },
+      :settings => [
+        {
+          :xsi_type => 'KeywordMatchSetting',
+          :opt_in => true
+        }
+      ]
+    },
+    {
+      :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
+      :status => 'PAUSED',
+      :bidding_strategy_configuration => {
+        :bidding_strategy_id => bidding_strategy[:id]
+      },
+      :budget => {:budget_id => budget_id},
+      :settings => [
+        {
+          :xsi_type => 'KeywordMatchSetting',
+          :opt_in => true
+        }
+      ],
+      :network_setting => {
+        :target_google_search => false,
+        :target_search_network => false,
+        :target_content_network => true
+      }
+    }
+  ]
+
+  # Prepare for adding campaign.
+  operations = campaigns.map do |campaign|
+    {:operator => 'ADD', :operand => campaign}
+  end
+
+  # Add campaign.
+  response = campaign_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |campaign|
+      puts "Campaign with name '%s' and ID %d was added." %
+          [campaign[:name], campaign[:id]]
+    end
+  else
+    raise new StandardError, 'No campaigns were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201309
+
+  begin
+    use_shared_bidding_strategy()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201209 → v201309}/basic_operations/add_ad_groups.rb

@@ -41,18 +41,17 @@ def add_ad_groups(campaign_id)
       :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'ENABLED',
       :campaign_id => campaign_id,
-      :bids => {
-        # The 'xsi_type' field allows you to specify the xsi:type of the object
-        # being created. It's only necessary when you must provide an explicit
-        # type that the client library can't infer.
-        :xsi_type => 'ManualCPCAdGroupBids',
-        :keyword_max_cpc => {
-          :amount => {
-            :micro_amount => 10000000
+      :bidding_strategy_configuration => {
+        :bids => [
+          {
+            # The 'xsi_type' field allows you to specify the xsi:type of the
+            # object being created. It's only necessary when you must provide
+            # an explicit type that the client library can't infer.
+            :xsi_type => 'CpcBid',
+            :bid => {:micro_amount => 10000000},
+            :content_bid => {:micro_amount => 2000000}
           }
-        },
-        # Optional field.
-        :keyword_content_max_cpc => {:amount => {:micro_amount => 2000000}}
+        ]
       },
       :settings => [
         # Targetting restriction settings - these setting only affect serving
@@ -80,16 +79,16 @@ def add_ad_groups(campaign_id)
       :name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
       :status => 'ENABLED',
       :campaign_id => campaign_id,
-      :bids => {
-        # The 'xsi_type' field allows you to specify the xsi:type of the object
-        # being created. It's only necessary when you must provide an explicit
-        # type that the client library can't infer.
-        :xsi_type => 'ManualCPCAdGroupBids',
-        :keyword_max_cpc => {
-          :amount => {
-            :micro_amount => 10000000
+      :bidding_strategy_configuration => {
+        :bids => [
+          {
+            # The 'xsi_type' field allows you to specify the xsi:type of the
+            # object being created. It's only necessary when you must provide
+            # an explicit type that the client library can't infer.
+            :xsi_type => 'CpcBid',
+            :bid => {:micro_amount => 10000000}
           }
-        }
+        ]
       }
     }
   ]
@@ -111,13 +110,21 @@ def add_ad_groups(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # Campaign ID to add ad group to.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     add_ad_groups(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/add_campaigns.rb

@@ -55,11 +55,13 @@ def add_campaigns()
     {
       :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
-      :bidding_strategy => {
-        # The 'xsi_type' field allows you to specify the xsi:type of the object
-        # being created. It's only necessary when you must provide an explicit
-        # type that the client library can't infer.
-        :xsi_type => 'ManualCPC'
+      :bidding_strategy_configuration => {
+        :bidding_strategy_type => 'MANUAL_CPC',
+        # Optional: provide BiddingScheme.
+        :bidding_scheme => {
+          :xsi_type => 'ManualCpcBiddingScheme',
+          :enhanced_cpc_enabled => false
+        }
       },
       # Budget (required) - note only the budget ID is required.
       :budget => {:budget_id => budget_id},
@@ -74,13 +76,6 @@ def add_campaigns()
           DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
       :ad_serving_optimization_status => 'ROTATE',
       :settings => [
-        # Display network targeting settings (optional).
-        # It can only be enabled, shown only for demonstration purposes.
-        # If not set this setting is enabled by default on ADD operations.
-        {
-          :xsi_type => 'TargetRestrictSetting',
-          :use_ad_group => true
-        },
         {
           :xsi_type => 'GeoTargetTypeSetting',
           :positive_geo_target_type => 'DONT_CARE',
@@ -100,8 +95,8 @@ def add_campaigns()
     {
       :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
-      :bidding_strategy => {
-        :xsi_type => 'ManualCPM'
+      :bidding_strategy_configuration => {
+        :bidding_strategy_type => 'MANUAL_CPC'
       },
       :budget => {:budget_id => budget_id},
       :settings => [
@@ -136,11 +131,19 @@ def add_campaigns()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     add_campaigns()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/add_keywords.rb

@@ -83,13 +83,21 @@ def add_keywords(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # Ad group ID to add keywords to.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_keywords(ad_group_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/add_text_ads.rb

@@ -80,13 +80,21 @@ def add_text_ads(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # Ad group ID to add text ads to.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_text_ads(ad_group_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/delete_ad.rb

@@ -59,7 +59,7 @@ def delete_ad(ad_group_id, ad_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of an ad to delete and its ad group.
@@ -67,6 +67,14 @@ if __FILE__ == $0
     ad_id = 'INSERT_AD_ID_HERE'.to_i
     delete_ad(ad_group_id, ad_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/delete_ad_group.rb

@@ -77,13 +77,21 @@ def delete_ad_group(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of an ad group to delete.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     delete_ad_group(ad_group_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/delete_campaign.rb

@@ -78,13 +78,21 @@ def delete_campaign(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of a campaign to delete.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     delete_campaign(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201209 → v201309}/basic_operations/delete_keyword.rb

@@ -64,7 +64,7 @@ def delete_keyword(ad_group_id, criterion_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of criterion to delete and its ad group.
@@ -72,6 +72,14 @@ if __FILE__ == $0
     criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
     delete_keyword(ad_group_id, criterion_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e