google-adwords-api 0.12.1 → 0.13.0

data/examples/v201309/advanced_operations/upload_offline_conversions.rb

@@ -1,117 +0,0 @@
-#!/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 code example imports offline conversion values for specific clicks to
-# your account. To get Google Click ID for a click, run
-# CLICK_PERFORMANCE_REPORT.
-#
-# Tags: ConversionTrackerService.mutate, OfflineConversionFeedService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-  # 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')
-
-  conversion_tracker_srv =
-      adwords.service(:ConversionTrackerService, API_VERSION)
-  conversion_feed_srv =
-      adwords.service(:OfflineConversionFeedService, API_VERSION)
-
-  # Create an upload conversion. Once created, this entry will be visible under
-  # Tools and Analysis->Conversion and will have Source = Import.
-  upload_conversion = {
-    :xsi_type => 'UploadConversion',
-    :category => 'PAGE_VIEW',
-    :name => conversion_name,
-    :viewthrough_lookback_window => 30,
-    :ctc_lookback_window => 90
-  }
-  return_conversions = conversion_tracker_srv.mutate([
-    {:operator => 'ADD', :operand => upload_conversion}])
-  return_conversions[:value].each do |tracker|
-    puts "Upload conversion tracker with name '%s' and ID %d was created." %
-      [tracker[:name], tracker[:id]]
-  end
-
-  # Associate offline conversions with the upload conversion tracker we created.
-  feed = {
-    :conversion_name => conversion_name,
-    :google_click_id => google_click_id,
-    :conversion_time => conversion_time,
-    :conversion_value => conversion_value
-  }
-  return_feeds = conversion_feed_srv.mutate([
-    {:operator => 'ADD', :operand => feed}])
-  return_feeds[:value].each do |return_feed|
-    puts ("Uploaded offline conversion value %.2f for Google Click ID '%s', " +
-        'to %s') % [return_feed[:conversion_value],
-                    return_feed[:google_click_id],
-                    return_feed[:conversion_name]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201309
-
-  begin
-    # Name of the upload conversion to be created.
-    conversion_name = 'INSERT_CONVERSION_NAME_HERE'
-    # Google Click ID of the click for which offline conversions are uploaded.
-    google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
-    # Conversion time in 'yyyymmdd hhmmss' format.
-    conversion_time = Time.new.strftime("%Y%m%d %H%M%S")
-    # Conversion value to be uploaded.
-    conversion_value = 'INSERT_CONVERSION_VALUE_HERE'.to_f
-
-    upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-
-  # 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/v201309/advanced_operations/use_shared_bidding_strategy.rb

@@ -1,163 +0,0 @@
-#!/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/v201309/basic_operations/add_ad_groups.rb

@@ -1,143 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 illustrates how to create ad groups. To get a list of existing
-# campaigns run get_campaigns.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'adwords_api'
-
-def add_ad_groups(campaign_id)
-  # 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')
-
-  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
-
-  ad_groups = [
-    {
-      :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign_id,
-      :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}
-          }
-        ]
-      },
-      :settings => [
-        # Targetting restriction settings - these setting only affect serving
-        # for the Display Network.
-        {
-          :xsi_type => 'TargetingSetting',
-          :details => [
-            # Restricting to serve ads that match your ad group placements.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'PLACEMENT',
-              :target_all => true
-            },
-            # Using your ad group verticals only for bidding.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'VERTICAL',
-              :target_all => false
-            }
-          ]
-        }
-      ]
-    },
-    {
-      :name => 'Earth to Pluto Cruises #%d' % (Time.new.to_f * 1000).to_i,
-      :status => 'ENABLED',
-      :campaign_id => campaign_id,
-      :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}
-          }
-        ]
-      }
-    }
-  ]
-
-  # Prepare operations for adding ad groups.
-  operations = ad_groups.map do |ad_group|
-    {:operator => 'ADD', :operand => ad_group}
-  end
-
-  # Add ad groups.
-  response = ad_group_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |ad_group|
-      puts "Ad group ID %d was successfully added." % ad_group[:id]
-    end
-  else
-    raise StandardError, 'No ad group was added'
-  end
-end
-
-if __FILE__ == $0
-  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
-
-  # 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/v201309/basic_operations/add_campaigns.rb

@@ -1,162 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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 illustrates how to create campaigns.
-#
-# Tags: CampaignService.mutate, BudgetService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def add_campaigns()
-  # 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)
-  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'
-  }
-  budget_operation = {:operator => 'ADD', :operand => budget}
-
-  # Add budget.
-  return_budget = budget_srv.mutate([budget_operation])
-  budget_id = return_budget[:value].first[:budget_id]
-
-  # Create campaigns.
-  campaigns = [
-    {
-      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :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},
-      # 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
-      },
-      # Optional fields:
-      :start_date =>
-          DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
-      :ad_serving_optimization_status => 'ROTATE',
-      :settings => [
-        {
-          :xsi_type => 'GeoTargetTypeSetting',
-          :positive_geo_target_type => 'DONT_CARE',
-          :negative_geo_target_type => 'DONT_CARE'
-        },
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ],
-      :frequency_cap => {
-        :impressions => '5',
-        :time_unit => 'DAY',
-        :level => 'ADGROUP'
-      }
-    },
-    {
-      :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy_configuration => {
-        :bidding_strategy_type => 'MANUAL_CPC'
-      },
-      :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
-    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
-
-  # 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