google-adx-buyer-api 0.4.5 → 0.4.6

data/examples/v201302/basic_operations/get_ad_groups.rb

@@ -0,0 +1,80 @@
+#!/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 retrieve all the ad groups for a campaign. To
+# create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupService.get
+
+require 'adwords_api'
+
+def get_all_ad_groups(campaign_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)
+
+  # Get all the ad groups for this campaign.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+    :predicates => [{
+      :field => 'CampaignId',
+      :operator => 'IN',
+      :values => [campaign_id]
+    }]
+  }
+  response = ad_group_srv.get(selector)
+  ad_groups = response[:entries]
+  puts "Campaign ID %d has %d ad group(s)." % [campaign_id, ad_groups.length]
+  ad_groups.each do |ad_group|
+    puts "\tAd group name is '%s' and ID is %d" %
+        [ad_group[:name], ad_group[:id]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    get_all_ad_groups(campaign_id)
+
+  # 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/v201302/basic_operations/get_campaigns.rb

@@ -0,0 +1,77 @@
+#!/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 retrieve all the campaigns for an account.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+
+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
+  API_VERSION = :v201302
+
+  begin
+    get_all_campaigns()
+
+  # 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/v201302/basic_operations/get_placements.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 retrieve all the placements for an ad group.
+# To add a placement to an existing ad group, run add_placements.rb.
+#
+# Tags: AdGroupCriterionService.get
+
+require 'adwords_api'
+
+def get_placements(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 the criteria for this ad group.
+  selector = {
+    :fields => ['Id', 'PlacementUrl'],
+    :ordering => [
+      {:field => 'AdGroupId', :sort_order => 'ASCENDING'}
+    ],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {
+        :field => 'CriteriaType',
+        :operator => 'EQUALS',
+        :values => ['PLACEMENT']
+      }
+    ]
+  }
+  response = ad_group_criterion_srv.get(selector)
+  if response and response[:entries]
+    ad_group_criteria = response[:entries]
+    puts "Ad group ID %d has %d placements." %
+        [ad_group_id, ad_group_criteria.length]
+    ad_group_criteria.each do |ad_group_criterion|
+      puts "\tPlacement ID is %d and URL is '%s'." %
+          [ad_group_criterion[:criterion][:id],
+           ad_group_criterion[:criterion][:placement_url]]
+    end
+  else
+    puts "No placements found for ad group ID %d" % ad_group_id
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_placements(ad_group_id)
+
+  # 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/v201302/basic_operations/get_thirdparty_redirect_ads.rb

@@ -0,0 +1,100 @@
+#!/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 third party redirect ads for an
+# ad group. To add third party redirect ad to an existing ad group, run
+# add_thirdparty_redirect_ad.rb.
+#
+# Tags: AdGroupAdService.get
+
+require 'adwords_api'
+
+def get_all_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)
+
+  # Create selector to get all third party redirect ads for this ad group.
+  selector = {
+    :fields => ['Id', 'Status', 'Url', 'DisplayUrl'],
+    :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 => ['THIRD_PARTY_REDIRECT_AD']
+      }
+    ]
+  }
+
+  # Request the ads.
+  response = ad_group_ad_srv.get(selector)
+  if response and response[:entries]
+    ads = response[:entries]
+    puts "Ad group ID %d has %d third party redirect ads." %
+        [ad_group_id, ads.length]
+    ads.each do |ad|
+      puts "\tAd ID is %d, type is '%s', status is '%s'" %
+          [ad[:ad][:id], ad[:ad][:xsi_type], ad[:status]]
+      puts "\tURL:         %s" % ad[:url]
+      puts "\tDisplay URL: %s" % ad[:display_url]
+    end
+  else
+    puts "No ads found for ad group ID %d." % ad_group_id
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_all_ads(ad_group_id)
+
+  # 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/v201302/basic_operations/pause_ad.rb

@@ -0,0 +1,81 @@
+#!/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 pause an ad, setting its status to 'PAUSED'.
+# To create ads, run add_thirdparty_redirect_ad.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 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])
+  ad = response[:value].first
+  puts "Ad ID %d was successfully updated, status set to '%s'." %
+      [ad[:ad][:id], ad[:status]]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    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)
+
+  # 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/v201302/basic_operations/update_ad_group.rb

@@ -0,0 +1,76 @@
+#!/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])
+  ad_group = response[:value].first
+  puts "Ad group ID %d was successfully updated." % ad_group[:id]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    update_ad_group(ad_group_id)
+
+  # 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