google-dfp-api 0.9.3 → 0.9.4

data/examples/{v201403 → v201502}/user_team_association_service/create_user_team_associations.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def create_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201403 → v201502}/user_team_association_service/delete_user_team_associations.rb

@@ -25,9 +25,9 @@
 # Tags: UserTeamAssociationService.performUserTeamAssociationAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def delete_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,42 +44,34 @@ def delete_user_team_associations()
   user_id = 'INSERT_USER_ID_HERE'.to_i
 
   # Create filter text to remove association by user ID.
-  statement_text = 'WHERE userId = :user_id'
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE userId = :user_id',
+      [
           {:key => 'user_id',
            :value => {:value => user_id, :xsi_type => 'NumberValue'}}
       ]
-  }
-
-  offset = 0
-  page = {}
+  )
 
   begin
-    # Update statement with the current offset.
-    statement[:query] = statement_text + " LIMIT %d OFFSET %d" %
-        [PAGE_SIZE, offset]
-
     # Get user team associations by statement.
-    page = uta_service.get_user_team_associations_by_statement(statement)
+    page = uta_service.get_user_team_associations_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
       page[:results].each do |association|
         puts ("User team association of user ID %d with team ID %d will be " +
             "deleted.") % [association[:user_id], association[:team_id]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
-  # Update statement for deletion.
-  statement[:query] = statement_text
+  # Reset offset back to 0 to perform action.
+  statement.toStatementForAction()
 
   # Perform the action.
   result = uta_service.perform_user_team_association_action(
-      {:xsi_type => 'DeleteUserTeamAssociations'}, statement)
+      {:xsi_type => 'DeleteUserTeamAssociations'}, statement.toStatement())
 
   # Display results.
   if result and result[:num_changes] > 0

data/examples/{v201403 → v201502}/user_team_association_service/get_all_user_team_associations.rb

@@ -24,9 +24,9 @@
 # Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,31 +39,24 @@ def get_all_user_team_associations()
   # Get the UserTeamAssociationService.
   uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for all user team associations.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get the user team associations by statement.
-    page = uta_service.get_user_team_associations_by_statement(statement)
+    page = uta_service.get_user_team_associations_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each user team association in results page.
       page[:results].each_with_index do |association, index|
         puts "%d) User team association between team ID: %d and user ID %d" %
-            [index + start_index, association[:team_id], association[:user_id]]
+            [index + statement.offset,
+             association[:team_id], association[:user_id]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)

data/examples/{v201403 → v201502}/user_team_association_service/get_user_team_associations_by_statement.rb

@@ -18,17 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all teams that the current user belongs to. The statement
-# retrieves up to the maximum page size limit of 500. To create teams, run
-# create_user_team_associations.rb.
+# This example gets all teams that the current user belongs to.
+# To create teams, run create_user_team_associations.rb.
 #
 # Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
 # Tags: UserService.getCurrentUser
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_user_team_associations_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -48,23 +47,28 @@ def get_user_team_associations_by_statement()
   user = user_service.get_current_user()
 
   # Create filter text to select user team associations by the user ID.
-  statement = {
-      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE userId = :user_id ORDER BY id',
+      [
           {:key => 'user_id',
            :value => {:value => user[:id], :xsi_type => 'NumberValue'}},
       ]
-  }
+  )
 
-  # Get user team associations by statement.
-  page = uta_service.get_user_team_associations_by_statement(statement)
+  begin
+    # Get user team associations by statement.
+    page = uta_service.get_user_team_associations_by_statement(
+        statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |association, index|
-      puts "%d) Team user association between team ID %d and user ID %d." %
-          [index, association[:team_id], association[:user_id]]
+    if page and page[:results]
+      page[:results].each_with_index do |association, index|
+        puts "%d) Team user association between team ID %d and user ID %d." %
+            [index + statement.offset, association[:team_id],
+             association[:user_id]]
+      end
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201403 → v201502}/user_team_association_service/update_user_team_associations.rb

