google-adwords-api 0.20.1 → 0.21.0

data/examples/v201601/advanced_operations/create_and_attach_shared_keyword_set.rb

@@ -1,141 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 creates a shared list of negative broad match keywords, it then
-# attaches them to a campaign.
-
-require 'adwords_api'
-require 'date'
-
-def create_and_attach_shared_keyword_set(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')
-
-  shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
-  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
-  campaign_shared_set_srv =
-      adwords.service(:CampaignSharedSetService, API_VERSION)
-
-  # Keywords to create a shared set of.
-  keywords = ['mars cruise', 'mars hotels']
-
-  # Create shared negative keyword set.
-  shared_set = {
-    :name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
-    :type => 'NEGATIVE_KEYWORDS'
-  }
-
-  # Add shared set.
-  response = shared_set_srv.mutate([
-      {:operator => 'ADD', :operand => shared_set}
-  ])
-
-  if response and response[:value]
-    shared_set = response[:value].first
-    shared_set_id = shared_set[:shared_set_id]
-    puts "Shared set with ID %d and name '%s' was successfully added." %
-        [shared_set_id, shared_set[:name]]
-  else
-    raise StandardError, 'No shared set was added'
-  end
-
-  # Add negative keywords to shared set.
-  shared_criteria = keywords.map do |keyword|
-    {
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => keyword,
-        :match_type => 'BROAD'
-      },
-      :negative => true,
-      :shared_set_id => shared_set_id
-    }
-  end
-
-  operations = shared_criteria.map do |criterion|
-    {:operator => 'ADD', :operand => criterion}
-  end
-
-  response = shared_criterion_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |shared_criterion|
-      puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
-          [shared_criterion[:criterion][:id],
-           shared_criterion[:criterion][:text],
-           shared_criterion[:shared_set_id]]
-    end
-  else
-    raise StandardError, 'No shared keyword was added'
-  end
-
-  # Attach the articles to the campaign.
-  campaign_set = {
-    :campaign_id => campaign_id,
-    :shared_set_id => shared_set_id
-  }
-
-  response = campaign_shared_set_srv.mutate([
-    {:operator => 'ADD', :operand => campaign_set}
-  ])
-  if response and response[:value]
-    campaign_shared_set = response[:value].first
-    puts 'Shared set ID %d was attached to campaign ID %d' %
-        [campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
-  else
-    raise StandardError, 'No campaign shared set was added'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201601
-
-  begin
-    # Campaign ID to attach shared keyword set to.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    create_and_attach_shared_keyword_set(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/v201601/advanced_operations/find_and_remove_criteria_from_shared_set.rb

@@ -1,174 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, 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 demonstrates how to find shared sets, shared set criterions and
-# how to remove them.
-
-require 'adwords_api'
-
-def find_and_remove_criteria_from_shared_set(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')
-
-  campaign_shared_set_srv =
-      adwords.service(:CampaignSharedSetService, API_VERSION)
-  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
-
-  shared_set_ids = []
-  criterion_ids = []
-
-  # First, retrieve all shared sets associated with the campaign.
-
-  # Create selector for shared sets to:
-  # - filter by campaign ID,
-  # - filter by shared set type.
-  selector = {
-    :fields => ['SharedSetId', 'CampaignId', 'SharedSetName', 'SharedSetType',
-        'Status'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
-      {:field => 'SharedSetType', :operator => 'IN', :values =>
-          ['NEGATIVE_KEYWORDS', 'NEGATIVE_PLACEMENTS']}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_shared_set_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |shared_set|
-        puts "Campaign shared set ID %d and name '%s'" %
-            [shared_set[:shared_set_id], shared_set[:shared_set_name]]
-        shared_set_ids << shared_set[:shared_set_id]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  # Next, Retrieve criterion IDs for all found shared sets.
-  selector = {
-    :fields => ['SharedSetId', 'Id', 'KeywordText', 'KeywordMatchType',
-        'PlacementUrl'],
-    :predicates => [
-      {:field => 'SharedSetId', :operator => 'IN', :values => shared_set_ids}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = shared_criterion_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |shared_criterion|
-        if shared_criterion[:criterion][:type] == 'KEYWORD'
-          puts "Shared negative keyword with ID %d and text '%s' was found." %
-            [shared_criterion[:criterion][:id],
-             shared_criterion[:criterion][:text]]
-        elsif shared_criterion[:criterion][:type] == 'PLACEMENT'
-          puts "Shared negative placement with ID %d and url '%s' was found." %
-            [shared_criterion[:criterion][:id],
-             shared_criterion[:criterion][:url]]
-        else
-          puts 'Shared criterion with ID %d was found.' %
-            [shared_criterion[:criterion][:id]]
-        end
-        criterion_ids << {
-           :shared_set_id => shared_criterion[:shared_set_id],
-           :criterion_id => shared_criterion[:criterion][:id]
-        }
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-
-  # Finally, remove the criteria.
-  operations = criterion_ids.map do |criterion|
-    {
-      :operator => 'REMOVE',
-      :operand => {
-        :criterion => {:id => criterion[:criterion_id]},
-        :shared_set_id => criterion[:shared_set_id]
-      }
-    }
-  end
-
-  response = shared_criterion_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |criterion|
-      puts "Criterion ID %d was successfully removed from shared set ID %d." %
-          [criterion[:criterion][:id], criterion[:shared_set_id]]
-    end
-  else
-    puts 'No shared criteria were removed.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201601
-  PAGE_SIZE = 500
-
-  begin
-    # ID of a campaign to remove shared criteria from.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    find_and_remove_criteria_from_shared_set(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/v201601/advanced_operations/get_ad_group_bid_modifiers.rb

@@ -1,102 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 illustrates how to retrieve ad group level bid modifiers for a
-# campaign.
-
-require 'adwords_api'
-
-def get_ad_group_bid_modifiers(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')
-
-  bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
-
-  # Get all ad group bid modifiers for the campaign.
-  selector = {
-    :fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = bid_modifier_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |modifier|
-        value = modifier[:bid_modifier] || 'unset'
-        puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d has ad group ' +
-           'level modifier: %s') %
-           [modifier[:campaign_id], modifier[:ad_group_id],
-            modifier[:criterion][:id], value]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    else
-      puts 'No ad group level bid overrides returned.'
-    end
-  end while page[:total_num_entries] > offset
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201601
-  PAGE_SIZE = 500
-
-  begin
-    # ID of a campaign to pull overrides for.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    get_ad_group_bid_modifiers(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/v201601/advanced_operations/use_shared_bidding_strategy.rb

@@ -1,147 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-
-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},
-      :advertising_channel_type => 'SEARCH',
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => 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},
-      :advertising_channel_type => 'DISPLAY',
-      :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 = :v201601
-
-  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  " +
-        '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