google-adx-buyer-api 0.2.0 → 0.4.0

data/examples/{v201101/get_all_experiments.rb → v201109/get_all_ad_groups.rb}

@@ -17,28 +17,33 @@
 #           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.
+# This example illustrates how to retrieve all the ad groups for a campaign. To
+# create an ad group, run add_ad_group.rb.
 #
-# Tags: ExperimentService.get
+# Tags: AdGroupService.get
 
 require 'rubygems'
 gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201109
 
-def get_all_experiments()
+def get_all_ad_groups()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
+
+  # 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)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
 
-  # Get all the experiments for this campaign.
+  # Get all the ad groups for this campaign.
   selector = {
-    :fields => ['Id', 'Name', 'ControlId', 'AdGroupsCount'],
+    :fields => ['Id', 'Name'],
     :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
     :predicates => [{
       :field => 'CampaignId',
@@ -46,31 +51,22 @@ def get_all_experiments()
       :values => [campaign_id]
     }]
   }
-  response = experiment_srv.get(selector)
-
+  response = ad_group_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"
+    ad_groups = response[:entries]
+    puts "Campaign ##{campaign_id} has #{ad_groups.length} ad group(s)."
+    ad_groups.each do |ad_group|
+      puts "  Ad group name is \"#{ad_group[:name]}\" and id is " +
+          "#{ad_group[:id]}."
     end
   else
-    puts "No experiments were found."
+    puts "No ad groups found for campaign ##{campaign_id}."
   end
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
-    get_all_experiments()
+    get_all_ad_groups()
 
   # Connection error. Likely transitory.
   rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e

data/examples/v201109/get_all_ads.rb

@@ -0,0 +1,99 @@
+#!/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 ads for an ad group. To add
+# ads to an existing ad group, run add_ads.rb.
+#
+# Tags: AdGroupAdService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_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 ads for this ad group.
+  selector = {
+    :fields => ['Id', 'Status'],
+    :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']
+      }
+    ]
+  }
+  response = ad_group_ad_srv.get(selector)
+  if response and response[:entries]
+    ads = response[:entries]
+    puts "Ad group ##{ad_group_id} has #{ads.length} ad(s)."
+    ads.each do |ad|
+      puts "  Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
+          "status is \"#{ad[:status]}\"."
+    end
+  else
+    puts "No ads found for ad group ##{ad_group_id}."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_ads()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201109/get_all_campaign_targets.rb

@@ -0,0 +1,83 @@
+#!/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 campaign targets. To set
+# campaign targets, run set_campaign_targets.rb.
+#
+# Tags: CampaignTargetService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_campaign_targets()
+  # 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_target_srv = adwords.service(:CampaignTargetService, API_VERSION)
+
+  # Get all the campaign targets for this account.
+  selector = {}
+  response = campaign_target_srv.get(selector)
+  if response and response[:entries]
+    targets = response[:entries]
+    targets.each do |target|
+      puts "Campaign target of type #{target[:xsi_type]} for campaign " +
+          "id #{target[:campaign_id]} was set."
+    end
+  else
+    puts "No campaign targets found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_campaign_targets()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

data/examples/v201109/get_all_campaigns.rb

@@ -0,0 +1,86 @@
+#!/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 campaigns for an account.
+#
+# Tags: CampaignService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_all_campaigns()
+  # 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; 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 name is \"#{campaign[:name]}\", id is #{campaign[:id]} " +
+          "and status is \"#{campaign[:status]}\"."
+    end
+  else
+    puts "No campaigns were found."
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_campaigns()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end

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,88 @@
+#!/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'
+gem 'google-adwords-api'
+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()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts 'API Exception caught.'
+    puts 'Message: %s' % e.message
+    puts 'Code: %d' % e.code if e.code
+    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts 'Errors:'
+    if e.errors
+      e.errors.each_with_index do |error, index|
+        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
+        error.each_pair do |field, value|
+          if field != :xsi_type
+            puts '     %s: %s' % [field, value]
+          end
+        end
+      end
+    end
+  end
+end