google-adwords-api 0.21.1 → 0.22.0

data/examples/v201603/basic_operations/add_ad_groups.rb

@@ -1,142 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-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}
-          }
-        ]
-      },
-      :settings => [
-        # Targeting restriction settings. Depending on the :criterion_type_group
-        # value, most TargetingSettingDetail only affect Display campaigns.
-        # However, the USER_INTEREST_AND_LIST value works for RLSA campaigns -
-        # Search campaigns targeting using a remarketing list.
-        {
-          :xsi_type => 'TargetingSetting',
-          :details => [
-            # Restricting to serve ads that match your ad group placements.
-            # This is equivalent to choosing "Target and bid" in the UI.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'PLACEMENT',
-              :target_all => false
-            },
-            # Using your ad group verticals only for bidding. This is equivalent
-            # to choosing "Bid only" in the UI.
-            {
-              :xsi_type => 'TargetingSettingDetail',
-              :criterion_type_group => 'VERTICAL',
-              :target_all => true
-            }
-          ]
-        }
-      ]
-    },
-    {
-      :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 = :v201603
-
-  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  " +
-        'https://github.com/googleads/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/v201603/basic_operations/add_campaigns.rb

@@ -1,138 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-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'
-  }
-  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'
-      },
-      # Budget (required) - note only the budget ID is required.
-      :budget => {:budget_id => budget_id},
-      :advertising_channel_type => 'SEARCH',
-      # Optional fields:
-      :start_date =>
-          DateTime.parse((Date.today + 1).to_s).strftime('%Y%m%d'),
-      :ad_serving_optimization_status => 'ROTATE',
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => true
-      },
-      :settings => [
-        {
-          :xsi_type => 'GeoTargetTypeSetting',
-          :positive_geo_target_type => 'DONT_CARE',
-          :negative_geo_target_type => 'DONT_CARE'
-        }
-      ],
-      :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},
-      :advertising_channel_type => 'DISPLAY'
-    }
-  ]
-
-  # 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 = :v201603
-
-  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  " +
-        'https://github.com/googleads/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/v201603/basic_operations/add_keywords.rb

@@ -1,114 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 add multiple keywords to a given ad group. To
-# create an ad group, run add_ad_group.rb.
-
-require 'adwords_api'
-
-def add_keywords(ad_group_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_criterion_srv =
-      adwords.service(:AdGroupCriterionService, API_VERSION)
-
-  # Create keywords.
-  # 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.
-  keywords = [
-    {:xsi_type => 'BiddableAdGroupCriterion',
-     :ad_group_id => ad_group_id,
-     :criterion => {
-       :xsi_type => 'Keyword',
-       :text => 'mars cruise',
-       :match_type => 'BROAD'
-     },
-     # Optional fields:
-     :user_status => 'PAUSED',
-     :final_urls => {
-       :urls => ['http://example.com/mars']
-     }
-    },
-    {:xsi_type => 'BiddableAdGroupCriterion',
-     :ad_group_id => ad_group_id,
-     :criterion => {
-       :xsi_type => 'Keyword',
-       :text => 'space hotel',
-       :match_type => 'BROAD'}}
-  ]
-
-  # Create 'ADD' operations.
-  operations = keywords.map do |keyword|
-    {:operator => 'ADD', :operand => keyword}
-  end
-
-  # Add keywords.
-  response = ad_group_criterion_srv.mutate(operations)
-  if response and response[:value]
-    ad_group_criteria = response[:value]
-    puts "Added %d keywords to ad group ID %d:" %
-        [ad_group_criteria.length, ad_group_id]
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "\tKeyword ID is %d and type is '%s'" %
-          [ad_group_criterion[:criterion][:id],
-           ad_group_criterion[:criterion][:type]]
-    end
-  else
-    raise StandardError, 'No keywords were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  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  " +
-        'https://github.com/googleads/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/v201603/basic_operations/add_text_ads.rb

@@ -1,109 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 add text ads to a given ad group. To create an
-# ad group, run add_ad_group.rb.
-
-require 'adwords_api'
-
-def add_text_ads(ad_group_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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
-
-  # Create text ads.
-  # 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.
-  text_ads = [
-    {
-      :xsi_type => 'TextAd',
-      :headline => 'Luxury Cruise to Mars',
-      :description1 => 'Visit the Red Planet in style.',
-      :description2 => 'Low-gravity fun for everyone!',
-      :final_urls => ['http://www.example.com'],
-      :display_url => 'www.example.com'
-    },
-    {
-      :xsi_type => 'TextAd',
-      :headline => 'Luxury Cruise to Mars',
-      :description1 => 'Enjoy your stay at Red Planet.',
-      :description2 => 'Buy your tickets now!',
-      :final_urls => ['http://www.example.com'],
-      :display_url => 'www.example.com'
-    }
-  ]
-
-  # Create ad 'ADD' operations.
-  text_ad_operations = text_ads.map do |text_ad|
-    {:operator => 'ADD',
-     :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
-  end
-
-  # Add ads.
-  response = ad_group_ad_srv.mutate(text_ad_operations)
-  if response and response[:value]
-    ads = response[:value]
-    puts "Added %d ad(s) to ad group ID %d:" % [ads.length, ad_group_id]
-    ads.each do |ad|
-      puts "\tAd ID %d, type '%s' and status '%s'" %
-          [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
-    end
-  else
-    raise StandardError, 'No ads were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  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  " +
-        'https://github.com/googleads/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