google-adwords-api 0.4.5 → 0.5.0

data/examples/v201109/get_all_campaign_ad_extensions.rb

@@ -1,87 +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 campaign ad extensions for a
-# campaign. To create a campaign ad extension, run add_campaign_ad_extension.rb.
-#
-# Tags: CampaignAdExtensionService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_campaign_ad_extensions()
-  # 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_ad_ext_srv =
-      adwords.service(:CampaignAdExtensionService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Get all the campaign ad extensions for this campaign.
-  selector = {
-    :fields => ['AdExtensionId', 'Status'],
-    :ordering => [{:field => 'AdExtensionId', :sort_order => 'ASCENDING'}],
-    :predicates => [{
-      :field => 'CampaignId',
-      :operator => 'IN',
-      :values => [campaign_id]
-    }]
-  }
-  response = campaign_ad_ext_srv.get(selector)
-  if response and response[:entries]
-    extensions = response[:entries]
-    puts "Campaign ##{campaign_id} has #{extensions.size} campaign ad " +
-        "extension(s)."
-    extensions.each do |extension|
-      puts "  Campaign ad extension id is #{extension[:ad_extension][:id]} " +
-          "and status is \"#{extension[:status]}\"."
-    end
-  else
-    puts "No campaign ad extensions found for campaign ##{campaign_id}."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_campaign_ad_extensions()
-
-  # 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_campaign_targets.rb

@@ -1,74 +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 campaign targets. To set
-# campaign targets, run set_campaign_targets.rb.
-#
-# Tags: CampaignTargetService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_campaign_targets()
-  # 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_target_srv = adwords.service(:CampaignTargetService, API_VERSION)
-
-  # Get all the campaign targets for this account.
-  selector = {}
-  response = campaign_target_srv.get(selector)
-  if response and response[:entries]
-    targets = response[:entries]
-    targets.each do |target|
-      puts "Campaign target of type %s for campaign ID %d was set." %
-          [target[:target_list_type], target[:campaign_id]]
-    end
-  else
-    puts 'No campaign targets found.'
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_campaign_targets()
-
-  # 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_conversions.rb

@@ -1,79 +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 all conversions in the account. To add conversions, run
-# add_conversion.rb.
-#
-# Tags: ConversionTrackerService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_conversions()
-  # 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')
-
-  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
-
-  # Get all conversions.
-  selector = {
-    :fields => ['Id', 'Name', 'Status', 'Category'],
-    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
-  }
-  response = conv_tracker_srv.get(selector)
-  if response and response[:entries]
-    conversions = response[:entries]
-    puts "#{conversions.length} conversions(s) found."
-    conversions.each do |conversion|
-      puts "  Conversion with id \"#{conversion[:id]}\", status \"" +
-          "#{conversion[:status]}\" and category \"#{conversion[:category]}\"" +
-          " was found. Code snippet: \n#{conversion[:snippet]}\n"
-    end
-  else
-    puts "No conversions found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_conversions()
-
-  # 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_experiments.rb

@@ -1,89 +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 all experiments in a campaign. To add an experiment, run
-# add_experiment.rb. To get campaigns, run get_all_campaigns.rb.
-#
-# Tags: ExperimentService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_experiments()
-  # 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)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-  # Get all the experiments for this campaign.
-  selector = {
-    :fields => ['Id', 'Name', 'ControlId', 'AdGroupsCount'],
-    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
-    :predicates => [{
-      :field => 'CampaignId',
-      :operator => 'IN',
-      :values => [campaign_id]
-    }]
-  }
-  response = experiment_srv.get(selector)
-
-  if response and response[:entries]
-    experiments = response[:entries]
-    experiments.each do |experiment|
-      experiment_stats = experiment[:experiment_summary_stats]
-      puts "Experiment with name \"#{experiment[:name]}\", " +
-          "id #{experiment[:id]} and control id " +
-          "#{experiment[:control_id]} was found and it includes " +
-          "#{experiment_stats[:ad_groups_count]} ad group(s) and " +
-          "#{experiment_stats[:ad_group_criteria_count]} criteria.\n"
-    end
-  else
-    puts "No experiments were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_experiments()
-
-  # 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_languages.rb

@@ -1,73 +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 languages available for
-# targeting.
-#
-# Tags: ConstantDataService.getLanguageCriterion
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_languages()
-  # 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')
-
-  constant_data_srv = adwords.service(:ConstantDataService, API_VERSION)
-
-  # Get all languages from ConstantDataService.
-  languages = constant_data_srv.get_language_criterion()
-
-  if languages
-    languages.each do |language|
-      puts "Language name is '%s', ID is %d and code is '%s'." %
-          [language[:name], language[:id], language[:code]]
-    end
-  else
-    puts "No languages were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_languages()
-
-  # 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_paused_campaigns.rb

@@ -1,83 +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 paused campaigns for an
-# account.
-#
-# Tags: CampaignService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201109
-
-def get_all_paused_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 paused campaigns for this account.
-  selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
-    :predicates => [{
-      :field => 'Status',
-      :operator => 'IN',
-      :values => ['PAUSED']
-    }]
-  }
-  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
-  begin
-    get_all_paused_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