google-adwords-api 0.14.2 → 0.15.0

data/examples/v201406/basic_operations/pause_ad.rb

@@ -1,92 +0,0 @@
-#!/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 update an ad, setting its status to 'PAUSED'.
-# To create ads, run add_text_ads.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 operation 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])
-  if response and response[:value]
-    ad = response[:value].first
-    puts "Ad ID %d was successfully updated, status set to '%s'." %
-        [ad[:ad][:id], ad[:status]]
-  else
-    puts 'No ads were updated.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201406
-
-  begin
-    # IDs of ad to pause and its ad group.
-    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)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201406/basic_operations/remove_ad.rb

@@ -1,93 +0,0 @@
-#!/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 removes an ad using the 'REMOVE' operator. To get ads, run
-# get_text_ads.rb.
-#
-# Tags: AdGroupAdService.mutate
-
-require 'adwords_api'
-
-def remove_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 deleting ad.
-  operation = {
-    :operator => 'REMOVE',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        :xsi_type => 'Ad',
-        :id => ad_id
-      }
-    }
-  }
-
-  # Remove ad.
-  response = ad_group_ad_srv.mutate([operation])
-  if response and response[:value]
-    ad = response[:value].first
-    puts "Ad ID %d was successfully removed." % ad[:ad][:id]
-  else
-    puts 'No ads were removed.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201406
-
-  begin
-    # IDs of an ad to remove and its ad group.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    ad_id = 'INSERT_AD_ID_HERE'.to_i
-    remove_ad(ad_group_id, ad_id)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201406/basic_operations/remove_ad_group.rb

@@ -1,89 +0,0 @@
-#!/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 removes an ad group by setting the status to 'REMOVED'. To get ad
-# groups, run get_ad_groups.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'adwords_api'
-
-def remove_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 deleting ad group.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => ad_group_id,
-      :status => 'REMOVED'
-    }
-  }
-
-  # Remove 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 removed." % [ad_group[:id]]
-  else
-    puts 'No ad group was updated.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201406
-
-  begin
-    # ID of an ad group to remove.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    remove_ad_group(ad_group_id)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201406/basic_operations/remove_campaign.rb

@@ -1,91 +0,0 @@
-#!/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 removes a campaign by setting the status to 'REMOVED'. To get
-# campaigns, run get_campaigns.rb.
-#
-# Tags: CampaignService.mutate
-
-require 'adwords_api'
-
-def remove_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)
-
-   # Prepare for deleting campaign.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => campaign_id,
-     :status => 'REMOVED'
-    }
-  }
-
-  # Remove campaign.
-  response = campaign_srv.mutate([operation])
-
-  if response and response[:value]
-    campaign = response[:value].first
-    puts "Campaign ID %d was removed." %
-        [campaign[:id]]
-  else
-    puts 'No campaign was updated.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201406
-
-  begin
-    # ID of a campaign to remove.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-    remove_campaign(campaign_id)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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/v201406/basic_operations/remove_keyword.rb

@@ -1,98 +0,0 @@
-#!/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 removes a keyword using the 'REMOVE' operator. To get list of
-# keywords, run get_keywords.rb.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'adwords_api'
-
-def remove_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
-      }
-    }
-  }
-
-  # Remove keyword.
-  response = ad_group_criterion_srv.mutate([operation])
-  ad_group_criterion = response[:value].first
-  if ad_group_criterion
-    puts "Keyword ID %d was successfully removed." %
-        ad_group_criterion[:criterion][:id]
-  else
-    puts 'No keywords were removed.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201406
-
-  begin
-    # IDs of criterion to remove and its ad group.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-    remove_keyword(ad_group_id, criterion_id)
-
-  # Authorization error.
-  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
-        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
-        "to retrieve and store OAuth2 tokens."
-    puts "See this wiki page for more details:\n\n  " +
-        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
-
-  # 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