google-adwords-api 0.4.5 → 0.5.0

data/examples/v201109/{parallel_report_download.rb → reporting/parallel_report_download.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #

data/examples/v201109/{add_campaign_targeting_criteria.rb → targeting/add_campaign_targeting_criteria.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -18,7 +19,7 @@
 #           limitations under the License.
 #
 # This example adds various types of targeting criteria to a campaign. To get
-# campaigns list, run get_all_campaigns.rb.
+# campaigns list, run get_campaigns.rb.
 #
 # Tags: CampaignCriterionService.mutate
 
@@ -27,7 +28,7 @@ require 'adwords_api'
 
 API_VERSION = :v201109
 
-def get_location_criteria()
+def add_campaign_targeting_criteria()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -65,6 +66,23 @@ def get_location_criteria()
     }
   end
 
+  # Add negative campaign criterion.
+  operations << {
+    :operator => 'ADD',
+    :operand => {
+      # 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 => 'NegativeCampaignCriterion',
+      :campaign_id => campaign_id,
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => 'jupiter cruise',
+        :match_type => 'BROAD'
+      }
+    }
+  }
+
   response = campaign_criterion_srv.mutate(operations)
 
   if response and response[:value]
@@ -82,7 +100,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_location_criteria()
+    add_campaign_targeting_criteria()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/{add_negative_campaign_criterion.rb → targeting/get_campaign_targeting_criteria.rb}

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -17,17 +18,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to create a negative campaign criterion for a
-# given campaign. To create a campaign, run add_campaign.rb.
+# This example illustrates how to retrieve all the campaign targets. To set
+# campaign targets, run add_campaign_targeting_criteria.rb.
 #
-# Tags: CampaignCriterionService.mutate
+# Tags: CampaignCriterionService.get
 
 require 'rubygems'
 require 'adwords_api'
 
 API_VERSION = :v201109
+PAGE_SIZE = 500
 
-def add_negative_campaign_criterion()
+def get_campaign_targeting_criteria()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,35 +41,50 @@ def add_negative_campaign_criterion()
   campaign_criterion_srv =
       adwords.service(:CampaignCriterionService, API_VERSION)
 
+  # Specify campaign ID to get targeting for.
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
 
-  # Prepare for adding criterion.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      # 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 => 'NegativeCampaignCriterion',
-      :campaign_id => campaign_id,
-      :criterion => {
-        :xsi_type => 'Keyword',
-        :text => 'jupiter cruise',
-        :match_type => 'BROAD'
-      }
+  # Selector to get all the targeting for this campaign.
+  selector = {
+    :fields => ['Id', 'CriteriaType', 'KeywordText'],
+    :predicates => [
+      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
     }
   }
 
-  # Add criterion.
-  response = campaign_criterion_srv.mutate([operation])
-  campaign_criterion = response[:value].first
-  puts 'Campaign criterion id %d was successfully added.' %
-      campaign_criterion[:criterion][:id]
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_criterion_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |typed_criterion|
+        negative = typed_criterion[:xsi_type] == 'NegativeCampaignCriterion' ?
+           ' (negative)' : ''
+        criterion = typed_criterion[:criterion]
+        puts ("Campaign criterion%s with ID %d, type '%s' and text '%s'" +
+            " was found.") %
+            [negative, criterion[:id], criterion[:type], criterion[:text]]
+      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 "\tCampaign ID %d has %d criteria." %
+        [campaign_id, page[:total_num_entries]]
+  end
 end
 
 if __FILE__ == $0
   begin