@@ -27,9 +27,9 @@
 # Tags: UserTeamAssociationService.updateUserTeamAssociations
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def update_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,16 +46,17 @@ def update_user_team_associations()
   user_id = 'INSERT_USER_ID_HERE'.to_i
 
   # Create filter text to select user team associations by the user ID.
-  statement = {
-      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE userId = :user_id ORDER BY id ASC',
+      [
           {:key => 'user_id',
            :value => {:value => user_id, :xsi_type => 'NumberValue'}},
       ]
-  }
+  )
 
   # Get user team associations by statement.
-  page = uta_service.get_user_team_associations_by_statement(statement)
+  page = uta_service.get_user_team_associations_by_statement(
+      statement.toStatement())
 
   if page[:results] and !page[:results].empty?
     associations = page[:results]

data/lib/dfp_api.rb

@@ -22,7 +22,6 @@
 require 'ads_common/api'
 require 'ads_common/savon_headers/oauth_header_handler'
 require 'dfp_api/api_config'
-require 'dfp_api/client_login_header_handler'
 require 'dfp_api/credential_handler'
 require 'dfp_api/errors'
 
@@ -51,15 +50,6 @@ module DfpApi
     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
-          if version.to_s[/\d+/].to_i > 201311
-            raise AdsCommon::Errors::AuthError,
-                "ClientLogin is not supported for versions after v201311. " +
-                "Please use OAuth2 instead. See here for details:\n\n\t" +
-                "https://developers.google.com/doubleclick-publishers/docs/" +
-                "authentication"
-          end
-          DfpApi::ClientLoginHeaderHandler
         when :OAUTH2, :OAUTH2_JWT
           AdsCommon::SavonHeaders::OAuthHeaderHandler
         else

data/lib/dfp_api/api_config.rb

@@ -35,9 +35,9 @@ module DfpApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201411
+    DEFAULT_VERSION = :v201502
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201411
+    LATEST_VERSION = :v201502
 
     # Set other constants
     API_NAME = 'DfpApi'
