google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/user_service/get_current_user.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,12 +17,10 @@
 #           limitations under the License.
 #
 # This example gets the current user.
-#
-# Tags: UserService.getCurrentUser
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_current_user()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/user_service/get_users_by_statement.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,14 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users sorted by name. The statement retrieves up to the
-# maximum page size limit of 500. To create new users, run create_users.rb.
-#
-# Tags: UserService.getUsersByStatement
+# This example gets all users sorted by name. To create new users, run
+# create_users.rb.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_users_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,17 +36,21 @@ def get_users_by_statement()
   user_service = dfp.service(:UserService, API_VERSION)
 
   # Create a statement to get all users sorted by id.
-  statement = {:query => 'ORDER BY id ASC LIMIT 500'}
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY name ASC')
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  begin
+    # Get users by statement.
+    page = user_service.get_users_by_statement(statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |user, index|
-      puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [index,
-          user[:id], user[:name], user[:email], user[:role_name]]
+    if page and page[:results]
+      page[:results].each_with_index do |user, index|
+        puts "%d) User ID: %d, name: %s, email: %s, role: %s." % [
+            index + statement.offset, user[:id], user[:name], user[:email],
+            user[:role_name]]
+      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/{v201408 → v201508}/user_service/update_users.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,15 +16,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates all users by adding "Sr." to the end of each name (after
-# a very large baby boom and lack of creativity). To determine which users
-# exist, run get_all_users.rb.
-#
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
+# This example updates all users by adding "Sr." to the end of a single user.
+# To determine which users exist, run get_all_users.rb.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,11 +35,20 @@ def update_users()
   # Get the UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
   # Create a statement to get all users.
-  statement = {:query => 'LIMIT 500'}
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+         {:key => 'id',
+          :value => {:value => user_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
   # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  page = user_service.get_users_by_statement(statement.toStatement())
 
   if page[:results]
     users = page[:results]

data/examples/{v201408 → v201508}/user_team_association_service/create_user_team_associations.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,12 +19,10 @@
 # This example adds a user to a team by creating an association between the two.
 # To determine which teams exist, run get_all_teams.rb. To determine which users
 # exist, run get_all_users.rb.
-#
-# Tags: UserTeamAssociationService.createUserTeamAssociations
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def create_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/user_team_association_service/delete_user_team_associations.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,14 +18,11 @@
 #
 # This example removes the user from all its teams. To determine which users
 # exist, run get_all_users.rb.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
-# Tags: UserTeamAssociationService.performUserTeamAssociationAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def delete_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,42 +39,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/{v201408 → v201508}/user_team_association_service/get_all_user_team_associations.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,13 +18,11 @@
 #
 # This example gets all user team associations. To create user team
 # associations, run create_user_team_assocations.rb.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_all_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,32 +35,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 => "ORDER BY id ASC 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/{v201408 → v201508}/user_team_association_service/get_user_team_associations_by_statement.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,17 +16,13 @@
 #           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.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
-# Tags: UserService.getCurrentUser
+# This example gets all teams that the current user belongs to.
+# To create teams, run create_user_team_associations.rb.
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def get_user_team_associations_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -48,23 +42,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 ORDER BY id ASC 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/{v201408 → v201508}/user_team_association_service/update_user_team_associations.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,14 +20,11 @@
 # association by setting the overridden access type to read only for the first
 # 500 teams that the user belongs to. To determine which users exists, run
 # get_all_users.rb.
-#
-# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
-# Tags: UserTeamAssociationService.updateUserTeamAssociations
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
-PAGE_SIZE = 500
+API_VERSION = :v201508
 
 def update_user_team_associations()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -46,16 +41,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

@@ -1,7 +1,5 @@
 # Encoding: utf-8
 #
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");

data/lib/dfp_api/api_config.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,9 +33,9 @@ module DfpApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201505
+    DEFAULT_VERSION = :v201508
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201505
+    LATEST_VERSION = :v201508
 
     # Set other constants
     API_NAME = 'DfpApi'
@@ -153,6 +151,30 @@ module DfpApi
                    :ReconciliationReportService, :ReportService,
                    :SharedAdUnitService, :SuggestedAdUnitService,
                    :TeamService, :UserService,
+                   :UserTeamAssociationService, :WorkflowRequestService],
+      :v201508 => [:ActivityGroupService, :ActivityService,
+                   :AdExclusionRuleService, :AdRuleService,
+                   :AudienceSegmentService, :BaseRateService, :CompanyService,
+                   :ContactService, :ContentBundleService,
+                   :ContentMetadataKeyHierarchyService, :ContentService,
+                   :CreativeService, :CreativeSetService,
+                   :CreativeTemplateService, :CreativeWrapperService,
+                   :CustomFieldService, :CustomTargetingService,
+                   :ExchangeRateService, :ForecastService, :InventoryService,
+                   :LabelService, :LineItemCreativeAssociationService,
+                   :LineItemService, :LineItemTemplateService,
+                   :NetworkService, :LiveStreamEventService,
+                   :OrderService, :PackageService, :ProductPackageService,
+                   :ProductPackageItemService, :PlacementService,
+                   :PremiumRateService, :ProductService,
+                   :ProductTemplateService, :ProposalLineItemService,
+                   :ProposalService, :PublisherQueryLanguageService,
+                   :RateCardService, :ReconciliationOrderReportService,
+                   :ReconciliationLineItemReportService,
+                   :ReconciliationReportRowService,
+                   :ReconciliationReportService, :ReportService,
+                   :SharedAdUnitService, :SuggestedAdUnitService,
+                   :TeamService, :UserService,
                    :UserTeamAssociationService, :WorkflowRequestService]
     }
 
@@ -165,7 +187,8 @@ module DfpApi
         :v201408 => 'https://ads.google.com/apis/ads/publisher/',
         :v201411 => 'https://ads.google.com/apis/ads/publisher/',
         :v201502 => 'https://ads.google.com/apis/ads/publisher/',
-        :v201505 => 'https://ads.google.com/apis/ads/publisher/'
+        :v201505 => 'https://ads.google.com/apis/ads/publisher/',
+        :v201508 => 'https://ads.google.com/apis/ads/publisher/'
       }
     }