google-adwords-api 0.4.5 → 0.5.0

data/examples/v201101/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 = :v201101
-
-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/v201101/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 = :v201101
-
-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/v201101/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 = :v201101
-
-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/v201101/download_report.rb

@@ -1,67 +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 and downloads a report from a report definition. To get a
-# report definition, run add_keywords_performance_report_definition.rb.
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-def download_report()
-  # 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')
-
-  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
-
-  report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
-  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-
-  # Download report, using "download_report_as_file" extension method.
-  report_def_srv.download_report_as_file(report_definition_id, file_name)
-  puts 'Report with definition id %d was downloaded to \'%s\'.' %
-      [report_definition_id, file_name]
-end
-
-if __FILE__ == $0
-  begin
-    download_report()
-
-  # 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/v201101/get_account_hierarchy.rb

@@ -1,102 +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 the account hierarchy under an
-# account.
-#
-# Tags: ServicedAccountService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201101
-
-def get_account_hierarchy()
-  # 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')
-
-  serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
-
-  # Create selector to get all accounts with no paging.
-  selector = {:enable_paging => false}
-
-  graph = nil
-
-  # Run with MCC account.
-  adwords.use_mcc do
-    # Get the account hierarchy for this account.
-    graph = serviced_account_srv.get(selector)
-  end
-
-  if graph
-    # Display the accounts.
-    account_number = graph[:accounts] ? graph[:accounts].size : 0
-    puts "There are %d customers under this account hierarchy." %
-        account_number
-    if graph[:accounts]
-      graph[:accounts].each_with_index do |account, index|
-        puts "#{index + 1}) Customer id: " +
-            AdwordsApi::Utils.format_id(account[:customer_id])
-        puts "Login email: #{account[:login]}"
-        puts "Company Name: #{account[:company_name]}"
-        puts "IsMcc: #{account[:can_manage_clients]}"
-        puts ''
-      end
-
-      puts ''
-
-      # Display the links.
-      graph[:links].each do |link|
-        puts "There is a '%s' link from %s to %s"  %
-            [link[:type_of_link],
-             AdwordsApi::Utils.format_id(link[:manager_id][:id]),
-             AdwordsApi::Utils.format_id(link[:client_id][:id])]
-      end
-    end
-  else
-    puts "No accounts were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_account_hierarchy()
-
-  # 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/v201101/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 = :v201101
-
-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