google-dfp-api 0.9.4 → 0.9.5

data/ChangeLog

@@ -1,3 +1,7 @@
+0.9.5:
+  - Added support for v201505.
+  - Removed examples for v201405.
+
 0.9.4:
   - Added support for v201502.
   - Removed support for v201311, v201308, and v201306.

data/README.md

@@ -105,9 +105,7 @@ or add it to the bash configuration file:
 
 ## Using OAuth2.0
 
-It is recommended to use OAuth2.0 authentication method instead of ClientLogin
-(explicit email/password combination). OAuth2.0 support is almost transparent to
-the library user. In order to use OAuth you just need to:
+In order to use OAuth you just need to:
 
   - set authentication method to 'OAuth2' in the configuration;
 

data/dfp_api.yml

@@ -4,8 +4,7 @@
 # Detailed descriptions of these properties can be found at:
 # https://developers.google.com/doubleclick-publishers/docs/soap_xml
 :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.
@@ -30,13 +29,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_PASSWORD_HERE
-  #:email: INSERT_EMAIL_HERE
-  # To manage your auth tokens manually, use the 'auth_token' property.
-  #:auth_token: INSERT_AUTH_TOKEN_HERE
-
   # Other parameters.
   :application_name: dfp_ruby_examples
 

data/examples/v201408/report_service/run_sales_report.rb

@@ -21,7 +21,7 @@
 # This example runs a report equal to the "Sales by salespersons report" on the
 # DFP website. To download the report see download_report.rb.
 #
-# Tags: ReportService.runReportJob, ReportService.getReportJob
+# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
@@ -59,9 +59,9 @@ def run_sales_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end

data/examples/v201411/report_service/run_sales_report.rb

@@ -21,7 +21,7 @@
 # This example runs a report equal to the "Sales by salespersons report" on the
 # DFP website. To download the report see download_report.rb.
 #
-# Tags: ReportService.runReportJob, ReportService.getReportJob
+# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
@@ -59,9 +59,9 @@ def run_sales_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end

data/examples/v201502/report_service/run_sales_report.rb

@@ -21,7 +21,7 @@
 # This example runs a report equal to the "Sales by salespersons report" on the
 # DFP website. To download the report see download_report.rb.
 #
-# Tags: ReportService.runReportJob, ReportService.getReportJob
+# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
@@ -59,9 +59,9 @@ def run_sales_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end

data/examples/{v201405 → v201505}/activity_group_service/create_activity_groups.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def create_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201405 → v201505}/activity_group_service/get_active_activity_groups.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.davidtorres@gmail.com (David Torres)
+# Author:: api.nicholaschen@gmail.com (Nicholas Chen)
 #
-# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
+# 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.
@@ -24,9 +24,9 @@
 # Tags: ActivityGroupService.getActivityGroupsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_active_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,38 +39,29 @@ def get_active_activity_groups()
   # Get the ActivityGroupService.
   activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to only select active activity groups.
