google-adwords-api 0.4.0 → 0.4.1

data/examples/v201109/get_all_carriers.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby
+#
+# 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 carriers available for targeting.
+#
+# Tags: ConstantDataService.getCarrierCriterion
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_carriers()
+  # 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')
+
+  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
+
+  # Get all carriers from ConstantDataService.
+  carriers = constant_data_srv.get_carrier_criterion()
+
+  if carriers
+    carriers.each do |carrier|
+      puts "Carrier name is '%s', ID is %d and country code is '%s'." %
+          [carrier[:name], carrier[:id], carrier[:country_code]]
+    end
+  else
+    puts 'No carriers were retrieved.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_carriers()
+
+  # 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/v201109/get_all_conversions.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby
+#
+# 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 gets all conversions in the account. To add conversions, run
+# add_conversion.rb.
+#
+# Tags: ConversionTrackerService.get
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_conversions()
+  # 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')
+
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  # Get all conversions.
+  selector = {
+    :fields => ['Id', 'Name', 'Status', 'Category'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+  }
+  response = conv_tracker_srv.get(selector)
+  if response and response[:entries]
+    conversions = response[:entries]
+    puts "#{conversions.length} conversions(s) found."
+    conversions.each do |conversion|
+      puts "  Conversion with id \"#{conversion[:id]}\", status \"" +
+          "#{conversion[:status]}\" and category \"#{conversion[:category]}\"" +
+          " was found. Code snippet: \n#{conversion[:snippet]}\n"
+    end
+  else
+    puts "No conversions found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_conversions()
+
+  # 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/v201109/get_all_disapproved_ads.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/ruby
+#
+# 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 retrieve all the disapproved ads in a given
+# ad group. To add ads, run add_ads.rb.
+#
+# Tags: AdGroupAdService.get
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_disapproved_ads()
+  # 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)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+  # Get all the disapproved ads for this campaign.
+  selector = {
+    :fields => ['Id', 'DisapprovalReasons'],
+    :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {
+        :field => 'CreativeApprovalStatus',
+        :operator => 'IN',
+        :values => ['DISAPPROVED']
+      }
+    ]
+  }
+  response = ad_group_ad_srv.get(selector)
+  if response and response[:entries]
+    ad_group_ads = response[:entries]
+    puts "Ad group ##{ad_group_id} has #{ad_group_ads.length} " +
+        "disapproved ad(s)."
+    ad_group_ads.each do |ad_group_ad|
+      puts "  Ad with id #{ad_group_ad[:ad][:id]} and type " +
+          "#{ad_group_ad[:ad][:xsi_type]} was disapproved for the following " +
+          "reasons:"
+      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
+        puts "    #{reason}"
+      end
+    end
+  else
+    puts "No disapproved ads found for ad group ##{ad_group_id}."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_disapproved_ads()
+
+  # 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/v201109/get_all_experiments.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby
+#
+# 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 gets all experiments in a campaign. To add an experiment, run
+# add_experiment.rb. To get campaigns, run get_all_campaigns.rb.
+#
+# Tags: ExperimentService.get
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_experiments()
+  # 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')
+
+  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Get all the experiments for this campaign.
+  selector = {
+    :fields => ['Id', 'Name', 'ControlId', 'AdGroupsCount'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+    :predicates => [{
+      :field => 'CampaignId',
+      :operator => 'IN',
+      :values => [campaign_id]
+    }]
+  }
+  response = experiment_srv.get(selector)
+
+  if response and response[:entries]
+    experiments = response[:entries]
+    experiments.each do |experiment|
+      experiment_stats = experiment[:experiment_summary_stats]
+      puts "Experiment with name \"#{experiment[:name]}\", " +
+          "id #{experiment[:id]} and control id " +
+          "#{experiment[:control_id]} was found and it includes " +
+          "#{experiment_stats[:ad_groups_count]} ad group(s) and " +
+          "#{experiment_stats[:ad_group_criteria_count]} criteria.\n"
+    end
+  else
+    puts "No experiments were found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_experiments()
+
+  # 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/v201109/get_all_images.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/ruby
+#
+# 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 retrieve all images. To upload an image, run
+# upload_image.rb.
+#
+# Tags: MediaService.get
+
+require 'rubygems'
+require 'adwords_api'
+require 'adwords_api/utils'
+
+API_VERSION = :v201109
+
+def get_all_images()
+  # 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.
+  selector = {
+    :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
+    :ordering => [{:field => 'MediaId', :sort_order => 'ASCENDING'}],
+    :predicates => [{:field => 'Type', :operator => 'IN', :values => ['IMAGE']}]
+  }
+  response = media_srv.get(selector)
+  if response and response[:entries]
+    images = response[:entries]
+    puts "#{images.length} images(s) found."
+    images.each do |image|
+      dimensions = AdwordsApi::Utils.map(image[:dimensions])
+      puts "  Image id is #{image[:media_id]}, dimensions are " +
+          "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
+          "and MIME type is \"#{image[:mime_type]}\"."
+    end
+  else
+    puts "No images found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_images()
+
+  # 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/v201109/get_all_languages.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby
+#
+# 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 languages available for
+# targeting.
+#
+# Tags: ConstantDataService.getLanguageCriterion
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_languages()
+  # 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')
+
+  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
+
+  # Get all languages from ConstantDataService.
+  languages = constant_data_srv.get_language_criterion()
+
+  if languages
+    languages.each do |language|
+      puts "Language name is '%s', ID is %d and code is '%s'." %
+          [language[:name], language[:id], language[:code]]
+    end
+  else
+    puts "No languages were found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_languages()
+
+  # 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