google-dfp-api 0.8.1 → 0.9.0

data/ChangeLog

@@ -1,3 +1,12 @@
+0.9.0:
+  - Added support and examples for v201408.
+  - Removed RateCardCustomizationService and RateCardCustomizationGroupService.
+  - Added PremiumRateService to replace the aforementioned RateCard related
+    services.
+  - Removed support for deprecated v201208, v201211, 201302.
+  - Changed OAuth2 scope to https://www.googleapis.com/auth/dfp
+  - Changed DFP server endpoint to https://ads.google.com
+
 0.8.1:
   - Added support and examples for v201405.
 

data/examples/v201405/report_service/run_inventory_report.rb

@@ -45,12 +45,12 @@ def run_inventory_report()
   root_ad_unit_id =
       network_service.get_current_network()[:effective_root_ad_unit_id]
 
-  # Create statement to filter on an ancestor ad unit with the root ad unit ID
+  # Create statement to filter on a parent ad unit with the root ad unit ID
   # to include all ad units in the network.
   statement = {
-     :query => 'WHERE AD_UNIT_ANCESTOR_AD_UNIT_ID = :ancestor_ad_unit_id',
+     :query => 'WHERE PARENT_AD_UNIT_ID = :parent_ad_unit_id',
      :values => [
-         {:key => 'ancestor_ad_unit_id',
+         {:key => 'parent_ad_unit_id',
           :value => {:value => root_ad_unit_id, :xsi_type => 'NumberValue'}}
      ]
   }

data/examples/{v201308 → v201408}/activity_group_service/create_activity_groups.rb

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

data/examples/{v201306 → v201408}/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 = :v201306
-PAGE_SIZE = 500
+API_VERSION = :v201408
 
 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/{v201306 → v201408}/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:: 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 = :v201306
-PAGE_SIZE = 500
+API_VERSION = :v201408
 
 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/{v201306 → v201408}/activity_group_service/update_activity_groups.rb

@@ -21,12 +21,12 @@
 # This example updates activity groups by adding a company. To determine which
 # activity groups exist, run get_all_activity_groups.rb.
 #
-# Tags: ActivityGroupService.getActivityGroup
+# Tags: ActivityGroupService.getActivityGroupsByStatement
 # Tags: ActivityGroupService.updateActivityGroups
 
 require 'dfp_api'
 
-API_VERSION = :v201306
+API_VERSION = :v201408
 
 def update_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,26 +43,37 @@ def update_activity_groups()
   activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
   advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
 
-  # Get the activity group.
-  activity_group = activity_group_service.get_activity_group(activity_group_id)
+  # Create statement to select a single activity group.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id ORDER BY id ASC',
+      [
+          {:key => 'id',
+           :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  )
 
-  # Update the companies.
-  activity_group[:company_ids] << advertiser_company_id
+  page = activity_group_service.get_activity_groups_by_statement(
+      statement.toStatement())
 
-  # Update the activity groups on the server.
-  return_activity_groups = activity_group_service.update_activity_groups([
-      activity_group])
+  if page[:results]
+    # Get the activity groups.
+    activity_groups = page[:results]
+
+    activity_groups.each do |activity_group|
+      # Update the companies.
+      activity_group[:company_ids] << advertiser_company_id
+    end
+
+    # Update the activity groups on the server.
+    return_activity_groups = activity_group_service.update_activity_groups(
+        activity_groups)
 
-  # Display results.
-  if return_activity_groups
     return_activity_groups.each do |updates_activity_group|
       puts "Activity group with ID: %d and name: %s was updated." %
           [updates_activity_group[:id], updates_activity_group[:name]]
     end
-  else
-    raise 'No activity groups were updated.'
   end
-
 end
 
 if __FILE__ == $0

data/examples/{v201302 → v201408}/activity_service/create_activities.rb

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

data/examples/{v201302 → v201408}/activity_service/get_active_activities.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
 def get_active_activities()
@@ -39,9 +39,6 @@ def get_active_activities()
   # Get the ActivityService.
   activity_service = dfp.service(:ActivityService, API_VERSION)
 
-  # Set the ID of the activity group these activities are associated with.
-  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
-
   # Define initial values.
   offset = 0
   page = {}
@@ -49,14 +46,13 @@ def get_active_activities()
   begin
     # Create statement for one page with current offset.
     statement = {
-       :query => ('WHERE activityGroupId = :activityGroupId AND ' +
-           'status = :status ORDER BY id LIMIT %d OFFSET %d') %
-               [PAGE_SIZE, offset],
+       :query => 'WHERE status = :status ORDER BY id LIMIT %d OFFSET %d' %
+           [PAGE_SIZE, offset],
        :values => [
-           {:key => 'status',
-            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}},
-           {:key => 'activityGroupId',
-            :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
+         {
+           :key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}
+         }
        ]
     }
 

data/examples/{v201308/activity_service/get_active_activities.rb → v201408/activity_service/get_all_activities.rb}

@@ -18,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all active activities. To create activities,
+# This example gets all activities. To create activities,
 # run create_activities.rb.
 #
 # Tags: ActivityService.getActivitiesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201408
 PAGE_SIZE = 500
 
-def get_active_activities()
+def get_all_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -39,25 +39,14 @@ def get_active_activities()
   # Get the ActivityService.
   activity_service = dfp.service(:ActivityService, API_VERSION)
 
-  # Set the ID of the activity group these activities are associated with.
-  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
-
   # Define initial values.
   offset = 0
   page = {}
 
   begin
-    # Create statement for one page with current offset.
+    # Update statement for one page with current offset.
     statement = {
-       :query => ('WHERE activityGroupId = :activityGroupId AND ' +
-           'status = :status ORDER BY id LIMIT %d OFFSET %d') %
-               [PAGE_SIZE, offset],
-       :values => [
-           {:key => 'status',
-            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}},
-           {:key => 'activityGroupId',
-            :value => {:value => activity_group_id, :xsi_type => 'NumberValue'}}
-       ]
+        :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset]
     }
 
     # Get activities by statement.
