google-adwords-api 0.10.0 → 0.11.0

data/ChangeLog

@@ -1,3 +1,6 @@
+0.11.0:
+  - Removed deprecated API version v201302.
+
 0.10.0:
   - Support and examples for v201309.
   - Removed deprecated API version v201209.

data/examples/v201306/misc/setup_oauth2.rb

@@ -33,7 +33,7 @@ def setup_oauth2()
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  # You can call authorize explicitely to obtain the access token. Otherwise, it
+  # You can call authorize explicitly to obtain the access token. Otherwise, it
   # will be invoked automatically on the first API call.
   # There are two ways to provide verification code, first one is via the block:
   token = adwords.authorize() do |auth_url|
@@ -44,7 +44,7 @@ def setup_oauth2()
   end
   if token
     print "\nWould you like to update your adwords_api.yml to save " +
-        "OAuth2 crdentials? (y/N): "
+        "OAuth2 credentials? (y/N): "
     response = gets.chomp
     if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
       adwords.save_oauth2_token(token)
@@ -54,12 +54,12 @@ def setup_oauth2()
   end
 
   # Alternatively, you can provide one within the parameters:
-  #token = adwords.authorize({:oauth2_verification_code => verification_code})
+  # token = adwords.authorize({:oauth2_verification_code => verification_code})
 
   # Note, 'token' is a Hash. Its value is not used in this example. If you need
   # to be able to access the API in offline mode, with no user present, you
   # should persist it to be used in subsequent invocations like this:
-  #adwords.authorize({:oauth2_token => token})
+  # adwords.authorize({:oauth2_token => token})
 
   # No exception thrown - we are good to make a request.
 end

data/examples/v201306/optimization/get_keyword_ideas.rb

@@ -53,7 +53,7 @@ def get_keyword_ideas(keyword_text)
         # Language setting (optional).
         # The ID can be found in the documentation:
         #  https://developers.google.com/adwords/api/docs/appendix/languagecodes
-        # As of v201302 only one LanguageSearchParameter is allowed per request.
+        # Only one LanguageSearchParameter is allowed per request.
         :xsi_type => 'LanguageSearchParameter',
         :languages => [{:id => 1000}]
       }

data/examples/v201309/advanced_operations/add_site_links.rb

@@ -46,7 +46,9 @@ def add_site_links(campaign_id)
     :name => 'Feed For Site Links',
     :attributes => [
       {:type => 'STRING', :name => 'Link Text'},
-      {:type => 'URL', :name => 'Link URL'}
+      {:type => 'URL', :name => 'Link URL'},
+      {:type => 'STRING', :name => 'Line 1 Description'},
+      {:type => 'STRING', :name => 'Line 2 Description'}
     ]
   }
 
@@ -59,25 +61,67 @@ def add_site_links(campaign_id)
     link_text_feed_attribute_id = feed[:attributes][0][:id]
     # Attribute of type URL.
     link_url_feed_attribute_id = feed[:attributes][1][:id]
+    # Attribute of type STRING.
+    line_1_feed_attribute_id = feed[:attributes][2][:id]
+    #Attribute of type STRING.
+    line_2_feed_attribute_id = feed[:attributes][3][:id]
     puts "Feed with name '%s' and ID %d was added with" %
         [feed[:name], feed[:id]]
-    puts "\tText attribute ID %d and URL attribute ID %d." %
-        [link_text_feed_attribute_id, link_url_feed_attribute_id]
+    puts "\tText attribute ID %d and URL attribute ID %d " +
+        "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
+          link_text_feed_attribute_id,
+          link_url_feed_attribute_id,
+          line_1_feed_attribute_id,
+          line_2_feed_attribute_id
+        ]
+
     sitelinks_data[:feed_id] = feed[:id]
     sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
     sitelinks_data[:link_url_feed_id] = link_url_feed_attribute_id
+    sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
+    sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
   else
     raise new StandardError, 'No feeds were added.'
   end
 
   # Create site links feed items.
   items_data = [
-    {:text => 'Home', :url => 'http://www.example.com'},
-    {:text => 'Stores', :url => 'http://www.example.com/stores'},
-    {:text => 'On Sale', :url => 'http://www.example.com/sale'},
-    {:text => 'Support', :url => 'http://www.example.com/support'},
-    {:text => 'Products', :url => 'http://www.example.com/products'},
-    {:text => 'About', :url => 'http://www.example.com/about'}
+    {
+      :text => 'Home',
+      :url => 'http://www.example.com',
+      :line_1 => 'Home line 1',
+      :line_2 => 'Home line 2'
+    },
+    {
+      :text => 'Stores',
+      :url => 'http://www.example.com/stores',
+      :line_1 => 'Stores line 1',
+      :line_2 => 'Stores line 2'
+     },
+    {
+      :text => 'On Sale',
+      :url => 'http://www.example.com/sale',
+      :line_1 => 'On Sale line 1',
+      :line_2 => 'On Sale line 2'
+    },
+    {
+      :text => 'Support',
+      :url => 'http://www.example.com/support',
+      :line_1 => 'Support line 1',
+      :line_2 => 'Support line 2'
+    },
+    {
+      :text => 'Products',
+      :url => 'http://www.example.com/products',
+      :line_1 => 'Products line 1',
+      :line_2 => 'Products line 2'
+    },
+    {
+      :text => 'About',
+      :url => 'http://www.example.com/about',
+      :line_1 => 'About line 1',
+      :line_2 => 'About line 2'
+    }
   ]
 
   feed_items = items_data.map do |item|
