google-adwords-api 0.13.0 → 0.13.1

data/ChangeLog

@@ -1,3 +1,7 @@
+0.13.1:
+  - Added example for Ad Customizers.
+  - Removed support for ClientLogin (no longer supported by the API).
+
 0.13.0:
   - Removed deprecated API version v201309.
 

data/README.md

@@ -74,7 +74,7 @@ The basics of making a request are:
 
  3. Specify which service you're looking to use, and which version:
 
-        campaign_srv = adwords.service(:CampaignService, :v201402)
+        campaign_srv = adwords.service(:CampaignService, :v201406)
 
  4. You should now be able to just use the API methods in the returned object:
 
@@ -211,7 +211,7 @@ To target a specific version:
 
 For example:
 
-    $ rake generate[v201402]
+    $ rake generate[v201406]
 
 To target a specific service in a specific version:
 
@@ -219,7 +219,7 @@ To target a specific service in a specific version:
 
 For example:
 
-    $ rake generate[v201402,CampaignService]
+    $ rake generate[v201406,CampaignService]
 
 To build the gems:
 
@@ -247,7 +247,7 @@ announcements and other news.
 
 ## Licence
 
-Copyright 2010-2013, Google Inc. All Rights Reserved.
+Copyright 2010-2014, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -265,7 +265,7 @@ limitations under the License.
 
 Authors:
 
- - api.sgomes (Sérgio Gomes)
+ - api.sgomes@gmail.com (Sérgio Gomes)
  - api.dklimkin@gmail.com (Danial Klimkin)
  - api.mcloonan@gmail.com (Michael Cloonan)
 

data/adwords_api.yml

@@ -2,8 +2,7 @@
 # This is an example configuration file for the AdWords API client library.
 # Please fill in the required fields, and copy it over to your home directory.
 :authentication:
-  # Authentication method, methods currently supported: OAUTH2, OAUTH2_JWT,
-  # ClientLogin.
+  # Authentication method, methods currently supported: OAUTH2, OAUTH2_JWT.
   :method: OAuth2
 
   # Auth parameters for OAUTH2 method.
@@ -28,13 +27,6 @@
   # To impersonate a user set prn to an email address.
   #:oauth2_prn: INSERT_OAUTH2_PRN_HERE
 
-  # Auth parameters for ClientLogin method.
-  # NOTE: ClientLogin method is deprecated, use OAuth2.0 instead.
-  #:password: INSERT_YOUR_PASSWORD_HERE
-  #:email: INSERT_YOUR_LOGIN_EMAIL_HERE
-  # To manage your auth tokens manually, use the 'auth_token' property.
-  #:auth_token: INSERT_AUTH_TOKEN_HERE
-
   # Other parameters.
   :developer_token: INSERT_YOUR_DEVELOPER_TOKEN_HERE
   :client_customer_id: INSERT_YOUR_CLIENT_CUSTOMER_ID_HERE

data/examples/v201406/advanced_operations/add_ad_customizer.rb