@@ -74,12 +63,12 @@ def get_active_activities()
       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],
-                activity[:type]]
+             activity[:type]]
       end
     end
   end while 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
@@ -87,7 +76,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_active_activities()
+    get_all_activities()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201302 → v201408}/activity_service/update_activities.rb

@@ -21,12 +21,12 @@
 # This example updates activity expected URLs. To determine which activities
 # exist, run get_all_activities.rb.
 #
-# Tags: ActivityService.getActivity
+# Tags: ActivityService.getActivitiesByStatement
 # Tags: ActivityService.updateActivities
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201408
 
 def update_activities()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,25 +42,39 @@ def update_activities()
   # Set the ID of the activity to update.
   activity_id = 'INSERT_ACTIVITY_ID_HERE'
 
-  # Get the activity.
-  activity = activity_service.get_activity(activity_id)
+  # Create statement to select a single activity.
+  statement = {
+     :query => 'WHERE id = :id ORDER BY id ASC LIMIT 1',
+     :values => [
+         {:key => 'id',
+          :value => {:value => activity_id, :xsi_type => 'NumberValue'}}
+     ]
+  }
 
-  # Update the expected URL.
-  activity[:expected_url] = 'https://www.google.com'
+  page = activity_service.get_activities_by_statement(statement)
 
-  # Update the activity on the server.
-  return_activities = activity_service.update_activities([activity])
+  if page[:results]
+    # Get the activities.
+    activities = page[:results]
 
-  # Display results.
-  if return_activities
-    return_activities.each do |updated_activity|
-      puts "Activity with ID: %d and name: %s was updated." %
-          [updated_activity[:id], updated_activity[:name]]
+    activites.each do |activity|
+      # Update the expected URL.
+      activity[:expected_url] = 'https://www.google.com'
     end
-  else
-    raise 'No activities were updated.'
-  end
 
+    # Update the activity on the server.
+    return_activities = activity_service.update_activities(activities)
+
+    # Display results.
+    if return_activities
+      return_activities.each do |updated_activity|
+        puts "Activity with ID: %d and name: %s was updated." %
+            [updated_activity[:id], updated_activity[:name]]
+      end
+    else
+      raise 'No activities were updated.'
+    end
+  end
 end
 
 if __FILE__ == $0

data/examples/{v201308 → v201408}/audience_segment_service/create_audience_segments.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201408
 
 def create_audience_segments(custom_targeting_key_id, custom_targeting_value_id)
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.