google-adwords-api 0.9.2 → 0.9.3

data/examples/v201306/basic_operations/get_campaigns_with_awql.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 retrieve all the campaigns for an account with
+# AWQL.
+#
+# Tags: CampaignService.query
+
+require 'adwords_api'
+
+def get_campaigns_with_awql()
+  # 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_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Get all the campaigns for this account.
+  query = 'SELECT Id, Name, Status ORDER BY Name'
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page_query = query + ' LIMIT %d,%d' % [offset, PAGE_SIZE]
+    page = campaign_srv.query(page_query)
+    if page[:entries]
+      page[:entries].each do |campaign|
+        puts "Campaign ID %d, name '%s' and status '%s'" %
+            [campaign[:id], campaign[:name], campaign[:status]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tTotal number of campaigns found: %d." % page[:total_num_entries]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+  PAGE_SIZE = 500
+
+  begin
+    get_campaigns_with_awql()
+
+  # 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  " +
+        'http://code.google.com/p/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/v201306/basic_operations/get_keywords.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 keywords for an ad group. To add
+# keywords to an existing ad group, run add_keywords.rb.
+#
+# Tags: AdGroupCriterionService.get
+
+require 'adwords_api'
+
+def get_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)
+
+  # Get all keywords for this ad group.
+  selector = {
+    :fields => ['Id', 'CriteriaType', 'KeywordText'],
+    :ordering => [
+      {:field => 'Id', :sort_order => 'ASCENDING'}
+    ],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'EQUALS', :values => [ad_group_id]},
+      {:field => 'CriteriaType', :operator => 'EQUALS', :values => ['KEYWORD']}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = ad_group_criterion_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |keyword|
+        puts "Keyword ID %d, type '%s' and text '%s'" %
+            [keyword[:criterion][:id],
+             keyword[:criterion][:type],
+             keyword[:criterion][:text]]
+      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 "\tAd group ID %d has %d keyword(s)." %
+        [ad_group_id, page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+  PAGE_SIZE = 500
+
+  begin
+    # Ad group ID to get keywords for.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_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  " +
+        'http://code.google.com/p/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/v201306/basic_operations/get_text_ads.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 text ads for an ad group. To add
+# ads to an existing ad group, run add_text_ads.rb.
+#
+# Tags: AdGroupAdService.get
+
+require 'adwords_api'
+
+def get_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)
+
+  # Get all the ads for this ad group.
+  selector = {
+    :fields => ['Id', 'Status', 'AdType'],
+    :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
+    # By default, disabled ads aren't returned by the selector. To return them,
+    # include the DISABLED status in a predicate.
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {:field => 'Status',
+       :operator => 'IN',
+       :values => ['ENABLED', 'PAUSED', 'DISABLED']},
+      {:field => 'AdType',
+       :operator => 'EQUALS',
+       :values => ['TEXT_AD']}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = ad_group_ad_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |ad|
+        puts "Ad ID is %d, type is '%s' and status is '%s'" %
+            [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
+      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 "\tAd group ID %d has %d ad(s)." %
+        [ad_group_id, page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+  PAGE_SIZE = 500
+
+  begin
+    # Ad group ID to get text ads for.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_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  " +
+        'http://code.google.com/p/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/v201306/basic_operations/pause_ad.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 update an ad, setting its status to 'PAUSED'.
+# To create ads, run add_text_ads.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def pause_ad(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)
+
+  # Prepare operation for updating ad.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :status => 'PAUSED',
+      :ad => {:id => ad_id}
+    }
+  }
+
+  # Update ad.
+  response = ad_group_ad_srv.mutate([operation])
+  if response and response[:value]
+    ad = response[:value].first
+    puts "Ad ID %d was successfully updated, status set to '%s'." %
+        [ad[:ad][:id], ad[:status]]
+  else
+    puts 'No ads were updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+
+  begin
+    # IDs of ad to pause and its ad group.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    ad_id = 'INSERT_AD_ID_HERE'.to_i
+    pause_ad(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  " +
+        'http://code.google.com/p/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/v201306/basic_operations/update_ad_group.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 update an ad group, setting its status to
+# 'PAUSED'. To create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'adwords_api'
+
+def update_ad_group(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_srv = adwords.service(:AdGroupService, API_VERSION)
+
+  # Prepare for updating ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :status => 'PAUSED',
+      :id => ad_group_id
+    }
+  }
+
+  # Update ad group.
+  response = ad_group_srv.mutate([operation])
+  if response and response[:value]
+    ad_group = response[:value].first
+    puts 'Ad group id %d was successfully updated.' % ad_group[:id]
+  else
+    puts 'No ad groups were updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+
+  begin
+    # ID of an ad group to update.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    update_ad_group(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  " +
+        'http://code.google.com/p/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