google-adwords-api 0.8.1 → 0.8.2

data/examples/v201302/basic_operations/delete_ad_group.rb

@@ -0,0 +1,102 @@
+#!/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 deletes an ad group by setting the status to 'DELETED'. To get ad
+# groups, run get_ad_groups.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'adwords_api'
+
+def delete_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)
+
+  # Retrieve the ad group to obtain its name. This is optional but recommended
+  # to keep deleted objects searchable. In production the name is already known
+  # in most cases.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :predicates => [
+      {:field => 'Id', :operator => 'EQUALS', :values => [ad_group_id]}
+    ]
+  }
+  result = ad_group_srv.get(selector)
+
+  if result.nil? or result[:entries].empty?
+    raise StandardError, "Ad group with ID %d was not found." % ad_group_id
+  end
+
+  # We recommend renaming object on delete to avoid name conflicts later.
+  ad_group_name = result[:entries].first[:name]
+  ad_group_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
+
+  # Prepare for deleting ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => ad_group_id,
+      :name => ad_group_name,
+      :status => 'DELETED'
+    }
+  }
+
+  # Delete 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 deleted and renamed to '%s'." %
+       [ad_group[:id], ad_group[:name]]
+  else
+    puts 'No ad group was updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    # ID of an ad group to delete.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    delete_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

data/examples/v201302/basic_operations/delete_campaign.rb

@@ -0,0 +1,103 @@
+#!/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 deletes a campaign by setting the status to 'DELETED'. To get
+# campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignService.mutate
+
+require 'adwords_api'
+
+def delete_campaign(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')
+
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Retrieve the campaign to obtain its name. This is optional but recommended
+  # to keep deleted objects searchable. In production the name is already known
+  # in most cases.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :predicates => [
+      {:field => 'Id', :operator => 'EQUALS', :values => [campaign_id]}
+    ]
+  }
+  result = campaign_srv.get(selector)
+
+  if result.nil? or result[:entries].empty?
+    raise StandardError, "Campaign with ID %d was not found." % campaign_id
+  end
+
+  # We recommend renaming object on delete to avoid name conflicts later.
+  campaign_name = result[:entries].first[:name]
+  campaign_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
+
+  # Prepare for deleting campaign.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => campaign_id,
+      :name => campaign_name,
+      :status => 'DELETED',
+    }
+  }
+
+  # Delete campaign.
+  response = campaign_srv.mutate([operation])
+
+  if response and response[:value]
+    campaign = response[:value].first
+    puts "Campaign ID %d was renamed to '%s' and deleted." %
+        [campaign[:id], campaign[:name]]
+  else
+    puts 'No campaign was updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    # ID of a campaign to delete.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    delete_campaign(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/delete_keyword.rb

@@ -0,0 +1,90 @@
+#!/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 deletes a keyword using the 'REMOVE' operator. To get list of
+# keywords, run get_keywords.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'adwords_api'
+
+def delete_keyword(ad_group_id, criterion_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)
+
+  # Prepare for deleting keyword.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      # The 'xsi_type' field allows you to specify the xsi:type of the object
+      # being created. It's only necessary when you must provide an explicit
+      # type that the client library can't infer.
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :id => criterion_id
+      }
+    }
+  }
+
+  # Delete keyword.
+  response = ad_group_criterion_srv.mutate([operation])
+  ad_group_criterion = response[:value].first
+  if ad_group_criterion
+    puts "Keyword ID %d was successfully deleted." %
+        ad_group_criterion[:criterion][:id]
+  else
+    puts 'No keywords were deleted.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+
+  begin
+    # IDs of criterion to delete and its ad group.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    delete_keyword(ad_group_id, criterion_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_ad_groups.rb

@@ -0,0 +1,98 @@
+#!/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 ad groups for a campaign. To
+# create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupService.get
+
+require 'adwords_api'
+
+def get_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]}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = ad_group_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |ad_group|
+        puts "Ad group name is '%s' and ID is %d" %
+            [ad_group[:name], ad_group[:id]]
+      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 "\tCampaign ID %d has %d ad group(s)." %
+        [campaign_id, page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    # Campaign ID to get ad groups for.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    get_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,93 @@
+#!/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 campaigns for an account.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+
+def get_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.
+  selector = {
+    :fields => ['Id', 'Name', 'Status'],
+    :ordering => [
+      {:field => 'Name', :sort_order => 'ASCENDING'}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_srv.get(selector)
+    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
+      selector[:paging][:start_index] = offset
+    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 = :v201302
+  PAGE_SIZE = 500
+
+  begin
+    get_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