google-adwords-api 0.21.1 → 0.22.0

data/examples/v201603/misc/use_oauth2_jwt.rb

@@ -1,93 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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.
-#
-# This example illustrates how to use OAuth2 authentication method with
-# Service Account (JWT). For this example to work, your Service Account must be
-# a Google Apps for Business Account.
-#
-# See https://developers.google.com/adwords/api/docs/guides/service-accounts
-# for more information.
-
-require 'adwords_api'
-
-def use_oauth2_jwt()
-  # 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')
-
-  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
-  #           configuration file. No additional code is necessary.
-  # To provide a file name at runtime, use authorize:
-  # adwords.authorize({:oauth2_keyfile => key_filename})
-
-  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
-  # key_filename = 'INSERT_FILENAME_HERE'
-  # key_secret = 'INSERT_SECRET_HERE'
-  # key_file_data = File.read(key_filename)
-  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
-  # adwords.authorize({:oauth2_key => key})
-
-  # Now you can make API calls.
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Get all the campaigns for this account; empty selector.
-  selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [
-      {:field => 'Name', :sort_order => 'ASCENDING'}
-    ]
-  }
-
-  response = campaign_srv.get(selector)
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaigns.each do |campaign|
-      puts "Campaign ID %d, name '%s' and status '%s'" %
-          [campaign[:id], campaign[:name], campaign[:status]]
-    end
-  else
-    puts 'No campaigns were found.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    use_oauth2_jwt()
-
-  # 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/misc/use_runtime_config.rb

@@ -1,92 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2014, 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 make AdWords queries without using the
-# adwords_api.yml file.
-
-require 'adwords_api'
-require 'date'
-
-def use_runtime_config(client_id, client_secret, refresh_token,
-        developer_token, client_customer_id, user_agent)
-  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
-  # when called without parameters.
-  adwords = AdwordsApi::Api.new({
-    :authentication => {
-      :method => 'OAuth2',
-      :oauth2_client_id => client_id,
-      :oauth2_client_secret => client_secret,
-      :developer_token => developer_token,
-      :client_customer_id => client_customer_id,
-      :user_agent => user_agent,
-      :oauth2_token => {
-        :refresh_token => refresh_token
-      }
-    },
-    :service => {
-      :environment => 'PRODUCTION'
-    }
-  })
-
-  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
-  # the hash above or provide your own logger:
-  # adwords.logger = Logger.new('adwords_xml.log')
-
-  customer_srv = adwords.service(:CustomerService, API_VERSION)
-  customer = customer_srv.get()
-  puts "You are logged in as customer: %d" % customer[:id]
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    client_id = 'INSERT_CLIENT_ID_HERE'
-    client_secret = 'INSERT_CLIENT_SECRET_HERE'
-    refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
-    developer_token = 'INSERT_DEVELOPER_TOKEN_HERE'
-    client_customer_id = 'INSERT_CLIENT_CUSTOMER_ID_HERE'
-    user_agent = 'INSERT_USER_AGENT_HERE'
-
-    use_runtime_config(client_id, client_secret, refresh_token,
-        developer_token, client_customer_id, user_agent)
-
-  # 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/optimization/estimate_keyword_traffic.rb

