google-adwords-api 0.14.2 → 0.15.0

data/examples/v201502/extensions/add_site_links_using_feeds.rb

@@ -46,7 +46,7 @@ def add_site_links(campaign_id)
     :name => 'Feed For Site Links',
     :attributes => [
       {:type => 'STRING', :name => 'Link Text'},
-      {:type => 'URL', :name => 'Link URL'},
+      {:type => 'URL_LIST', :name => 'Final URLs'},
       {:type => 'STRING', :name => 'Line 1 Description'},
       {:type => 'STRING', :name => 'Line 2 Description'}
     ]
@@ -59,7 +59,7 @@ def add_site_links(campaign_id)
     feed = response[:value].first
     # Attribute of type STRING.
     link_text_feed_attribute_id = feed[:attributes][0][:id]
-    # Attribute of type URL.
+    # Attribute of type URL_LIST.
     final_url_feed_attribute_id = feed[:attributes][1][:id]
     # Attribute of type STRING.
     line_1_feed_attribute_id = feed[:attributes][2][:id]
@@ -67,7 +67,7 @@ def add_site_links(campaign_id)
     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 Final URL attribute ID %d " +
+    puts "\tText attribute ID %d and Final URLs attribute ID %d " +
         "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
           link_text_feed_attribute_id,
           final_url_feed_attribute_id,