@@ -45,45 +45,7 @@ module DfpApi
 
     # Configure the services available to each version
     @@service_config = {
-      :v201306 => [:CompanyService, :CreativeService, :ForecastService,
-                   :InventoryService, :LineItemCreativeAssociationService,
-                   :LineItemService, :NetworkService, :OrderService,
-                   :PlacementService, :ReportService, :UserService,
-                   :CustomTargetingService, :PublisherQueryLanguageService,
-                   :LabelService, :ContentService, :SuggestedAdUnitService,
-                   :CreativeTemplateService, :TeamService,
-                   :AudienceSegmentService, :CustomFieldService,
-                   :UserTeamAssociationService, :CreativeSetService,
-                   :CreativeWrapperService, :ActivityGroupService,
-                   :ActivityService, :AdRuleService, :ContactService,
-                   :ContentBundleService, :BaseRateService, :ProductService,
-                   :ProductTemplateService, :ProposalService,
-                   :ProposalLineItemService, :RateCardService,
-                   :RateCardCustomizationService,
-                   :ReconciliationOrderReportService,
-                   :ReconciliationReportService,
-                   :ReconciliationReportRowService,
-                   :WorkflowActionService, :LineItemTemplateService],
-      :v201308 => [:CompanyService, :CreativeService, :ForecastService,
-                   :InventoryService, :LineItemCreativeAssociationService,
-                   :LineItemService, :NetworkService, :OrderService,
-                   :PlacementService, :ReportService, :UserService,
-                   :CustomTargetingService, :PublisherQueryLanguageService,
-                   :LabelService, :ContentService, :SuggestedAdUnitService,
-                   :CreativeTemplateService, :TeamService,
-                   :AudienceSegmentService, :CustomFieldService,
-                   :UserTeamAssociationService, :CreativeSetService,
-                   :CreativeWrapperService, :ActivityGroupService,
-                   :ActivityService, :AdRuleService, :ContactService,
-                   :ContentBundleService, :BaseRateService, :ProductService,
-                   :ProductTemplateService, :ProposalService,
-                   :ProposalLineItemService, :RateCardService,
-                   :RateCardCustomizationService,
-                   :ReconciliationOrderReportService,
-                   :ReconciliationReportService,
-                   :ReconciliationReportRowService,
-                   :WorkflowActionService, :LineItemTemplateService],
-      :v201311 => [:ActivityGroupService, :ActivityService, :AdRuleService,
+      :v201403 => [:ActivityGroupService, :ActivityService, :AdRuleService,
                    :AudienceSegmentService, :BaseRateService, :CompanyService,
                    :ContactService, :ContentBundleService,
                    :ContentMetadataKeyHierarchyService, :ContentService,
@@ -92,17 +54,19 @@ module DfpApi
                    :CustomFieldService, :CustomTargetingService,
                    :ExchangeRateService, :ForecastService, :InventoryService,
                    :LabelService, :LineItemCreativeAssociationService,
-                   :LineItemService, :LineItemTemplateService, :NetworkService,
+                   :LineItemService, :LineItemTemplateService,
+                   :NetworkService, :LiveStreamEventService,
                    :OrderService, :PlacementService, :ProductService,
                    :ProductTemplateService, :ProposalLineItemService,
                    :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardCustomizationService, :RateCardService,
+                   :RateCardCustomizationService,
+                   :RateCardCustomizationGroupService, :RateCardService,
                    :ReconciliationOrderReportService,
                    :ReconciliationReportRowService,
                    :ReconciliationReportService, :ReportService,
                    :SuggestedAdUnitService, :TeamService, :UserService,
                    :UserTeamAssociationService, :WorkflowRequestService],
-      :v201403 => [:ActivityGroupService, :ActivityService, :AdRuleService,
+      :v201405 => [:ActivityGroupService, :ActivityService, :AdRuleService,
                    :AudienceSegmentService, :BaseRateService, :CompanyService,
                    :ContactService, :ContentBundleService,
                    :ContentMetadataKeyHierarchyService, :ContentService,
@@ -123,7 +87,7 @@ module DfpApi
                    :ReconciliationReportService, :ReportService,
                    :SuggestedAdUnitService, :TeamService, :UserService,
                    :UserTeamAssociationService, :WorkflowRequestService],
-      :v201405 => [:ActivityGroupService, :ActivityService, :AdRuleService,
+      :v201408 => [:ActivityGroupService, :ActivityService, :AdRuleService,
                    :AudienceSegmentService, :BaseRateService, :CompanyService,
                    :ContactService, :ContentBundleService,
                    :ContentMetadataKeyHierarchyService, :ContentService,
@@ -134,17 +98,17 @@ module DfpApi
                    :LabelService, :LineItemCreativeAssociationService,
                    :LineItemService, :LineItemTemplateService,
                    :NetworkService, :LiveStreamEventService,
-                   :OrderService, :PlacementService, :ProductService,
+                   :OrderService, :PlacementService,
+                   :PremiumRateService, :ProductService,
                    :ProductTemplateService, :ProposalLineItemService,
                    :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardCustomizationService,
-                   :RateCardCustomizationGroupService, :RateCardService,
-                   :ReconciliationOrderReportService,
+                   :RateCardService, :ReconciliationOrderReportService,
                    :ReconciliationReportRowService,
                    :ReconciliationReportService, :ReportService,
                    :SuggestedAdUnitService, :TeamService, :UserService,
                    :UserTeamAssociationService, :WorkflowRequestService],
-      :v201408 => [:ActivityGroupService, :ActivityService, :AdRuleService,
+      :v201411 => [:ActivityGroupService, :ActivityService,
+                   :AdExclusionRuleService, :AdRuleService,
                    :AudienceSegmentService, :BaseRateService, :CompanyService,
                    :ContactService, :ContentBundleService,
                    :ContentMetadataKeyHierarchyService, :ContentService,
@@ -162,9 +126,10 @@ module DfpApi
                    :RateCardService, :ReconciliationOrderReportService,
                    :ReconciliationReportRowService,
                    :ReconciliationReportService, :ReportService,
-                   :SuggestedAdUnitService, :TeamService, :UserService,
+                   :SharedAdUnitService, :SuggestedAdUnitService,
+                   :TeamService, :UserService,
                    :UserTeamAssociationService, :WorkflowRequestService],
-      :v201411 => [:ActivityGroupService, :ActivityService,
+      :v201502 => [:ActivityGroupService, :ActivityService,
                    :AdExclusionRuleService, :AdRuleService,
                    :AudienceSegmentService, :BaseRateService, :CompanyService,
                    :ContactService, :ContentBundleService,
@@ -176,7 +141,8 @@ module DfpApi
                    :LabelService, :LineItemCreativeAssociationService,
                    :LineItemService, :LineItemTemplateService,
                    :NetworkService, :LiveStreamEventService,
-                   :OrderService, :PlacementService,
+                   :OrderService, :PackageService, :ProductPackageService,
+                   :ProductPackageItemService, :PlacementService,
                    :PremiumRateService, :ProductService,
                    :ProductTemplateService, :ProposalLineItemService,
                    :ProposalService, :PublisherQueryLanguageService,
@@ -193,20 +159,13 @@ module DfpApi
       :PRODUCTION => {
         :oauth_scope => 'https://www.googleapis.com/auth/dfp',
         :header_ns => 'https://www.google.com/apis/ads/publisher/',
-        :v201306 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201308 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201311 => 'https://ads.google.com/apis/ads/publisher/',
         :v201403 => 'https://ads.google.com/apis/ads/publisher/',
         :v201405 => 'https://ads.google.com/apis/ads/publisher/',
         :v201408 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201411 => 'https://ads.google.com/apis/ads/publisher/'
-      }
-    }
+        :v201411 => 'https://ads.google.com/apis/ads/publisher/',
+        :v201502 => 'https://ads.google.com/apis/ads/publisher/'
 
-    # Auth constants for ClientLogin method.
-    @@client_login_config = {
-      :AUTH_SERVER => 'https://www.google.com',
-      :LOGIN_SERVICE_NAME => 'gam'
+      }
     }
 
     public
@@ -241,10 +200,6 @@ module DfpApi
       nil
     end
 
-    def self.client_login_config(key)
-      return @@client_login_config[key]
-    end
-
     def self.default_config_filename
       DEFAULT_CONFIG_FILENAME
     end

data/lib/dfp_api/{v201308 → v201502}/activity_group_service.rb

@@ -5,38 +5,26 @@
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.9.6 on 2014-08-12 14:20:05.
+# Code generated by AdsCommon library 0.9.5 on 2015-02-11 12:49:59.
 
 require 'ads_common/savon_service'
-require 'dfp_api/v201308/activity_group_service_registry'
+require 'dfp_api/v201502/activity_group_service_registry'
 
-module DfpApi; module V201308; module ActivityGroupService
+module DfpApi; module V201502; module ActivityGroupService
   class ActivityGroupService < AdsCommon::SavonService
     def initialize(config, endpoint)
-      namespace = 'https://www.google.com/apis/ads/publisher/v201308'
-      super(config, endpoint, namespace, :v201308)
-    end
-
-    def create_activity_group(*args, &block)
-      return execute_action('create_activity_group', args, &block)
+      namespace = 'https://www.google.com/apis/ads/publisher/v201502'
+      super(config, endpoint, namespace, :v201502)
     end
 
     def create_activity_groups(*args, &block)
       return execute_action('create_activity_groups', args, &block)
     end
 
-    def get_activity_group(*args, &block)
-      return execute_action('get_activity_group', args, &block)
-    end
-
     def get_activity_groups_by_statement(*args, &block)
       return execute_action('get_activity_groups_by_statement', args, &block)
     end
 
-    def update_activity_group(*args, &block)
-      return execute_action('update_activity_group', args, &block)
-    end
-
     def update_activity_groups(*args, &block)
       return execute_action('update_activity_groups', args, &block)
     end
@@ -48,7 +36,7 @@ module DfpApi; module V201308; module ActivityGroupService
     end
 
     def get_module()
-      return DfpApi::V201308::ActivityGroupService
+      return DfpApi::V201502::ActivityGroupService
     end
   end
 end; end; end