@@ -1,146 +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 gets keyword traffic estimates.
-
-require 'adwords_api'
-
-def estimate_keyword_traffic()
-  # 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')
-
-  traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
-
-  # Create keywords. Up to 2000 keywords can be passed in a single request.
-  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.
-    {:xsi_type => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
-    {:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
-    {:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
-    {:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
-  ]
-
-  # Create a keyword estimate request for each keyword.
-  keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
-
-  # Negative keywords don't return estimates, but adjust the estimates of the
-  # other keywords in the hypothetical ad group. To specify a negative keyword
-  # set the is_negative field to true.
-  keyword_requests[3][:is_negative] = true
-
-  # Create ad group estimate requests.
-  ad_group_request = {
-      :keyword_estimate_requests => keyword_requests,
-      :max_cpc => {
-          :micro_amount => 1000000
-      }
-  }
-
-  # Create campaign estimate requests.
-  campaign_request = {
-      :ad_group_estimate_requests => [ad_group_request],
-      # Set targeting criteria. Only locations and languages are supported.
-      :criteria => [
-          {:xsi_type => 'Location', :id => 2840}, # United States
-          {:xsi_type => 'Language', :id => 1000}  # English
-      ]
-  }
-
-  # Create selector and retrieve reults.
-  selector = {:campaign_estimate_requests => [campaign_request]}
-  response = traffic_estimator_srv.get(selector)
-
-  if response and response[:campaign_estimates]
-    campaign_estimates = response[:campaign_estimates]
-    keyword_estimates =
-        campaign_estimates.first[:ad_group_estimates].first[:keyword_estimates]
-    keyword_estimates.each_with_index do |estimate, index|
-      keyword = keyword_requests[index][:keyword]
-
-      # Find the mean of the min and max values.
-      mean_avg_position = calculate_mean(
-          estimate[:min][:average_position],
-          estimate[:max][:average_position]
-      )
-      mean_clicks = calculate_mean(
-          estimate[:min][:clicks_per_day],
-          estimate[:max][:clicks_per_day]
-      )
-      mean_total_cost = calculate_mean(
-          estimate[:min][:total_cost][:micro_amount],
-          estimate[:max][:total_cost][:micro_amount]
-      )
-
-      puts "Results for the keyword with text '%s' and match type %s:" %
-          [keyword[:text], keyword[:match_type]]
-      puts "\tEstimated ad position: %s" % format_mean(mean_avg_position)
-      puts "\tEstimated daily clicks: %s" % format_mean(mean_clicks)
-      puts "\tEstimated daily cost: %s" % format_mean(mean_total_cost)
-    end
-  else
-    puts 'No traffic estimates were returned.'
-  end
-end
-
-def format_mean(mean)
-  return "nil" if mean.nil?
-  return "%.2f" % mean
-end
-
-def calculate_mean(min_money, max_money)
-  return nil if min_money.nil? || max_money.nil?
-  return (min_money.to_f + max_money.to_f) / 2.0
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-
-  begin
-    estimate_keyword_traffic()
-
-  # 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/optimization/get_campaign_criterion_bid_modifier_simulations.rb

@@ -1,128 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2016, 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 gets all available campaign criterion bid modifier landscapes
-# for a given campaign.
-# To get campaigns, run basic_operations/get_campaigns.rb.
-
-require 'adwords_api'
-
-def get_campaign_criterion_bid_modifier_simulations(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')
-
-  data_srv = adwords.service(:DataService, API_VERSION)
-
-  # Get all the campaigns for this account.
-  selector = {
-    :fields => [
-      'CampaignId',
-      'CriterionId',
-      'StartDate',
-      'EndDate',
-      'BidModifier',
-      'LocalClicks',
-      'LocalCost',
-      'LocalImpressions',
-      'TotalLocalImpressions',
-      'TotalLocalClicks',
-      'TotalLocalCost',
-      'RequiredBudget'
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = data_srv.get_campaign_criterion_bid_landscape(selector)
-    if page[:entries]
-      page[:entries].each do |bid_modifier_landscape|
-        puts ("Found campaign-level criterion bid modifier landscapes for " +
-            "criterion with id '%d', start date '%s', end date '%s', and " +
-            "landscape points:") % [
-              bid_modifier_landscape[:criterion_id],
-              bid_modifier_landscape[:start_date],
-              bid_modifier_landscape[:end_date]
-            ]
-        bid_modifier_landscape[:landscape_points].each do |landscape_point|
-          puts ("  bid modifier: %f => clicks: %d, cost: %d, impressions: %d" +
-              " total clicks: %d, total cost: %d, total impressions: %d" +
-              " and required budget: %f") % [
-                landscape_point[:bid_modifier],
-                landscape_point[:clicks],
-                landscape_point[:cost][:micro_amount],
-                landscape_point[:impressions],
-                landscape_point[:total_local_clicks],
-                landscape_point[:total_local_cost][:micro_amount],
-                landscape_point[:total_local_impressions],
-                landscape_point[:required_budget][:micro_amount]
-              ]
-        end
-        puts
-      end
-
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    end
-  end while page[:total_num_entries] > offset
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201603
-  PAGE_SIZE = 500
-
-  begin
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    get_campaign_criterion_bid_modifier_simulations(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