@@ -88,37 +88,37 @@ def add_site_links(campaign_id)
   items_data = [
     {
       :text => 'Home',
-      :url => 'http://www.example.com',
+      :final_urls => ['http://www.example.com'],
       :line_1 => 'Home line 1',
       :line_2 => 'Home line 2'
     },
     {
       :text => 'Stores',
-      :url => 'http://www.example.com/stores',
+      :final_urls => ['http://www.example.com/stores'],
       :line_1 => 'Stores line 1',
       :line_2 => 'Stores line 2'
      },
     {
       :text => 'On Sale',
-      :url => 'http://www.example.com/sale',
+      :final_urls => ['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',
+      :final_urls => ['http://www.example.com/support'],
       :line_1 => 'Support line 1',
       :line_2 => 'Support line 2'
     },
     {
       :text => 'Products',
-      :url => 'http://www.example.com/products',
+      :final_urls => ['http://www.example.com/products'],
       :line_1 => 'Products line 1',
       :line_2 => 'Products line 2'
     },
     {
       :text => 'About',
-      :url => 'http://www.example.com/about',
+      :final_urls => ['http://www.example.com/about'],
       :line_1 => 'About line 1',
       :line_2 => 'About line 2'
     }
@@ -134,7 +134,7 @@ def add_site_links(campaign_id)
         },
         {
           :feed_attribute_id => sitelinks_data[:final_url_feed_id],
-          :string_value => item[:url]
+          :string_values => item[:final_urls]
         },
         {
           :feed_attribute_id => sitelinks_data[:line_1_feed_id],
@@ -174,7 +174,7 @@ def add_site_links(campaign_id)
       },
       {
         :feed_attribute_id => sitelinks_data[:final_url_feed_id],
-        :field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URL
+        :field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
       },
       {
         :feed_attribute_id => sitelinks_data[:line_1_feed_id],
@@ -202,50 +202,20 @@ def add_site_links(campaign_id)
     raise new StandardError, 'No feed mappings were added.'
   end
 
-  # Create site links campaign feed.
-  operands = sitelinks_data[:feed_item_ids].map do |feed_item_id|
-    {
-      :xsi_type => 'ConstantOperand',
-      :type => 'LONG',
-      :long_value => feed_item_id
-    }
-  end
-
-  feed_item_function = {
-    :operator => 'IN',
-    :lhs_operand => [
-      {:xsi_type => 'RequestContextOperand', :context_type => 'FEED_ITEM_ID'}
-    ],
-    :rhs_operand => operands
-  }
-
-  # Optional: to target to a platform, define a function and 'AND' it with the
-  #           feed item ID link:
-  platform_function = {
-    :operator => 'EQUALS',
-    :lhs_operand => [
-      {:xsi_type => 'RequestContextOperand', :context_type => 'DEVICE_PLATFORM'}
-    ],
-    :rhs_operand => [
-      {
-        :xsi_type => 'ConstantOperand',
-        :type => 'STRING',
-        :string_value => 'Mobile'
-      }
-    ]
-  }
-  combined_function = {
-    :operator => 'AND',
-    :lhs_operand => [
-      {:xsi_type => 'FunctionOperand', :value => feed_item_function},
-      {:xsi_type => 'FunctionOperand', :value => platform_function}
-    ]
-  }
+  # Construct a matching function that associates the sitelink feeditems to the
+  # campaign, and set the device preference to Mobile. See the matching function
+  # guide at:
+  # https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
+  # for more details.
+  matching_function_string =
+      "AND(IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, 'Mobile'))" %
+      sitelinks_data[:feed_item_ids].join(',')
 
+  # Create site links campaign feed.
   campaign_feed = {
     :feed_id => sitelinks_data[:feed_id],
     :campaign_id => campaign_id,
-    :matching_function => combined_function,
+    :matching_function => {:function_string => matching_function_string},
     # Specifying placeholder types on the CampaignFeed allows the same feed
     # to be used for different placeholders in different Campaigns.
     :placeholder_types => [PLACEHOLDER_SITELINKS]
@@ -271,7 +241,7 @@ if __FILE__ == $0
   #     https://developers.google.com/adwords/api/docs/appendix/placeholders
   PLACEHOLDER_SITELINKS = 1
   PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
-  PLACEHOLDER_FIELD_SITELINK_FINAL_URL = 5
+  PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
   PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
   PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
 

data/examples/v201502/migration/migrate_to_extension_settings.rb

@@ -64,13 +64,15 @@ def migrate_to_extension_settings()
         next
       end
 
+      platform_restrictions = get_platform_restrictions(campaign_feed)
+
       # Delete the campaign feed that associates the sitelinks from the
       # feed to the campaign.
       delete_campaign_feed(adwords, campaign_feed)
 
       # Create extension settings instead of sitelinks.
       create_extension_setting(adwords, feed_items, campaign_feed,
-          feed_item_ids)
+          feed_item_ids, platform_restrictions)
 
       # Mark the sitelinks from the feed for deletion.
       feed_item_ids
@@ -201,6 +203,26 @@ def get_feed_items(adwords, feed)
   return feed_items
 end
 
+def get_platform_restrictions(campaign_feed)
+  platform_restrictions = nil
+
+  if campaign_feed[:matching_function][:operator] == 'AND'
+    campaign_feed[:matching_function][:lhs_operand].each do |argument|
+      # Check if matchingFunction is EQUALS(CONTEXT.DEVICE, 'Mobile')
+      if argument[:value][:operator] == 'EQUALS'
+        request_context_operand = argument[:value][:lhs_operand].first()
+        if request_context_operand &&
+            request_context_operand == 'DEVICE_PLATFORM'
+          platform_restrictions =
+              argument[:value][:rhs_operand].first().upcase()
+          break
+        end
+      end
+    end
+  end
+  return platform_restrictions
+end
+
 def delete_old_feed_items(adwords, feed_item_ids, feed)
   return if feed_item_ids.empty?
 
@@ -219,7 +241,8 @@ def delete_old_feed_items(adwords, feed_item_ids, feed)
   feed_item_srv.mutate(operations)
 end
 
-def create_extension_setting(adwords, feed_items, campaign_feed, feed_item_ids)
+def create_extension_setting(
+    adwords, feed_items, campaign_feed, feed_item_ids, platform_restrictions)
   campaign_extension_setting_srv = adwords.service(
       :CampaignExtensionSettingService, API_VERSION)
 
@@ -254,6 +277,10 @@ def create_extension_setting(adwords, feed_items, campaign_feed, feed_item_ids)
     :extensions => extension_feed_items
   }
 
+  unless platform_restrictions.nil?
+    extension_setting[:platform_restrictions] = platform_restrictions
+  end
+
   campaign_extension_setting = {
     :campaign_id => campaign_feed[:campaign_id],
     :extension_type => 'SITELINK',

data/lib/adwords_api.rb

@@ -72,35 +72,6 @@ module AdwordsApi
                                   default_ns, version)
     end
 
-    # Helper method to provide a simple way of doing an MCC-level operation
-    # without the need to change credentials. Executes a block of code as an
-    # MCC-level operation and/or returns the current status of the property.
-    #
-    # Args:
-    # - accepts a block, which it will execute as an MCC-level operation
-    #
-    # Returns:
-    # - block execution result, if block given
-    # - boolean indicating whether MCC-level operations are currently
-    #   enabled or disabled, if no block provided
-    #
-    def use_mcc(&block)
-      return (block_given?) ?
-        run_with_temporary_flag(:@use_mcc, true, block) :
-        @credential_handler.use_mcc
-    end
-
-    # Helper method to provide a simple way of doing an MCC-level operation
-    # without the need to change credentials. Sets the value of the property
-    # that controls whether MCC-level operations are enabled or disabled.
-    #
-    # Args:
-    # - value: the new value for the property (boolean)
-    #
-    def use_mcc=(value)
-      @credential_handler.use_mcc = value
-    end
-
     # Helper method to provide a simple way of doing a validate-only operation
     # without the need to change credentials. Executes a block of code as an
     # validate-only operation and/or returns the current status of the property.
@@ -148,6 +119,15 @@ module AdwordsApi
       @config.set('library.skip_report_summary', value)
     end
 
+    # Helper method to skip the column header when downloading reports.
+    #
+    # Args:
+    # - value: whether to skip the column header (boolean)
+    #
+    def skip_column_header=(value)
+      @config.set('library.skip_column_header', value)
+    end
+
     # Helper method to provide a simple way of performing requests with support
     # for partial failures. Executes a block of code with partial failures
     # enabled and/or returns the current status of the property.

data/lib/adwords_api/api_config.rb

@@ -45,46 +45,6 @@ module AdwordsApi
 
     # Configure the services available to each version
     @@service_config = {
-      :v201406 => [
-          :AdGroupAdService,
-          :AdGroupBidModifierService,
-          :AdGroupCriterionService,
-          :AdGroupFeedService,
-          :AdGroupService,
-          :AdParamService,
-          :AdwordsUserListService,
-          :AlertService,
-          :BiddingStrategyService,
-          :BudgetOrderService,
-          :BudgetService,
-          :CampaignAdExtensionService,
-          :CampaignCriterionService,
-          :CampaignFeedService,
-          :CampaignService,
-          :CampaignSharedSetService,
-          :ConstantDataService,
-          :ConversionTrackerService,
-          :CustomerFeedService,
-          :CustomerService,
-          :CustomerSyncService,
-          :DataService,
-          :ExperimentService,
-          :FeedItemService,
-          :FeedMappingService,
-          :FeedService,
-          :GeoLocationService,
-          :LabelService,
-          :LocationCriterionService,
-          :ManagedCustomerService,
-          :MediaService,
-          :MutateJobService,
-          :OfflineConversionFeedService,
-          :ReportDefinitionService,
-          :SharedCriterionService,
-          :SharedSetService,
-          :TargetingIdeaService,
-          :TrafficEstimatorService
-      ],
       :v201409 => [
           :AdCustomizerFeedService,
           :AdGroupAdService,
@@ -178,7 +138,6 @@ module AdwordsApi
       :PRODUCTION => {
         :oauth_scope => 'https://www.googleapis.com/auth/adwords',
         :header_ns => 'https://adwords.google.com/api/adwords/cm/',
-        :v201406 => 'https://adwords.google.com/api/adwords/',
         :v201409 => 'https://adwords.google.com/api/adwords/',
         :v201502 => 'https://adwords.google.com/api/adwords/'
       }
@@ -187,45 +146,6 @@ module AdwordsApi
     # Configure the subdirectories for each version / service pair.
     # A missing pair means that only the base URL is used.
     @@subdir_config = {
-      # v201406
-      [:v201406, :AdGroupAdService] => 'cm/',
-      [:v201406, :AdGroupBidModifierService] => 'cm/',
-      [:v201406, :AdGroupCriterionService] => 'cm/',
-      [:v201406, :AdGroupFeedService] => 'cm/',
-      [:v201406, :AdGroupService] => 'cm/',
-      [:v201406, :AdParamService] => 'cm/',
-      [:v201406, :AlertService] => 'mcm/',
-      [:v201406, :BudgetOrderService] => 'billing/',
-      [:v201406, :CampaignAdExtensionService] => 'cm/',
-      [:v201406, :CampaignCriterionService] => 'cm/',
-      [:v201406, :CampaignFeedService] => 'cm/',
-      [:v201406, :CampaignService] => 'cm/',
-      [:v201406, :CampaignSharedSetService] => 'cm/',
-      [:v201406, :ConstantDataService] => 'cm/',
-      [:v201406, :ConversionTrackerService] => 'cm/',
-      [:v201406, :CustomerSyncService] => 'ch/',
-      [:v201406, :DataService] => 'cm/',
-      [:v201406, :ExperimentService] => 'cm/',
-      [:v201406, :FeedItemService] => 'cm/',
-      [:v201406, :FeedMappingService] => 'cm/',
-      [:v201406, :FeedService] => 'cm/',
-      [:v201406, :GeoLocationService] => 'cm/',
-      [:v201406, :LocationCriterionService] => 'cm/',
-      [:v201406, :MediaService] => 'cm/',
-      [:v201406, :MutateJobService] => 'cm/',
-      [:v201406, :OfflineConversionFeedService] => 'cm/',
-      [:v201406, :ReportDefinitionService] => 'cm/',
-      [:v201406, :SharedCriterionService] => 'cm/',
-      [:v201406, :SharedSetService] => 'cm/',
-      [:v201406, :TargetingIdeaService] => 'o/',
-      [:v201406, :TrafficEstimatorService] => 'o/',
-      [:v201406, :ManagedCustomerService] => 'mcm/',
-      [:v201406, :CustomerService] => 'mcm/',
-      [:v201406, :CustomerFeedService] => 'cm/',
-      [:v201406, :BudgetService] => 'cm/',
-      [:v201406, :BiddingStrategyService] => 'cm/',
-      [:v201406, :AdwordsUserListService] => 'rm/',
-      [:v201406, :LabelService] => 'cm/',
       # v201409
       [:v201409, :AdCustomizerFeedService] => 'cm/',
       [:v201409, :AdGroupAdService] => 'cm/',

data/lib/adwords_api/credential_handler.rb

@@ -24,8 +24,6 @@ require 'adwords_api/api_config'
 
 module AdwordsApi
   class CredentialHandler < AdsCommon::CredentialHandler
-    # Whether we're making MCC-level requests.
-    attr_accessor :use_mcc
     # Whether we're making validate-only requests.
     attr_accessor :validate_only
     # Whether we're making partial failure requests.
@@ -33,7 +31,6 @@ module AdwordsApi
 
     def initialize(config)
       super(config)
-      @use_mcc = false
       @validate_only = false
       @partial_failure = false
     end
@@ -48,9 +45,7 @@ module AdwordsApi
         'userAgent' => generate_user_agent(),
         'developerToken' => result[:developer_token]
       }
-      if !@use_mcc and result[:client_customer_id]
-        extra_headers['clientCustomerId'] = result[:client_customer_id]
-      end
+      extra_headers['clientCustomerId'] = result[:client_customer_id]
       extra_headers['validateOnly'] = 'true' if @validate_only
       extra_headers['partialFailure'] = 'true' if @partial_failure
       result[:extra_headers] = extra_headers
@@ -75,9 +70,13 @@ module AdwordsApi
     #
     def validate_headers_for_server(credentials)
       client_customer_id = credentials[:client_customer_id]
-      if client_customer_id and
-          !(client_customer_id.is_a?(Integer) or
-            (client_customer_id =~ /^\d+(-\d+-\d+)?$/))
+      unless client_customer_id
+        raise AdwordsApi::Errors::BadCredentialsError,
+            'Missing client customer ID for the request.'
+      end
+
+      if !(client_customer_id.is_a?(Integer) or
+          (client_customer_id =~ /^\d+(-\d+-\d+)?$/))
         raise AdwordsApi::Errors::BadCredentialsError,
             'Invalid client customer ID: %s' % client_customer_id.to_s
       end

data/lib/adwords_api/report_header_handler.rb

@@ -56,11 +56,15 @@ module AdwordsApi
       }
       skip_report_header = @config.read('library.skip_report_header')
       unless skip_report_header.nil?
-        headers['skipReportHeader'] = skip_report_header.to_s
+        headers['skipReportHeader'] = skip_report_header
       end
       skip_report_summary = @config.read('library.skip_report_summary')
       unless skip_report_summary.nil?
-        headers['skipReportSummary'] = skip_report_summary.to_s
+        headers['skipReportSummary'] = skip_report_summary
+      end
+      skip_column_header = @config.read('library.skip_column_header')
+      unless skip_column_header.nil?
+        headers['skipColumnHeader'] = skip_column_header
       end
       return headers
     end

data/lib/adwords_api/version.rb

@@ -21,6 +21,6 @@
 
 module AdwordsApi
   module ApiConfig
-    CLIENT_LIB_VERSION = '0.14.2'
+    CLIENT_LIB_VERSION = '0.15.0'
   end
 end

data/test/adwords_api/test_adwords_api.rb

@@ -57,15 +57,6 @@ class TestAdwordsApi < Test::Unit::TestCase
     end
   end
 
-  def test_use_mcc()
-    adwords_api = AdwordsApi::Api.new({})
-    adwords_api.use_mcc = false
-    assert(!adwords_api.use_mcc)
-    adwords_api.use_mcc do
-      assert(adwords_api.use_mcc)
-    end
-  end
-
   def test_validate_only()
     adwords_api = AdwordsApi::Api.new({})
     adwords_api.validate_only = false