google-adwords-api 0.4.5 → 0.5.0

data/examples/v201008/delete_ad_group.rb

@@ -1,77 +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 deletes an ad group by setting the status to 'DELETED'.
-# To get ad groups, run get_all_ad_groups.rb.
-#
-# Tags: AdGroupService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_ad_group()
-  # 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)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Prepare for deleting ad group.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :status => 'DELETED',
-      :id => ad_group_id
-    }
-  }
-
-  # Delete ad group.
-  response = ad_group_srv.mutate([operation])
-  ad_group = response[:value].first
-  puts 'Ad group id %d was successfully deleted.' % ad_group[:id]
-end
-
-if __FILE__ == $0
-  begin
-    delete_ad_group()
-
-  # 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/v201008/delete_ad_group_criterion.rb

@@ -1,86 +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 deletes an ad group criterion using the 'REMOVE' operator. To
-# get ad group criteria, run get_all_ad_group_criteria.rb.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_ad_group_criterion()
-  # 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
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Prepare for deleting ad group criterion.
-  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 criterion.
-  response = ad_group_criterion_srv.mutate([operation])
-  ad_group_criterion = response[:value].first
-  puts 'Criterion id %d was successfully deleted.' %
-      ad_group_criterion[:criterion][:id]
-end
-
-if __FILE__ == $0
-  begin
-    delete_ad_group_criterion()
-
-  # 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/v201008/delete_bulk_mutate_job.rb

@@ -1,87 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: sgomes@google.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 deletes a bulk mutate job using the 'REMOVE' operator. Jobs may
-# only deleted if they are in the 'PENDING' state and have not yet recieved
-# all of their request parts. To get bulk mutate jobs, run
-# get_all_bulk_mutate_jobs.rb.
-#
-# Tags: BulkMutateJobService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_bulk_mutate_job()
-  # 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')
-
-  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
-
-  job_id = 'INSERT_BULK_MUTATE_JOB_ID_HERE'
-
-  # Create operation.
-  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 => 'BulkMutateJob',
-      :id => job_id
-    }
-  }
-
-  # Delete job.
-  response = bulk_mutate_job_srv.mutate(operation)
-  if response and response[:value]
-    job = response[:value].first
-    puts 'Job id %d was successfully deleted.' % job[:id]
-  else
-    puts 'No jobs were deleted.'
-  end
-
-end
-
-if __FILE__ == $0
-  begin
-    delete_bulk_mutate_job()
-
-  # 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/v201008/delete_campaign.rb

@@ -1,78 +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 deletes a campaign by setting the status to 'DELETED'. To get
-# campaigns, run get_all_campaigns.rb.
-#
-# Tags: CampaignService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_campaign()
-  # 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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Prepare for deleting campaign.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => campaign_id,
-      :status => 'DELETED',
-    }
-  }
-
-  # Delete campaign.
-  response = campaign_srv.mutate([operation])
-  campaign = response[:value].first
-  puts 'Campaign with name "%s" and id %d was deleted.' %
-      [campaign[:name], campaign[:id]]
-end
-
-if __FILE__ == $0
-  begin
-    delete_campaign()
-
-  # 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/v201008/delete_experiment.rb

@@ -1,78 +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 deletes an experiment. To get experiments, run
-# get_all_experiments.rb. To add an experiment, run add_experiment.rb.
-#
-# Tags: ExperimentService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_experiment()
-  # 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')
-
-  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
-
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
-
-  # Prepare for deleting experiment.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => experiment_id,
-      :status => 'DELETED'
-    }
-  }
-
-  # Delete experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was deleted.' %
-      [experiment[:name], experiment[:id]]
-end
-
-if __FILE__ == $0
-  begin
-    delete_experiment()
-
-  # 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/v201008/delete_user_list.rb

@@ -1,78 +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 deletes a user list by setting the status to 'CLOSED'. To get
-# user lists, run get_all_user_lists.rb.
-#
-# Tags: UserListService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def delete_user_list()
-  # 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')
-
-  user_list_srv = adwords.service(:UserListService, API_VERSION)
-
-  user_list_id = 'INSERT_USER_LIST_ID_HERE'.to_i
-
-  # Prepare for deleting remarketing user list.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => user_list_id,
-      :status => 'CLOSED'
-    }
-  }
-
-  # Delete user list.
-  response = user_list_srv.mutate([operation])
-  user_list = response[:value].first
-  puts 'User list with name "%s" and id %d was deleted (closed).' %
-      [user_list[:name], user_list[:id]]
-end
-
-if __FILE__ == $0
-  begin
-    delete_user_list()
-
-  # 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