-    add_negative_campaign_criterion()
+    get_campaign_targeting_criteria()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/{get_all_carriers.rb → targeting/get_targetable_languages_and_carriers.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,8 +18,10 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to retrieve all carriers available for targeting.
+# This example illustrates how to retrieve all languages and carriers available
+# for targeting.
 #
+# Tags: ConstantDataService.getLanguageCriterion
 # Tags: ConstantDataService.getCarrierCriterion
 
 require 'rubygems'
@@ -26,7 +29,7 @@ require 'adwords_api'
 
 API_VERSION = :v201109
 
-def get_all_carriers()
+def get_targetable_languages_and_carriers()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -37,6 +40,18 @@ def get_all_carriers()
 
   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
+
   # Get all carriers from ConstantDataService.
   carriers = constant_data_srv.get_carrier_criterion()
 
@@ -52,7 +67,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_carriers()
+    get_targetable_languages_and_carriers()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/{get_location_criteria.rb → targeting/lookup_location.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@ require 'adwords_api'
 
 API_VERSION = :v201109
 
-def get_location_criteria()
+def lookup_location()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -83,7 +84,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_location_criteria()
+    lookup_location()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/lib/adwords_api.rb

@@ -1,9 +1,9 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.sgomes@gmail.com (Sérgio Gomes)
 #           api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2010, 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.

data/lib/adwords_api/api_config.rb

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.sgomes@gmail.com (Sérgio Gomes)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2010, 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.
@@ -41,46 +41,11 @@ module AdwordsApi
 
     # Set other constants
     API_NAME = 'AdwordsApi'
-    CLIENT_LIB_VERSION = '0.4.5'
+    CLIENT_LIB_VERSION = '0.5.0'
     DEFAULT_CONFIG_FILENAME = 'adwords_api.yml'
 
     # Configure the services available to each version
     @@service_config = {
-      :v13 => [:AccountService, :ReportService],
-      :v200909 => [:AdExtensionOverrideService, :AdGroupAdService,
-                   :AdGroupCriterionService, :AdGroupService, :AdParamService,
-                   :BulkMutateJobService, :CampaignAdExtensionService,
-                   :CampaignCriterionService, :CampaignService,
-                   :CampaignTargetService, :GeoLocationService, :InfoService,
-                   :TargetingIdeaService],
-      :v201003 => [:AdExtensionOverrideService, :AdGroupAdService,
-                   :AdGroupCriterionService, :AdGroupService, :AdParamService,
-                   :BidLandscapeService, :BulkMutateJobService,
-                   :CampaignAdExtensionService, :CampaignCriterionService,
-                   :CampaignService, :CampaignTargetService,
-                   :GeoLocationService, :InfoService, :MediaService,
-                   :ReportDefinitionService, :TargetingIdeaService],
-      :v201008 => [:AdExtensionOverrideService, :AdGroupAdService,
-                   :AdGroupCriterionService, :AdGroupService, :AdParamService,
-                   :AlertService, :BidLandscapeService, :BulkMutateJobService,
-                   :CampaignAdExtensionService, :CampaignCriterionService,
-                   :CampaignService, :CampaignTargetService,
-                   :CustomerSyncService, :ExperimentService,
-                   :GeoLocationService, :InfoService, :MediaService,
-                   :ReportDefinitionService, :ServicedAccountService,
-                   :TargetingIdeaService, :TrafficEstimatorService,
-                   :UserListService],
-      :v201101 => [:AdExtensionOverrideService, :AdGroupAdService,
-                   :AdGroupCriterionService, :AdGroupService, :AdParamService,
-                   :AlertService, :BulkMutateJobService,
-                   :BulkOpportunityService, :CampaignAdExtensionService,
-                   :CampaignCriterionService, :CampaignService,
-                   :CampaignTargetService, :ConversionTrackerService,
-                   :CustomerSyncService, :DataService, :ExperimentService,
-                   :GeoLocationService, :InfoService, :MediaService,
-                   :ReportDefinitionService, :ServicedAccountService,
-                   :TargetingIdeaService, :TrafficEstimatorService,
-                   :UserListService],
       :v201109 => [:AdExtensionOverrideService, :AdGroupAdService,
                    :AdGroupCriterionService, :AdGroupService, :AdParamService,
                    :AlertService, :BulkMutateJobService,
@@ -100,20 +65,10 @@ module AdwordsApi
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
-        :v13 => 'https://adwords.google.com/api/adwords/',
-        :v200909 => 'https://adwords.google.com/api/adwords/',
-        :v201003 => 'https://adwords.google.com/api/adwords/',
-        :v201008 => 'https://adwords.google.com/api/adwords/',
-        :v201101 => 'https://adwords.google.com/api/adwords/',
         :v201109 => 'https://adwords.google.com/api/adwords/'
       },
       :SANDBOX => {
         :oauth_scope => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v13 => 'https://sandbox.google.com/api/adwords/',
-        :v200909 => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v201003 => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v201008 => 'https://adwords-sandbox.google.com/api/adwords/',
-        :v201101 => 'https://adwords-sandbox.google.com/api/adwords/',
         :v201109 => 'https://adwords-sandbox.google.com/api/adwords/'
       }
     }
@@ -121,88 +76,6 @@ module AdwordsApi
     # Configure the subdirectories for each version / service pair.
     # A missing pair means that only the base URL is used.
     @@subdir_config = {
-      # v13
-      [:v13, :AccountService] => '',
-      [:v13, :ReportService] => '',
-      # v200909
-      [:v200909, :AdExtensionOverrideService] => 'cm/',
-      [:v200909, :AdGroupAdService] => 'cm/',
-      [:v200909, :AdGroupCriterionService] => 'cm/',
-      [:v200909, :AdGroupService] => 'cm/',
-      [:v200909, :AdParamService] => 'cm/',
-      [:v200909, :BulkMutateJobService] => 'job/',
-      [:v200909, :CampaignAdExtensionService] => 'cm/',
-      [:v200909, :CampaignCriterionService] => 'cm/',
-      [:v200909, :CampaignService] => 'cm/',
-      [:v200909, :CampaignTargetService] => 'cm/',
-      [:v200909, :GeoLocationService] => 'cm/',
-      [:v200909, :InfoService] => 'info/',
-      [:v200909, :TargetingIdeaService] => 'o/',
-      # v201003
-      [:v201003, :AdExtensionOverrideService] => 'cm/',
-      [:v201003, :AdGroupAdService] => 'cm/',
-      [:v201003, :AdGroupCriterionService] => 'cm/',
-      [:v201003, :AdGroupService] => 'cm/',
-      [:v201003, :AdParamService] => 'cm/',
-      [:v201003, :BidLandscapeService] => 'cm/',
-      [:v201003, :BulkMutateJobService] => 'job/',
-      [:v201003, :CampaignAdExtensionService] => 'cm/',
-      [:v201003, :CampaignCriterionService] => 'cm/',
-      [:v201003, :CampaignService] => 'cm/',
-      [:v201003, :CampaignTargetService] => 'cm/',
-      [:v201003, :GeoLocationService] => 'cm/',
-      [:v201003, :InfoService] => 'info/',
-      [:v201003, :MediaService] => 'cm/',
-      [:v201003, :ReportDefinitionService] => 'cm/',
-      [:v201003, :TargetingIdeaService] => 'o/',
-      # v201008
-      [:v201008, :AdExtensionOverrideService] => 'cm/',
-      [:v201008, :AdGroupAdService] => 'cm/',
-      [:v201008, :AdGroupCriterionService] => 'cm/',
-      [:v201008, :AdGroupService] => 'cm/',
-      [:v201008, :AdParamService] => 'cm/',
-      [:v201008, :AlertService] => 'mcm/',
-      [:v201008, :BidLandscapeService] => 'cm/',
-      [:v201008, :BulkMutateJobService] => 'job/',
-      [:v201008, :CampaignAdExtensionService] => 'cm/',
-      [:v201008, :CampaignCriterionService] => 'cm/',
-      [:v201008, :CampaignService] => 'cm/',
-      [:v201008, :CampaignTargetService] => 'cm/',
-      [:v201008, :CustomerSyncService] => 'ch/',
-      [:v201008, :ExperimentService] => 'cm/',
-      [:v201008, :GeoLocationService] => 'cm/',
-      [:v201008, :InfoService] => 'info/',
-      [:v201008, :MediaService] => 'cm/',
-      [:v201008, :ReportDefinitionService] => 'cm/',
-      [:v201008, :ServicedAccountService] => 'mcm/',
-      [:v201008, :TargetingIdeaService] => 'o/',
-      [:v201008, :TrafficEstimatorService] => 'o/',
-      [:v201008, :UserListService] => 'cm/',
-      # v201101
-      [:v201101, :AdExtensionOverrideService] => 'cm/',
-      [:v201101, :AdGroupAdService] => 'cm/',
-      [:v201101, :AdGroupCriterionService] => 'cm/',
-      [:v201101, :AdGroupService] => 'cm/',
-      [:v201101, :AdParamService] => 'cm/',
-      [:v201101, :AlertService] => 'mcm/',
-      [:v201101, :BulkMutateJobService] => 'job/',
-      [:v201101, :BulkOpportunityService] => 'o/',
-      [:v201101, :CampaignAdExtensionService] => 'cm/',
-      [:v201101, :CampaignCriterionService] => 'cm/',
-      [:v201101, :CampaignService] => 'cm/',
-      [:v201101, :CampaignTargetService] => 'cm/',
-      [:v201101, :ConversionTrackerService] => 'cm/',
-      [:v201101, :CustomerSyncService] => 'ch/',
-      [:v201101, :DataService] => 'cm/',
-      [:v201101, :ExperimentService] => 'cm/',
-      [:v201101, :GeoLocationService] => 'cm/',
-      [:v201101, :InfoService] => 'info/',
-      [:v201101, :MediaService] => 'cm/',
-      [:v201101, :ReportDefinitionService] => 'cm/',
-      [:v201101, :ServicedAccountService] => 'mcm/',
-      [:v201101, :TargetingIdeaService] => 'o/',
-      [:v201101, :TrafficEstimatorService] => 'o/',
-      [:v201101, :UserListService] => 'cm/',
       # v201109
       [:v201109, :AdExtensionOverrideService] => 'cm/',
       [:v201109, :AdGroupAdService] => 'cm/',

data/lib/adwords_api/client_login_header_handler.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #

data/lib/adwords_api/credential_handler.rb

@@ -1,9 +1,9 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.sgomes@gmail.com (Sérgio Gomes)
 #           api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2010, 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.

data/lib/adwords_api/errors.rb

@@ -1,8 +1,8 @@
-#!/usr/bin/ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2010, 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.