google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201101/get_all_active_ad_group_criteria.rb

@@ -1,106 +0,0 @@
-#!/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 active criteria for an ad
-# group. To add criteria to an existing ad group, run add_ad_group_criteria.rb.
-#
-# Tags: AdGroupCriterionService.get
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def get_all_active_ad_group_criteria()
-  # 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)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Get all the active criteria for this ad group
-  selector = {
-    :fields => ['Id'],
-    :ordering => [{
-      :field => 'AdGroupId',
-      :sort_order => 'ASCENDING'
-    }],
-    :predicates => [
-      {
-        :field => 'AdGroupId',
-        :operator => 'IN',
-        :values => [ad_group_id]
-      },
-      {
-        :field => 'Status',
-        :operator => 'IN',
-        :values => ['ACTIVE']
-      }
-    ]
-  }
-  response = ad_group_criterion_srv.get(selector)
-  if response and response[:entries]
-    ad_group_criteria = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} active " +
-        "criteria."
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "  Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
-          "type is #{ad_group_criterion[:criterion][:xsi_type]}."
-    end
-  else
-    puts "No active criteria found for ad group ##{ad_group_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_active_ad_group_criteria()
-
-  # 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/v201101/get_all_ad_group_criteria.rb

@@ -1,97 +0,0 @@
-#!/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 criteria for an ad group.
-# To add criteria to an existing ad group, run add_ad_group_criteria.rb.
-#
-# Tags: AdGroupCriterionService.get
-
-require 'rubygems'
-gem 'google-adwords-api'
-require 'adwords_api'
-
-API_VERSION = :v201101
-def get_all_ad_group_criteria()
-  # 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)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Get all the criteria for this ad group.
-  selector = {
-    :fields => ['Id'],
-    :ordering => [{
-      :field => 'AdGroupId',
-      :sort_order => 'ASCENDING'
-    }],
-    :predicates => [{
-      :field => 'AdGroupId',
-      :operator => 'IN',
-      :values => [ad_group_id]
-    }]
-  }
-  response = ad_group_criterion_srv.get(selector)
-  if response and response[:entries]
-    ad_group_criteria = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} criteria."
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "  Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
-          "type is #{ad_group_criterion[:criterion][:xsi_type]}."
-    end
-  else
-    puts "No criteria found for ad group ##{ad_group_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_group_criteria()
-
-  # 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/v201101/get_all_ads.rb

@@ -1,99 +0,0 @@
-#!/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 = :v201101
-
-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/v201101/get_all_campaign_targets.rb

@@ -1,83 +0,0 @@
-#!/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 = :v201101
-
-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/v201101/get_all_conversions.rb

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