google-adwords-api 0.5.1 → 0.5.2

data/examples/v201109/misc/get_all_images_and_videos.rb

@@ -27,9 +27,6 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-PAGE_SIZE = 500
-
 def get_all_images_and_videos()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -80,6 +77,9 @@ def get_all_images_and_videos()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 500
+
   begin
     get_all_images_and_videos()
 

data/examples/v201109/misc/upload_image.rb

@@ -26,8 +26,6 @@ require 'adwords_api'
 require 'adwords_api/utils'
 require 'base64'
 
-API_VERSION = :v201109
-
 def upload_image()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -69,6 +67,8 @@ def upload_image()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     upload_image()
 

data/examples/v201109/misc/use_oauth.rb

@@ -24,9 +24,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-MAX_RETRIES = 3
-
 def use_oauth()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -76,6 +73,9 @@ def use_oauth()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  MAX_RETRIES = 3
+
   begin
     use_oauth()
 

data/examples/v201109/optimization/estimate_keyword_traffic.rb

@@ -24,8 +24,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
 def estimate_keyword_traffic()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -108,6 +106,8 @@ def estimate_keyword_traffic()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     estimate_keyword_traffic()
 

data/examples/v201109/optimization/get_keyword_bid_simulations.rb

@@ -25,9 +25,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_criterion_bid_landscapes()
+def get_criterion_bid_landscapes(ad_group_id, keyword_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -38,9 +36,6 @@ def get_criterion_bid_landscapes()
 
   data_srv = adwords.service(:DataService, API_VERSION)
 
-  ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
-  keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
-
   # Get keyword bid landscape.
   selector = {
     :fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
@@ -72,8 +67,12 @@ def get_criterion_bid_landscapes()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_criterion_bid_landscapes()
+    ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
+    keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
+    get_criterion_bid_landscapes(ad_group_id, keyword_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/optimization/get_keyword_ideas.rb

@@ -25,10 +25,7 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-PAGE_SIZE = 100
-
-def get_keyword_ideas()
+def get_keyword_ideas(keyword_text)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def get_keyword_ideas()
 
   targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
 
-  keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
-
   # Construct selector object.
   selector = {
     :idea_type => 'KEYWORD',
@@ -87,8 +82,12 @@ def get_keyword_ideas()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 100
+
   begin
-    get_keyword_ideas()
+    keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
+    get_keyword_ideas(keyword_text)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/optimization/get_placement_ideas.rb

@@ -26,10 +26,7 @@
 require 'adwords_api'
 require 'adwords_api/utils'
 
-API_VERSION = :v201109
-PAGE_SIZE = 100
-
-def get_placement_ideas()
+def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,8 +37,6 @@ def get_placement_ideas()
 
   targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
 
-  url = 'INSERT_PLACEMENT_URL_HERE'
-
   # Construct selector.
   selector = {
     :idea_type => 'PLACEMENT',
@@ -86,8 +81,12 @@ def get_placement_ideas()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 100
+
   begin
-    get_placement_ideas()
+    url = 'INSERT_PLACEMENT_URL_HERE'
+    get_placement_ideas(url)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/remarketing/add_audience.rb

@@ -25,8 +25,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
 def add_audience()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -52,7 +50,9 @@ def add_audience()
       :description => 'A list of mars cruise customers in the last year',
       :status => 'OPEN',
       :membership_life_span => 365,
-      :conversion_types => [{:name => name}]
+      :conversion_types => [{:name => name}],
+      # Optional field.
+      :status => 'OPEN'
     }
   }
 
@@ -92,6 +92,8 @@ def add_audience()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     add_audience()
 

data/examples/v201109/remarketing/add_conversion_tracker.rb

@@ -24,8 +24,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
 def add_conversion_tracker()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -50,7 +48,16 @@ def add_conversion_tracker()
       :category => 'DEFAULT',
       :markup_language => 'HTML',
       :http_protocol => 'HTTP',
-      :text_format => 'HIDDEN'
+      :text_format => 'HIDDEN',
+      # Optional fields:
+      :status => 'ENABLED',
+      :viewthrough_lookback_window => 15,
+      :viewthrough_conversion_de_dup_search => true,
+      :is_product_ads_chargeable => true,
+      :product_ads_chargeable_conversion_window => 15,
+      :conversion_page_language => 'en',
+      :background_color => '#0000FF',
+      :user_revenue_value => 'someJavascriptVariable'
     }
   }
 
@@ -67,6 +74,8 @@ def add_conversion_tracker()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     add_conversion_tracker()
 

data/examples/v201109/reporting/download_criteria_report.rb

@@ -22,9 +22,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def download_criteria_report()
+def download_criteria_report(file_name)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -36,10 +34,6 @@ def download_criteria_report()
   # Get report utilities for the version.
   report_utils = adwords.report_utils(API_VERSION)
 
-  # File name to write report to. To retrieve the report as return value, use
-  # "download_report" method.
-  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-
   # Define report definition. You can also pass your own XML text as a string.
   report_definition = {
     :selector => {
@@ -61,13 +55,18 @@ def download_criteria_report()
   }
 
   # Download report, using "download_report_as_file" utility method.
+  # To retrieve the report as return value, use "download_report" method.
   report_utils.download_report_as_file(report_definition, file_name)
   puts "Report was downloaded to '%s'." % file_name
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    download_criteria_report()
+    # File name to write report to.
+    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
+    download_criteria_report(file_name)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/reporting/download_defined_report.rb

@@ -24,9 +24,7 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def download_defined_report()
+def download_defined_report(report_definition_id, file_name)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -37,9 +35,6 @@ def download_defined_report()
 
   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\'.' %
@@ -47,8 +42,12 @@ def download_defined_report()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    download_defined_report()
+    report_definition_id = 'INSERT_REPORT_DEFINITION_ID'.to_i
+    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
+    download_defined_report(report_definition_id, file_name)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/reporting/get_campaign_stats.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 various statistics for campaigns that received at least one
+# impression during the last week. To get campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+require 'date'
+
+def get_campaign_stats()
+  # 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)
+
+  # Prepare start and end date for the last week.
+  start_date = DateTime.parse((Date.today - 7).to_s).strftime("%Y%m%d")
+  end_date = DateTime.parse((Date.today - 1).to_s).strftime("%Y%m%d")
+
+  # Get all the campaigns for this account.
+  selector = {
+    :fields => ['Id', 'Name', 'Impressions', 'Clicks', 'Cost', 'Ctr'],
+    :predicates => [
+      {:field => 'Impressions', :operator => 'GREATER_THAN', :values => [0]}
+    ],
+    :date_range => {:min => start_date, :max => end_date},
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |campaign|
+        puts ("Campaign with ID %d, name '%s' had the following stats during" +
+            " the last week: ") % [campaign[:id], campaign[:name]]
+        stats = campaign[:campaign_stats]
+        puts "\tImpressions: %d" % stats[:impressions]
+        puts "\tClicks:      %d" % stats[:clicks]
+        puts "\tCost:        %.2f" % (stats[:cost][:micro_amount] / 1000000)
+        puts "\tCTR:         %.2f%%" % (stats[:ctr] * 100)
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "Total number of campaigns found: %d." % [page[:total_num_entries]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+  PAGE_SIZE = 500
+
+  begin
+    get_campaign_stats()
+
+  # 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/reporting/get_defined_reports.rb

@@ -25,8 +25,6 @@
 
 require 'adwords_api'
 
-API_VERSION = :v201109
-
 def get_defined_reports()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
@@ -54,6 +52,8 @@ def get_defined_reports()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
     get_defined_reports()