google-adwords-api 0.4.5 → 0.5.0

data/examples/v201008/get_all_user_lists.rb

@@ -1,75 +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 user lists for an account.
-#
-# Tags: UserListService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_user_lists()
-  # 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)
-
-  # Get all the user lists for this account.
-  selector = {}
-  response = user_list_srv.get(selector)
-
-  if response and response[:entries]
-    user_lists = response[:entries]
-    user_lists.each do |user_list|
-      puts "User list name is \"#{user_list[:name]}\", id is " +
-          "#{user_list[:id]}, status is \"#{user_list[:status]}\" and number " +
-          "of users is #{user_list[:size]}."
-    end
-  else
-    puts "No user lists were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_user_lists()
-
-  # 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/get_all_videos.rb

@@ -1,76 +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 videos. To upload video, see
-# http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454
-#
-# Tags: MediaService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_videos()
-  # 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')
-
-  media_srv = adwords.service(:MediaService, API_VERSION)
-
-  # Get all the videos.
-  selector = {
-    :media_type => 'VIDEO'
-  }
-  response = media_srv.get(selector)
-  if response and response[:entries]
-    videos = response[:entries]
-    puts "#{videos.length} video(s) found."
-    videos.each do |video|
-      puts "  Video id is #{video[:media_id]} and name is \"#{video[:name]}\"."
-    end
-  else
-    puts "No videos found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_videos()
-
-  # 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/get_bulk_mutate_job.rb

@@ -1,97 +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 a bulk mutate job and prints out its stats information.
-# To add a bulk mutate job, run perform_bulk_mutate_job.rb.
-#
-# Tags: BulkMutateJobService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_all_bulk_mutate_jobs()
-  # 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)
-
-  # Replace with valid values of your account.
-  bulk_mutate_job_id = "INSERT_BULK_MUTATE_JOB_ID_HERE"
-
-  # Get all the bulk mutate jobs.
-  selector = {
-    :include_stats => true,
-    :job_ids => [bulk_mutate_job_id]
-  }
-  jobs = bulk_mutate_job_srv.get(selector)
-
-  if jobs
-    jobs.each do |job|
-      puts "Bulk mutate job with id %d and status '%s' was found." %
-          [job[:id], job[:status]]
-
-      case job[:status]
-      when 'PENDING'
-        puts "  Total parts: %d, parts received: %d." %
-            [job[:num_request_parts], job[:num_request_parts_received]]
-      when 'PROCESSING'
-        if job[:stats]
-          puts "  Percent complete: %d." % job[:stats][:progress_percent]
-        end
-      when 'COMPLETED'
-        if job[:stats]
-          puts "  Total operations: %d, failed: %d, unprocessed %d." %
-              [job[:stats][:num_operations],
-               job[:stats][:num_failed_operations],
-               job[:stats][:num_unprocessed_operations]]
-        end
-      end
-    end
-  else
-    puts "No bulk mutate jobs were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_all_bulk_mutate_jobs()
-
-  # 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/get_campaign_alerts.rb

@@ -1,95 +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 code example illustrates how to retrieve campaign alerts for a user.
-# The alerts are restricted to a maximum of 10 entries.
-#
-# Tags: AlertService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201008
-
-def get_campaign_alerts()
-  # 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')
-
-  alert_srv = adwords.service(:AlertService, API_VERSION)
-
-  # Create the selector.
-  selector = {
-    :query => {
-      :filter_spec => 'ALL',
-      :client_spec => 'ALL',
-      :trigger_time_spec => 'ALL_TIME',
-      :severities => ['GREEN', 'YELLOW', 'RED'],
-      :types => ['CAMPAIGN_ENDING', 'CAMPAIGN_ENDED']
-    },
-    :paging => {
-      :start_index => 0,
-      :number_results => 10
-    }
-  }
-
-  # Get alerts.
-  response = alert_srv.get(selector)
-
-  if response and response[:entries]
-    alerts = response[:entries]
-    alerts.each_with_index do |alert, index|
-      puts "{index}) Customer Id is " +
-          "#{AdwordsApi::Utils.format_id(alert[:client_customer_id])}, " +
-          "alert type is '#{alert[:alert_type]}', severity is " +
-          "#{alert[:alert_severity]}."
-      alert[:details].each do |detail|
-        puts "  - triggered at #{detail[:trigger_time]}"
-      end
-    end
-  else
-    puts "No alerts were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_campaign_alerts()
-
-  # 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/get_conversion_optimizer_eligibility.rb

@@ -1,88 +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 shows how to check for conversion optimizer eligibility by
-# examining the conversion_optimizer_eligibility field of the Campaign.
-#
-# Tags: CampaignService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201008
-
-def get_conversion_optimizer_eligibility()
-  # 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
-
-  # Get campaign.
-  selector = {
-    :ids => [campaign_id]
-  }
-  response = campaign_srv.get(selector)
-
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaigns.each do |campaign|
-      eligibility = campaign[:conversion_optimizer_eligibility]
-      if eligibility[:eligible]
-        puts "Campaign with name is \"#{campaign[:name]}\" and id " +
-            "#{campaign[:id]} is eligible to use the conversion optimizer."
-      else
-        puts "Campaign with name is \"#{campaign[:name]}\" and id " +
-            "#{campaign[:id]} is not eligible to use the conversion " +
-            "optimizer for the reasons: " +
-            eligibility[:rejection_reasons].pretty_inspect
-      end
-    end
-  else
-    puts "No campaigns were found."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_conversion_optimizer_eligibility()
-
-  # 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/get_criterion_bid_landscape.rb

@@ -1,96 +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 a bid landscape for an ad group and a criterion. To get ad
-# groups, run get_all_ad_groups.rb. To get criteria, run
-# get_all_ad_group_criteria.rb.
-#
-# Tags: BidLandscapeService.getBidLandscape
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def get_criterion_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')
-
-  bid_landscape_srv = adwords.service(:BidLandscapeService, API_VERSION)
-
-  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Get criterion bid landscape.
-  selector = {
-    # 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 => 'CriterionBidLandscapeSelector',
-    :id_filters => [{
-      :ad_group_id => ad_group_id,
-      :criterion_id => criterion_id
-    }]
-  }
-  bid_landscapes = bid_landscape_srv.get_bid_landscape(selector)
-  if bid_landscapes
-    puts "#{bid_landscapes.length} bid landscape(s) retrieved."
-    bid_landscapes.each do |bid_landscape|
-      puts "Retrieved criterion bid landscape with ad group id " +
-          "'#{bid_landscape[:ad_group_id]}', criterion id " +
-          "'#{bid_landscape[:criterion_id]}', 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 bid landscapes retrieved."
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_criterion_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