google-dfp-api 0.7.1 → 0.8.0

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

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

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

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201302
+API_VERSION = :v201403
 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 → v201403/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 = :v201403
 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/{v201308 → v201403}/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 = :v201308
+API_VERSION = :v201403
 
 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 → v201403}/audience_segment_service/create_audience_segments.rb

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

data/examples/{v201308 → v201403}/audience_segment_service/get_all_audience_segments.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_all_audience_segments()
@@ -60,8 +60,8 @@ def get_all_audience_segments()
 
       # Print details about each audience segment in results page.
       page[:results].each_with_index do |segment, index|
-        puts "%d) Audience segment ID: %d, name: '%s'" %
-            [index + start_index, segment[:id], segment[:name]]
+        puts "%d) Audience segment ID: %d, name: '%s' of size %d" %
+            [index + start_index, segment[:id], segment[:name], segment[:size]]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201308 → v201403}/audience_segment_service/get_first_party_audience_segments.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def get_first_party_audience_segments()
@@ -64,15 +64,15 @@ def get_first_party_audience_segments()
 
       # Print details about each audience segment in results page.
       page[:results].each_with_index do |segment, index|
-        puts "%d) First party audience segment ID: %d, name: '%s'" %
-            [index + start_index, segment[:id], segment[:name]]
+        puts "%d) First party audience segment ID: %d, name: '%s', size %d" %
+            [index + start_index, segment[:id], segment[:name], segment[:size]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of first party audience segments: %d" %
+    puts 'Total number of first party audience segments: %d' %
         page[:total_result_set_size]
   end
 end

data/examples/{v201308 → v201403}/audience_segment_service/populate_first_party_audience_segments.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
 def populate_first_party_audience_segments(audience_segment_id)
@@ -43,7 +43,8 @@ def populate_first_party_audience_segments(audience_segment_id)
   # Statement parts to help build a statement to select first party audience
   # segment for an ID.
   statement = {
-    :query => 'WHERE type = :type AND Id = :audience_segment_id LIMIT 1',
+    :query => 'WHERE type = :type AND Id = :audience_segment_id ' +
+        'ORDER BY id ASC LIMIT 1',
     :values => [
       {:key => 'type',
        :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}},

data/examples/{v201308 → v201403}/audience_segment_service/update_audience_segments.rb

@@ -27,7 +27,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201308
+API_VERSION = :v201403
 
 def update_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -45,7 +45,7 @@ def update_audience_segments()
 
   # Create statement text to select the audience segment to update.
   statement = {
-    :query => 'WHERE id = :segment_id',
+    :query => 'WHERE id = :segment_id ORDER BY id ASC LIMIT 1',
     :values => [
       {
         :key => 'segment_id',

data/examples/{v201302 → v201403}/common/error_handling.rb

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

data/examples/{v201208/user_service/get_all_users.rb → v201403/common/oauth2_jwt_handling.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -18,17 +18,21 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users for an account. To create users run
-# create_users.rb.
+# This example illustrates how to use OAuth2.0 authentication method with
+# Service Account (JWT). For this example to work, your Service Account must be
+# a Google Apps for Business Account.
+#
+# See https://developers.google.com/doubleclick-publishers/docs/service_accounts
+# for more information.
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201403
 PAGE_SIZE = 500
 
-def get_all_users()
+def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,12 +40,26 @@ def get_all_users()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
+  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
+  #           configuration file. No additional code is necessary.
+  # To provide a file name at runtime, use authorize:
+  # dfp.authorize({:oauth2_keyfile => key_filename})
+
+  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
+  # key_filename = 'INSERT_FILENAME_HERE'
+  # key_secret = 'INSERT_SECRET_HERE'
+  # key_file_data = File.read(key_filename)
+  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
+  # dfp.authorize({:oauth2_key => key})
+
+  # Now you can make API calls.
+
   # Get the UserService.
   user_service = dfp.service(:UserService, API_VERSION)
 
   # Define initial values.
   offset = 0
-  page = {}
+  page = Hash.new
 
   begin
     # Create statement for one page with current offset.
@@ -73,7 +91,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_users()
+    oauth2_jwt_handling()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201403/common/setup_oauth2.rb

@@ -0,0 +1,89 @@
+#!/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");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
+#
+# Tags: UserService.getUsersByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201403
+
+def setup_oauth2()
+  # DfpApi::Api will read a config file from ENV['HOME']/dfp_api.yml
+  # when called without parameters.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # You can call authorize explicitly to obtain the access token. Otherwise, it
+  # will be invoked automatically on the first API call.
+  # There are two ways to provide verification code, first one is via the block:
+  token = dfp.authorize() do |auth_url|
+    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
+    print 'log in and type the verification code: '
+    verification_code = gets.chomp
+    verification_code
+  end
+  if token
+    print "\nWould you like to update your dfp_api.yml to save " +
+        "OAuth2 credentials? (y/N): "
+    response = gets.chomp
+    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
+      dfp.save_oauth2_token(token)
+      puts 'OAuth2 token is now saved to ~/dfp_api.yml and will be ' +
+          'automatically used by the library.'
+    end
+  end
+
+  # Alternatively, you can provide one within the parameters:
+  # token = dfp.authorize({:oauth2_verification_code => verification_code})
+
+  # Note, 'token' is a Hash. Its value is not used in this example. If you need
+  # to be able to access the API in offline mode, with no user present, you
+  # should persist it to be used in subsequent invocations like this:
+  # dfp.authorize({:oauth2_token => token})
+
+  # No exception thrown - we are good to make a request.
+end
+
+if __FILE__ == $0
+  begin
+    setup_oauth2()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end