@@ -0,0 +1,277 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.mcloonan@gmail.com (Michael Cloonan)
+#
+# Copyright:: Copyright 2014, 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 adds an ad customizer feed and associates it with the customer.
+# Then it adds an ad that uses the feed to populate dynamic data.
+#
+# Tags: CustomerFeedService.mutate, FeedItemService.mutate
+# Tags: FeedMappingService.mutate, FeedService.mutate
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def add_ad_customizer(ad_group_ids)
+  # 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')
+
+  feed_srv = adwords.service(:FeedService, API_VERSION)
+  feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
+  feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
+  customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # First, create a customizer feed. One feed per account can be used for
+  # all ads.
+  customizer_feed = {
+    :name => 'CustomizerFeed',
+    :attributes => [
+      {:type => 'STRING', :name => 'Name'},
+      {:type => 'STRING', :name => 'Price'},
+      {:type => 'DATE_TIME', :name => 'Date'}
+    ]
+  }
+
+  response = feed_srv.mutate([
+      {:operator => 'ADD', :operand => customizer_feed}
+  ])
+
+  feed_data = {}
+  if response and response[:value]
+    feed = response[:value].first
+    feed_data = {
+        :feed_id => feed[:id],
+        :name_id => feed[:attributes][0][:id],
+        :price_id => feed[:attributes][1][:id],
+        :date_id => feed[:attributes][2][:id]
+    }
+    puts "Feed with name '%s' and ID %d was added with:" %
+        [feed[:name], feed[:id]]
+    puts ("\tName attribute ID %d and price attribute ID %d " +
+        "and date attribute ID %d.") % [
+          feed_data[:name_id],
+          feed_data[:price_id],
+          feed_data[:date_id]
+        ]
+  else
+    raise new StandardError, 'No feeds were added.'
+  end
+
+  # Creating feed mapping to map the fields with customizer IDs.
+  feed_mapping = {
+    :placeholder_type => PLACEHOLDER_AD_CUSTOMIZER,
+    :feed_id => feed_data[:feed_id],
+    :attribute_field_mappings => [
+      {
+        :feed_attribute_id => feed_data[:name_id],
+        :field_id => PLACEHOLDER_FIELD_STRING
+      },
+      {
+        :feed_attribute_id => feed_data[:price_id],
+        :field_id => PLACEHOLDER_FIELD_PRICE
+      },
+      {
+        :feed_attribute_id => feed_data[:date_id],
+        :field_id => PLACEHOLDER_FIELD_DATE
+      }
+    ]
+  }
+
+  response = feed_mapping_srv.mutate([
+      {:operator => 'ADD', :operand => feed_mapping}
+  ])
+  if response and response[:value]
+    feed_mapping = response[:value].first
+    puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
+        ' with ID %d.') % [
+          feed_mapping[:feed_mapping_id],
+          feed_mapping[:placeholder_type],
+          feed_mapping[:feed_id]
+        ]
+  else
+    raise new StandardError, 'No feed mappings were added.'
+  end
+
+  # Now adding feed items -- the values we'd like to place.
+  items_data = [
+    {
+      :name => 'Mars',
+      :price => '$1234.56',
+      :date => '20140601 000000',
+      :ad_group_id => ad_group_ids[0]
+    },
+    {
+      :name => 'Venus',
+      :price => '$1450.00',
+      :date => '20140615 120000',
+      :ad_group_id => ad_group_ids[1]
+     }
+  ]
+
+  feed_items = items_data.map do |item|
+    {
+      :feed_id => feed_data[:feed_id],
+      :attribute_values => [
+        {
+          :feed_attribute_id => feed_data[:name_id],
+          :string_value => item[:name]
+        },
+        {
+          :feed_attribute_id => feed_data[:price_id],
+          :string_value => item[:price]
+        },
+        {
+          :feed_attribute_id => feed_data[:date_id],
+          :string_value => item[:date]
+        }
+      ],
+      :ad_group_targeting => {
+        :targeting_ad_group_id => item[:ad_group_id]
+      }
+    }
+  end
+
+  feed_items_operations = feed_items.map do |item|
+    {:operator => 'ADD', :operand => item}
+  end
+
+  response = feed_item_srv.mutate(feed_items_operations)
+  if response and response[:value]
+    response[:value].each do |feed_item|
+      puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
+    end
+  else
+    raise new StandardError, 'No feed items were added.'
+  end
+
+  # Finally, creating a customer (account-level) feed with a matching function
+  # that determines when to use this feed. For this case we use the "IDENTITY"
+  # matching function that is always 'true' just to associate this feed with
+  # the customer. The targeting is done within the feed items using the
+  # :campaign_targeting, :ad_group_targeting, or :keyword_targeting attributes.
+  matching_function = {
+    :operator => 'IDENTITY',
+    :lhs_operand => [
+      {
+        :xsi_type => 'ConstantOperand',
+        :type => 'BOOLEAN',
+        :boolean_value => true
+      }
+    ]
+  }
+
+  customer_feed = {
+    :feed_id => feed_data[:feed_id],
+    :matching_function => matching_function,
+    :placeholder_types => [PLACEHOLDER_AD_CUSTOMIZER]
+  }
+
+  response = customer_feed_srv.mutate([
+      {:operator => 'ADD', :operand => customer_feed}
+  ])
+  if response and response[:value]
+    feed = response[:value].first
+    puts 'Customer feed with ID %d was added.' % [feed[:feed_id]]
+  else
+    raise new StandardError, 'No customer feeds were added.'
+  end
+
+  # All set! We can now create ads with customizations.
+  text_ad = {
+    :xsi_type => 'TextAd',
+    :headline => 'Luxury Cruise to {=CustomizerFeed.Name}',
+    :description1 => 'Only {=CustomizerFeed.Price}',
+    :description2 => 'Offer ends in {=countdown(CustomizerFeed.Date)}!',
+    :url => 'http://www.example.com',
+    :display_url => 'www.example.com'
+  }
+
+  # We add the same ad to both ad groups. When they serve, they will show
+  # different values, since they match different feed items.
+  operations = ad_group_ids.map do |ad_group_id|
+    {
+      :operator => 'ADD',
+      :operand => {
+        :ad_group_id => ad_group_id,
+        :ad => text_ad
+      }
+    }
+  end
+
+  response = ad_group_ad_srv.mutate(operations)
+  if response and response[:value]
+    ads = response[:value]
+    ads.each do |ad|
+      puts "\tCreated an ad with ID %d, type '%s' and status '%s'" %
+          [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
+    end
+  else
+    raise StandardError, 'No ads were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  # See the Placeholder reference page for a list of all the placeholder types
+  # and fields:
+  #     https://developers.google.com/adwords/api/docs/appendix/placeholders
+  PLACEHOLDER_AD_CUSTOMIZER = 10
+  PLACEHOLDER_FIELD_INTEGER = 1
+  PLACEHOLDER_FIELD_FLOAT = 2
+  PLACEHOLDER_FIELD_PRICE = 3
+  PLACEHOLDER_FIELD_DATE = 4
+  PLACEHOLDER_FIELD_STRING = 5
+
+  begin
+    ad_group_ids = [
+        'INSERT_AD_GROUP_ID_HERE'.to_i,
+        'INSERT_AD_GROUP_ID_HERE'.to_i
+    ]
+    add_ad_customizer(ad_group_ids)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/lib/adwords_api.rb

@@ -23,7 +23,6 @@
 require 'ads_common/api'
 require 'ads_common/savon_headers/oauth_header_handler'
 require 'adwords_api/api_config'
-require 'adwords_api/client_login_header_handler'
 require 'adwords_api/credential_handler'
 require 'adwords_api/errors'
 require 'adwords_api/report_utils'
@@ -63,12 +62,6 @@ module AdwordsApi
     def soap_header_handler(auth_handler, version, header_ns, default_ns)
       auth_method = @config.read('authentication.method', :OAUTH2)
       handler_class = case auth_method
-        when :CLIENTLOGIN
-          raise AdsCommon::Errors::AuthError,
-            "ClientLogin is not supported. " +
-            "Please use OAuth2 instead. See here for details:\n\t\t" +
-            "https://developers.google.com/adwords/api/" +
-            "docs/guides/authentication"
         when :OAUTH2, :OAUTH2_JWT
           AdsCommon::SavonHeaders::OAuthHeaderHandler
         else

data/lib/adwords_api/api_config.rb

@@ -218,12 +218,6 @@ module AdwordsApi
       [:v201406, :LabelService] => 'cm/'
     }
 