@@ -91,6 +135,14 @@ def add_site_links(campaign_id)
         {
           :feed_attribute_id => sitelinks_data[:link_url_feed_id],
           :string_value => item[:url]
+        },
+        {
+          :feed_attribute_id => sitelinks_data[:line_1_feed_id],
+          :string_value => item[:line_1]
+        },
+        {
+          :feed_attribute_id => sitelinks_data[:line_2_feed_id],
+          :string_value => item[:line_2]
         }
       ]
     }
@@ -123,6 +175,14 @@ def add_site_links(campaign_id)
       {
         :feed_attribute_id => sitelinks_data[:link_url_feed_id],
         :field_id => PLACEHOLDER_FIELD_SITELINK_LINK_URL
+      },
+      {
+        :feed_attribute_id => sitelinks_data[:line_1_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
+      },
+      {
+        :feed_attribute_id => sitelinks_data[:line_2_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
       }
     ]
   }
@@ -212,6 +272,8 @@ if __FILE__ == $0
   PLACEHOLDER_SITELINKS = 1
   PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
   PLACEHOLDER_FIELD_SITELINK_LINK_URL = 2
+  PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
+  PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
 
   begin
     # Campaign ID to add site link to.

data/examples/v201309/advanced_operations/update_site_links.rb

@@ -0,0 +1,194 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.mcloonan@gmail.com (Michael Cloonan)
+#
+# Copyright:: Copyright 2013, 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 updates an existing sitelinks feed as follows:
+#  * Adds FeedItemAttributes for line 1 and line 2 descriptions to the Feed
+#  * Populates the new FeedItemAttributes on FeedItems in the Feed
+#  * Replaces the Feed's existing FeedMapping with one that contains the new
+#     set of FeedItemAttributes
+#
+# The end result of this is that any campaign or ad group whose CampaignFeed
+# or AdGroupFeed points to the Feed's ID will now serve line 1 and line 2
+# descriptions in its sitelinks.
+#
+# Tags: FeedItemService.mutate
+# Tags: FeedMappingService.mutate, FeedService.mutate
+
+require 'adwords_api'
+
+def update_site_links(feed_id, feed_item_descriptions)
+  # 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)
+
+  feed_selector = {
+    :fields => ['Id', 'Attributes'],
+    :predicates => [
+      {:field => 'Id', :operator => 'EQUALS', :values => [feed_id]}
+    ]
+  }
+
+  feed = feed_srv.get(feed_selector)[:entries][0]
+
+  # Add new line1 and line2 feed attributes.
+  next_attribute_index = feed[:attributes].length()
+
+  feed[:attributes] = [
+    {:type => 'STRING', :name => 'Line 1 Description'},
+    {:type => 'STRING', :name => 'Line 2 Description'}
+  ]
+
+  mutated_feed_result = feed_srv.mutate([
+    {:operator => 'SET', :operand => feed}
+  ])
+
+  mutated_feed = mutated_feed_result[:value][0]
+  line_1_attribute = mutated_feed[:attributes][next_attribute_index]
+  line_2_attribute = mutated_feed[:attributes][next_attribute_index + 1]
+
+  # Update feed items.
+  feed_item_ids = feed_item_descriptions.keys
+  item_selector = {
+    :fields => ['FeedId', 'FeedItemId', 'AttributeValues'],
+    :predicates => [
+      {:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]},
+      {:field => 'FeedItemId', :operator => 'IN', :values => feed_item_ids}
+    ]
+  }
+
+  feed_items = feed_item_srv.get(item_selector)[:entries]
+
+  item_operations = feed_items.map do |feed_item|
+    feed_item[:attribute_values] = [
+      {
+        :feed_attribute_id => line_1_attribute[:id],
+        :string_value => feed_item_descriptions[feed_item[:feed_item_id]][0]
+      },
+      {
+        :feed_attribute_id => line_2_attribute[:id],
+        :string_value => feed_item_descriptions[feed_item[:feed_item_id]][1]
+      }
+    ]
+
+    {:operator => 'SET', :operand => feed_item}
+  end
+  items_update_result = feed_item_srv.mutate(item_operations)
+  puts 'Updated %d items' % items_update_result[:value].length
+
+  # Update feed mapping.
+  mapping_selector = {
+    :fields => [
+      'FeedId',
+      'FeedMappingId',
+      'PlaceholderType',
+      'AttributeFieldMappings'
+    ],
+    :predicates => [
+      {:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]}
+    ]
+  }
+  feed_mapping_results = feed_mapping_srv.get(mapping_selector)
+  feed_mapping = feed_mapping_results[:entries][0]
+
+  # Feed mappings are immutable, so we have to delete it and re-add
+  # it with modifications.
+  feed_mapping_srv.mutate([
+    {:operator => 'REMOVE', :operand => feed_mapping}
+  ])[:value][0]
+
+  feed_mapping[:attribute_field_mappings].push(
+    {
+      :feed_attribute_id => line_1_attribute[:id],
+      :field_id => PLACEHOLDER_FIELD_LINE_1_TEXT
+    },
+    {
+      :feed_attribute_id => line_2_attribute[:id],
+      :field_id => PLACEHOLDER_FIELD_LINE_2_TEXT
+    }
+  )
+  mapping_update_result = feed_mapping_srv.mutate([
+    {:operator => 'ADD', :operand => feed_mapping}
+  ])
+
+  mutated_mapping = mapping_update_result[:value][0]
+  puts 'Updated field mappings for feedId %d and feedMappingId %d to:' %
+    [mutated_mapping[:feed_id], mutated_mapping[:feed_mapping_id]]
+  mutated_mapping[:attribute_field_mappings].each do |field_mapping|
+    puts "\tfeedAttributeId %d --> fieldId %d" %
+      [field_mapping[:feed_attribute_id], field_mapping[:field_id]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201309
+
+  # 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_FIELD_LINE_1_TEXT = 3
+  PLACEHOLDER_FIELD_LINE_2_TEXT = 4
+
+  begin
+    feed_id = 'INSERT_FEED_ID_HERE'.to_i
+    feed_item_descriptions = {
+      'INSERT_FEED_ITEM_A_ID_HERE'.to_i => [
+        'INSERT_FEED_ITEM_A_LINE1_DESC_HERE',
+        'INSERT_FEED_ITEM_A_LINE2_DESC_HERE'
+      ],
+      'INSERT_FEED_ITEM_B_ID_HERE'.to_i => [
+        'INSERT_FEED_ITEM_B_LINE1_DESC_HERE',
+        'INSERT_FEED_ITEM_B_LINE2_DESC_HERE'
+      ]
+    }
+
+    update_site_links(feed_id, feed_item_descriptions)
+
+  # 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/examples/v201309/misc/setup_oauth2.rb

@@ -33,7 +33,7 @@ def setup_oauth2()
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  # You can call authorize explicitely to obtain the access token. Otherwise, it
+  # You can call authorize explicitly to obtain the access token. Otherwise, it
   # will be invoked automatically on the first API call.
   # There are two ways to provide verification code, first one is via the block:
   token = adwords.authorize() do |auth_url|
@@ -44,7 +44,7 @@ def setup_oauth2()
   end
   if token
     print "\nWould you like to update your adwords_api.yml to save " +
-        "OAuth2 crdentials? (y/N): "
+        "OAuth2 credentials? (y/N): "
     response = gets.chomp
     if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
       adwords.save_oauth2_token(token)
@@ -54,12 +54,12 @@ def setup_oauth2()
   end
 
   # Alternatively, you can provide one within the parameters:
-  #token = adwords.authorize({:oauth2_verification_code => verification_code})
+  # token = adwords.authorize({:oauth2_verification_code => verification_code})
 
   # Note, 'token' is a Hash. Its value is not used in this example. If you need
   # to be able to access the API in offline mode, with no user present, you
   # should persist it to be used in subsequent invocations like this:
-  #adwords.authorize({:oauth2_token => token})
+  # adwords.authorize({:oauth2_token => token})
 
   # No exception thrown - we are good to make a request.
 end

data/examples/v201309/optimization/get_keyword_ideas.rb

@@ -53,7 +53,7 @@ def get_keyword_ideas(keyword_text)
         # Language setting (optional).
         # The ID can be found in the documentation:
         #  https://developers.google.com/adwords/api/docs/appendix/languagecodes
-        # As of v201302 only one LanguageSearchParameter is allowed per request.
+        # Only one LanguageSearchParameter is allowed per request.
         :xsi_type => 'LanguageSearchParameter',
         :languages => [{:id => 1000}]
       }

