google-adwords-api 0.21.0 → 0.21.1

data/examples/v201609/misc/setup_oauth2.rb

@@ -0,0 +1,84 @@
+#!/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 set up OAuth2 authentication credentials.
+
+require 'adwords_api'
+
+def setup_oauth2()
+  # 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')
+
+  # You can call authorize explicitly to obtain the access token. Otherwise, it
+  # will be invoked automatically on the first API call.
+  # There are two ways to provide verification code, first one is via the block:
+  token = adwords.authorize() do |auth_url|
+    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
+    print 'log in and type the verification code: '
+    verification_code = gets.chomp
+    verification_code
+  end
+  if token
+    print "\nWould you like to update your adwords_api.yml to save " +
+        "OAuth2 credentials? (y/N): "
+    response = gets.chomp
+    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
+      adwords.save_oauth2_token(token)
+      puts 'OAuth2 token is now saved to ~/adwords_api.yml and will be ' +
+          'automatically used by the library.'
+    end
+  end
+
+  # Alternatively, you can provide one within the parameters:
+  # token = adwords.authorize({:oauth2_verification_code => verification_code})
+
+  # Note, 'token' is a Hash. Its value is not used in this example. If you need
+  # to be able to access the API in offline mode, with no user present, you
+  # should persist it to be used in subsequent invocations like this:
+  # adwords.authorize({:oauth2_token => token})
+
+  # No exception thrown - we are good to make a request.
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201609
+
+  begin
+    setup_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/v201609/misc/upload_image.rb

@@ -0,0 +1,93 @@
+#!/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 uploads an image. To get images, run get_all_images.rb.
+
+require 'adwords_api'
+require 'base64'
+
+def upload_image()
+  # 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')
+
+  media_srv = adwords.service(:MediaService, API_VERSION)
+
+  # Create image.
+  image_url =
+      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
+  # This utility method retrieves the contents of a URL using all of the config
+  # options provided to the Api object.
+  image_data = AdsCommon::Http.get(image_url, adwords.config)
+  base64_image_data = Base64.encode64(image_data)
+  image = {
+    # 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 => 'Image',
+    :data => base64_image_data,
+    :type => 'IMAGE'
+  }
+
+  # Upload image.
+  response = media_srv.upload([image])
+  if response and !response.empty?
+    ret_image = response.first
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
+  else
+    puts 'No images uploaded.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201609
+
+  begin
+    upload_image()
+
+  # 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/v201609/misc/upload_media_bundle.rb

@@ -0,0 +1,90 @@
+#!/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 uploads an HTML5 zip file.
+
+require 'adwords_api'
+require 'base64'
+
+def upload_media_bundle()
+  # 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')
+
+  media_srv = adwords.service(:MediaService, API_VERSION)
+
+  # Create HTML5 media.
+  html5_url = 'https://goo.gl/9Y7qI2'
+  # This utility method retrieves the contents of a URL using all of the config
+  # options provided to the Api object.
+  html5_data = AdsCommon::Http.get(html5_url, adwords.config)
+  base64_html5_data = Base64.encode64(html5_data)
+  media_bundle = {
+    :xsi_type => 'MediaBundle',
+    :data => base64_html5_data,
+    :type => 'MEDIA_BUNDLE'
+  }
+
+  # Upload HTML5 zip.
+  response = media_srv.upload([media_bundle])
+  if response and !response.empty?
+    ret_html5 = response.first
+    full_dimensions = ret_html5[:dimensions]['FULL']
+    puts ("HTML5 media with ID %d, dimensions %dx%d and MIME type '%s' " +
+        "uploaded successfully.") % [ret_html5[:media_id],
+        full_dimensions[:height], full_dimensions[:width],
+        ret_html5[:mime_type]]
+  else
+    puts 'No HTML5 zip was uploaded.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201609
+
+  begin
+    upload_media_bundle()
+
+  # 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/v201609/misc/use_oauth2_jwt.rb

@@ -0,0 +1,93 @@
+#!/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 = :v201609
+
+  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/v201609/misc/use_runtime_config.rb

@@ -0,0 +1,92 @@
+#!/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 = :v201609
+
+  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