google-adwords-api 0.18.0 → 0.18.1

data/examples/v201601/migration/upgrade_ad_url.rb

@@ -0,0 +1,93 @@
+#!/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 code example upgrades an ad to use upgraded URLs.
+
+require 'adwords_api'
+
+def upgrade_ad_url(ad_group_id, ad_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)
+
+  selector = {
+    :fields => ['Id', 'Url'],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'EQUALS', :values => [ad_group_id]},
+      {:field => 'Id', :operator => 'EQUALS', :values => [ad_id]}
+    ]
+  }
+
+  page = ad_group_ad_srv.get(selector)
+  ad_group_ad = page[:entries][0] if page[:entries]
+
+  raise StandardError, "Ad not found." if ad_group_ad.nil?
+
+  ad_url_upgrade = {
+    :ad_id => ad_group_ad[:ad][:id],
+    :final_url => ad_group_ad[:ad][:url]
+  }
+
+  response = ad_group_ad_srv.upgrade_url([ad_url_upgrade])
+  if response
+    ad_group_ad = response.first
+    puts "Ad with ID %d and destination url '%s' was upgraded." %
+        [ad_group_ad[:id], ad_group_ad[:final_urls].first]
+  else
+    raise StandardError, 'failed to upgrade ads.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    ad_id = 'INSERT_AD_ID_HERE'.to_i
+    upgrade_ad_url(ad_group_id, ad_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/misc/get_all_images_and_videos.rb

@@ -0,0 +1,104 @@
+#!/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 retrieve all images and videos. To upload an
+# image, run upload_image.rb. To upload video, see:
+#   http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454.
+
+require 'adwords_api'
+
+def get_all_images_and_videos()
+  # 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)
+
+  # Get all the images and videos.
+  selector = {
+    :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
+    :ordering => [
+      {:field => 'MediaId', :sort_order => 'ASCENDING'}
+    ],
+    :predicates => [
+      {:field => 'Type', :operator => 'IN', :values => ['IMAGE', 'VIDEO']}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = media_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |entry|
+        full_dimensions = entry[:dimensions]['FULL']
+        puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tFound %d entries." % page[:total_num_entries]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+  PAGE_SIZE = 500
+
+  begin
+    get_all_images_and_videos()
+
+  # 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/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.0 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 = :v201601
+
+  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/v201601/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 = :v201601
+
+  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/v201601/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 = :v201601
+
+  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