+  statement = DfpApiStatement::FilterStatement.new(
+      'status = :status ORDER BY id ASC',
+      [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  )
 
   begin
-    # Create statement for one page with current offset.
-    statement = {
-       :query => 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d' %
-           [PAGE_SIZE, offset],
-       :values => [
-           {:key => 'status',
-            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
-       ]
-    }
-
     # Get activity groups by statement.
-    page = activity_group_service.get_activity_groups_by_statement(statement)
+    page = activity_group_service.get_activity_groups_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 content object in results page.
       page[:results].each_with_index do |activity_group, index|
-        puts "%d) Activity group with ID: %d, name: %s." % [index + start_index,
+        puts "%d) Activity group with ID: %d, name: %s." % [
+            index + statement.offset,
             activity_group[:id], activity_group[:name]]
       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/{v201405 → v201505}/activity_group_service/get_all_activity_groups.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.davidtorres@gmail.com (David Torres)
+# Author:: Nicholas Chen
 #
-# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
+# 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.
@@ -24,9 +24,9 @@
 # Tags: ActivityGroupService.getActivityGroupsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,37 +39,27 @@ def get_all_activity_groups()
   # Get the ActivityGroupService.
   activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to select all activity groups.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {
-       :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset],
-    }
-
     # Get activity groups by statement.
-    page = activity_group_service.get_activity_groups_by_statement(statement)
+    page = activity_group_service.get_activity_groups_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 content object in results page.
       page[:results].each_with_index do |activity_group, index|
-        puts "%d) Activity group with ID: %d, name: %s." % [index + start_index,
+        puts "%d) Activity group with ID: %d, name: %s." % [
+            index + statement.offset,
             activity_group[:id], activity_group[:name]]
       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)
-    puts "Total number of results: %d" % page[:total_result_set_size]
+    puts "Total number of results: %d" % page[:total_result_set_sizet]
   end
 end
 

data/examples/{v201405 → v201505}/activity_group_service/update_activity_groups.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def update_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,15 +44,17 @@ def update_activity_groups()
   advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
 
   # Create statement to select a single activity group.
-  statement = {
-     :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-     :values => [
-         {:key => 'id',
-          :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
-     ]
-  }
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
-  page = activity_group_service.get_activity_groups_by_statement(statement)
+  page = activity_group_service.get_activity_groups_by_statement(
+      statement.toStatement())
 
   if page[:results]
     # Get the activity groups.

data/examples/{v201405 → v201505}/activity_service/create_activities.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def create_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201405 → v201505}/activity_service/get_active_activities.rb

@@ -24,9 +24,9 @@
 # Tags: ActivityService.getActivitiesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_active_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,41 +39,29 @@ def get_active_activities()
   # Get the ActivityService.
   activity_service = dfp.service(:ActivityService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to only select active activities.
+  statement = DfpApiStatement::FilterStatement.new(
+      'status = :status ORDER BY id ASC',
+      [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  )
 
   begin
-    # Create statement for one page with current offset.
-    statement = {
-       :query => 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d' %
-           [PAGE_SIZE, offset],
-       :values => [
-         {
-           :key => 'status',
-           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
-         }
-       ]
-    }
-
     # Get activities by statement.
-    page = activity_service.get_activities_by_statement(statement)
+    page = activity_service.get_activities_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 content object in results page.
       page[:results].each_with_index do |activity, index|
         puts "%d) Activity with ID: %d, name: %s, type: %s." %
-            [index + start_index, activity[:id], activity[:name],
+            [index + statement.offset, activity[:id], activity[:name],
                 activity[:type]]
       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/{v201405 → v201505}/activity_service/get_all_activities.rb

@@ -24,9 +24,9 @@
 # Tags: ActivityService.getActivitiesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,36 +39,25 @@ def get_all_activities()
   # Get the ActivityService.
   activity_service = dfp.service(:ActivityService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to select all activities.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Update statement for one page with current offset.
-    statement = {
-        :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]
-    }
-
     # Get activities by statement.
-    page = activity_service.get_activities_by_statement(statement)
+    page = activity_service.get_activities_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 content object in results page.
       page[:results].each_with_index do |activity, index|
         puts "%d) Activity with ID: %d, name: %s, type: %s." %
-            [index + start_index, activity[:id], activity[:name],
+            [index + statement.offset, activity[:id], activity[:name],
              activity[:type]]
       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.
+  # Print a footer
   if page.include?(:total_result_set_size)
     puts "Total number of results: %d" % page[:total_result_set_size]
   end

data/examples/{v201405 → v201505}/activity_service/update_activities.rb

@@ -25,8 +25,9 @@
 # Tags: ActivityService.updateActivities
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def update_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,15 +44,16 @@ def update_activities()
   activity_id = 'INSERT_ACTIVITY_ID_HERE'
 
   # Create statement to select a single activity.
-  statement = {
-     :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE id = :id ORDER BY id ASC',
+     [
          {:key => 'id',
           :value => {:value => activity_id, :xsi_type => 'NumberValue'}}
-     ]
-  }
+     ],
+     1
+  )
 
-  page = activity_service.get_activities_by_statement(statement)
+  page = activity_service.get_activities_by_statement(statement.toStatement())
 
   if page[:results]
     # Get the activities.