google-adwords-api 0.4.5 → 0.5.0

data/examples/v201109/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 = :v201109
-
-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/v201109/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 = :v201109
-
-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

data/examples/v201109/get_ad_group_bid_landscape.rb

@@ -1,94 +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 bid landscapes for an ad group. To get ad groups,
-# run get_all_ad_groups.rb.
-#
-# Tags: DataService.getAdGroupBidLandscape
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_ad_group_bid_landscapes()
-  # 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')
-
-  data_srv = adwords.service(:DataService, API_VERSION)
-
-  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Get bid landscape for ad group.
-  selector = {
-    :fields => ["AdGroupId", "LandscapeType", "LandscapeCurrent", "StartDate",
-                "EndDate", "Bid", "LocalClicks", "LocalCost", "MarginalCpc",
-                "LocalImpressions"],
-    :predicates => [
-      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]}
-    ]
-  }
-  page = data_srv.get_criterion_bid_landscape(selector)
-  if page and page[:entries]
-    puts "#{page[:entries].length} bid landscape(s) retrieved."
-    page[:entries].each do |bid_landscape|
-      puts "Found ad group bid landscape with ad group id " +
-          "'#{bid_landscape[:ad_group_id]}', type " +
-          "'#{bid_landscape[:type]}', current " +
-          "'#{bid_landscape[:landscape_current]}', start date " +
-          "'#{bid_landscape[:start_date]}', end date "+
-          "'#{bid_landscape[:end_date]}', with landscape points:"
-      bid_landscape[:landscape_points].each do |point|
-        puts "  #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
-            "cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
-            "#{point[:marginal_cpc][:micro_amount]}, impressions: " +
-            "#{point[:impressions]}"
-      end
-    end
-  else
-    puts "No ad group bid landscapes retrieved."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_ad_group_bid_landscapes()
-
-  # 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/v201109/get_all_ad_extension_overrides.rb

@@ -1,82 +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 ad extension overrides
-# for an existing campaign. To create an ad extension override run
-# add_ad_extension_override.rb.
-#
-# Tags: AdExtensionOverrideService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_ad_extension_overrides()
-  # 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_ext_override_srv =
-      adwords.service(:AdExtensionOverrideService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Get all the ad extension overrides for this campaign.
-  selector = {
-    :campaign_ids => [campaign_id]
-  }
-  response = ad_ext_override_srv.get(selector)
-  if response and response[:entries]
-    ext_overrides = response[:entries]
-    puts "Campaign ##{campaign_id} has #{ext_overrides.size} ad extension " +
-        "override(s)."
-    ext_overrides.each do |ext_override|
-      puts "  Ad extension override for ad ##{ext_override[:ad_id]} " +
-          "and ad extension ##{ext_override[:ad_extension][:id]}."
-    end
-  else
-    puts "No ad extension overrides found for campaign ##{campaign_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_extension_overrides()
-
-  # 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/v201109/get_all_ad_group_criteria.rb

@@ -1,90 +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'
-require 'adwords_api'
-
-API_VERSION = :v201109
-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 #%d has %d criteria." % [ad_group_id,
-        ad_group_criteria.length]
-    ad_group_criteria.each do |ad_group_criterion|
-      puts "\tCriterion ID is %d and type is '%s'" %
-          [ad_group_criterion[:criterion][:id],
-           ad_group_criterion[:criterion][:type]]
-    end
-  else
-    puts "No criteria found for ad group #%d" % ad_group_id
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_group_criteria()
-
-  # 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/v201109/get_all_ad_params.rb

@@ -1,86 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 parameters for an ad
-# group. To create an ad parameter, run set_ad_params.rb.
-#
-# Tags: AdParamService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_ad_params()
-  # 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_param_srv = adwords.service(:AdParamService, API_VERSION)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Get all the ad parameters for this ad group.
-  selector = {
-      :fields => ['AdGroupId', 'CriterionId', 'InsertionText', 'ParamIndex'],
-      :predicates => [
-          {:field => 'AdGroupId',
-           :operator => 'EQUALS',
-           :values => [ad_group_id]}
-      ]
-  }
-  response = ad_param_srv.get(selector)
-
-  if response and response[:entries]
-    ad_params = response[:entries]
-    puts "Ad group ID %d has %d ad param(s):" % [ad_group_id, ad_params.length]
-    ad_params.each do |ad_param|
-      puts "\tAd param index %d for criterion ID %d has insertion_text '%s' " %
-          [ad_param[:param_index], ad_param[:criterion_id],
-           ad_param[:insertion_text]]
-    end
-  else
-    puts "No ad params found for ad group ID %d" % ad_group_id
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_ad_params()
-
-  # 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