-    # Auth constants for ClientLogin method.
-    @@client_login_config = {
-      :AUTH_SERVER => 'https://www.google.com',
-      :LOGIN_SERVICE_NAME => 'adwords'
-    }
-
     public
 
     # Getters for constants and module variables.
@@ -257,7 +251,11 @@ module AdwordsApi
     end
 
     def self.client_login_config(key)
-      return @@client_login_config[key]
+      raise AdsCommon::Errors::AuthError,
+            "ClientLogin is not supported. " +
+            "Please use OAuth2 instead. See here for details:\n\t\t" +
+            "https://developers.google.com/adwords/api/" +
+            "docs/guides/authentication"
     end
 
     def self.default_config_filename

data/lib/adwords_api/credential_handler.rb

@@ -74,11 +74,6 @@ module AdwordsApi
     # valid.
     #
     def validate_headers_for_server(credentials)
-      if credentials[:client_email]
-        raise AdwordsApi::Errors::BadCredentialsError, 'Deprecated header ' +
-            'clientEmail is no longer supported, please use clientCustomerId'
-      end
-
       client_customer_id = credentials[:client_customer_id]
       if client_customer_id and
           !(client_customer_id.is_a?(Integer) or

data/lib/adwords_api/v201402/ad_group_ad_service.rb

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.9.5 on 2014-03-05 10:52:45.
+# Code generated by AdsCommon library 0.9.5 on 2014-08-20 16:28:11.
 
 require 'ads_common/savon_service'
 require 'adwords_api/v201402/ad_group_ad_service_registry'