data/lib/adwords_api/api_config.rb

@@ -45,50 +45,6 @@ module AdwordsApi
 
     # Configure the services available to each version
     @@service_config = {
-      :v201302 => [
-          :AdExtensionOverrideService,
-          :AdGroupAdService,
-          :AdGroupBidModifierService,
-          :AdGroupCriterionService,
-          :AdGroupFeedService,
-          :AdGroupService,
-          :AdParamService,
-          :AlertService,
-          :BudgetOrderService,
-          :BudgetService,
-          :CampaignAdExtensionService,
-          :CampaignCriterionService,
-          :CampaignFeedService,
-          :CampaignService,
-          :CampaignSharedSetService,
-          :ConstantDataService,
-          :ConversionTrackerService,
-          :CustomerService,
-          :CustomerSyncService,
-          :DataService,
-          :ExperimentService,
-          :FeedItemService,
-          :FeedMappingService,
-          :FeedService,
-          :GeoLocationService,
-          :LocationCriterionService,
-          :ManagedCustomerService,
-          :MediaService,
-          :MutateJobService,
-          :ReportDefinitionService,
-          :SharedCriterionService,
-          :SharedSetService,
-          :TargetingIdeaService,
-          :TrafficEstimatorService,
-          :UserListService,
-          # AdWords for Video API Beta services.
-          :VideoAdService,
-          :VideoCampaignCriterionService,
-          :VideoCampaignService,
-          :VideoService,
-          :VideoTargetingGroupCriterionService,
-          :VideoTargetingGroupService
-      ],
       :v201306 => [
           :AdExtensionOverrideService,
           :AdGroupAdService,
@@ -172,7 +128,6 @@ module AdwordsApi
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
-        :v201302 => 'https://adwords.google.com/api/adwords/',
         :v201306 => 'https://adwords.google.com/api/adwords/',
         :v201309 => 'https://adwords.google.com/api/adwords/'
       }
@@ -181,49 +136,6 @@ module AdwordsApi
     # Configure the subdirectories for each version / service pair.
     # A missing pair means that only the base URL is used.
     @@subdir_config = {
-      # v201302
-      [:v201302, :AdExtensionOverrideService] => 'cm/',
-      [:v201302, :AdGroupAdService] => 'cm/',
-      [:v201302, :AdGroupBidModifierService] => 'cm/',
-      [:v201302, :AdGroupCriterionService] => 'cm/',
-      [:v201302, :AdGroupFeedService] => 'cm/',
-      [:v201302, :AdGroupService] => 'cm/',
-      [:v201302, :AdParamService] => 'cm/',
-      [:v201302, :AlertService] => 'mcm/',
-      [:v201302, :BudgetOrderService] => 'billing/',
-      [:v201302, :CampaignAdExtensionService] => 'cm/',
-      [:v201302, :CampaignCriterionService] => 'cm/',
-      [:v201302, :CampaignFeedService] => 'cm/',
-      [:v201302, :CampaignService] => 'cm/',
-      [:v201302, :CampaignSharedSetService] => 'cm/',
-      [:v201302, :ConstantDataService] => 'cm/',
-      [:v201302, :ConversionTrackerService] => 'cm/',
-      [:v201302, :CustomerSyncService] => 'ch/',
-      [:v201302, :DataService] => 'cm/',
-      [:v201302, :ExperimentService] => 'cm/',
-      [:v201302, :FeedItemService] => 'cm/',
-      [:v201302, :FeedMappingService] => 'cm/',
-      [:v201302, :FeedService] => 'cm/',
-      [:v201302, :GeoLocationService] => 'cm/',
-      [:v201302, :LocationCriterionService] => 'cm/',
-      [:v201302, :MediaService] => 'cm/',
-      [:v201302, :MutateJobService] => 'cm/',
-      [:v201302, :ReportDefinitionService] => 'cm/',
-      [:v201302, :SharedCriterionService] => 'cm/',
-      [:v201302, :SharedSetService] => 'cm/',
-      [:v201302, :TargetingIdeaService] => 'o/',
-      [:v201302, :TrafficEstimatorService] => 'o/',
-      [:v201302, :UserListService] => 'cm/',
-      [:v201302, :ManagedCustomerService] => 'mcm/',
-      [:v201302, :CustomerService] => 'mcm/',
-      [:v201302, :BudgetService] => 'cm/',
-      # AdWords for Video API Beta services.
-      [:v201302, :VideoAdService] => 'video/',
-      [:v201302, :VideoCampaignCriterionService] => 'video/',
-      [:v201302, :VideoCampaignService] => 'video/',
-      [:v201302, :VideoService] => 'video/',
-      [:v201302, :VideoTargetingGroupCriterionService] => 'video/',
-      [:v201302, :VideoTargetingGroupService] => 'video/',
       # v201306
       [:v201306, :AdExtensionOverrideService] => 'cm/',
       [:v201306, :AdGroupAdService] => 'cm/',