google-dfp-api 0.7.0 → 0.7.1

data/examples/v201311/audience_segment_service/get_first_party_audience_segments.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 code example gets all first party audience segments. To create audience
+# segments, run create_audience_segments.rb.
+#
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def get_first_party_audience_segments()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  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')
+
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
+
+  # Statement parts to help build a statement to select all first party audience
+  # segments.
+  statement_text = "WHERE type = 'FIRST_PARTY' ORDER BY id LIMIT %d OFFSET %d"
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
+
+    # Get audience segments by statement.
+    page =
+        audience_segment_service.get_audience_segments_by_statement(statement)
+
+    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 audience segment in results page.
+      page[:results].each_with_index do |segment, index|
+        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' %
+        page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_first_party_audience_segments()
+
+  # 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

data/examples/v201311/audience_segment_service/populate_first_party_audience_segments.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 code example populates specific rule based first party audience segment.
+# To determine which audience segments exist, run get_audience_segments.rb.
+#
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
+# Tags: AudienceSegmentService.performAudienceSegmentAction
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+PAGE_SIZE = 500
+
+def populate_first_party_audience_segments(audience_segment_id)
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  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')
+
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
+
+  # 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',
+    :values => [
+      {:key => 'type',
+       :value => {:value => 'FIRST_PARTY', :xsi_type => 'TextValue'}},
+      {:key => 'audience_segment_id',
+       :value => {:value => audience_segment_id, :xsi_type => 'TextValue'}},
+    ]
+  }
+
+  # Get audience segments by statement.
+  page = audience_segment_service.get_audience_segments_by_statement(statement)
+
+  if page[:results]
+    page[:results].each do |segment|
+      puts "First party audience segment ID: %d, name: '%s' will be populated" %
+          [segment[:id], segment[:name]]
+
+      # Perform action.
+      result = audience_segment_service.perform_audience_segment_action(
+          {:xsi_type => 'PopulateAudienceSegments'}, {:query => statement})
+
+      # Display results.
+      if result and result[:num_changes] > 0
+        puts 'Number of audience segments populated: %d.' % result[:num_changes]
+      else
+        puts 'No audience segments were populated.'
+      end
+    end
+  else
+    puts 'No first party audience segments found to populate.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    # Audience segment ID to populate.
+    audience_segment_id = 'INSERT_AUDIENCE_SEGMENT_ID_HERE'
+
+    populate_first_party_audience_segments(audience_segment_id)
+
+  # 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

data/examples/v201311/audience_segment_service/update_audience_segments.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2013, 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 updates rule based first party audience segments. To determine
+# which first party audience segments exist, run
+# get_all_first_party_audience_segments.rb.
+#
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
+# Tags: AudienceSegmentService.updateAudienceSegments
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def update_audience_segments()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  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')
+
+  # Set the ID of the first party audience segment to update.
+  audience_segment_id = 'INSERT_AUDIENCE_SEGMENT_ID_HERE'
+
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
+
+  # Create statement text to select the audience segment to update.
+  statement = {
+    :query => 'WHERE id = :segment_id',
+    :values => [
+      {
+        :key => 'segment_id',
+        :value => {:value => audience_segment_id, :xsi_type => 'NumberValue'}
+      }
+    ]
+  }
+
+  # Get audience segments by statement.
+  page = audience_segment_service.get_audience_segments_by_statement(statement)
+
+  if page[:results]
+    audience_segments = page[:results]
+
+    # Create a local set of audience segments than need to be updated.
+    audience_segments.each do |audience_segment|
+      audience_segment[:membership_expiration_days] = 180
+    end
+
+    # Update the audience segments on the server.
+    return_audience_segments =
+        audience_segment_service.update_audience_segments(audience_segments)
+    return_audience_segments.each do |audience_segment|
+      puts 'Audience segment ID: %d was updated' % audience_segment[:id]
+    end
+  else
+    puts 'No audience segments found to update.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_audience_segments()
+
+  # 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

data/examples/v201311/common/error_handling.rb

@@ -0,0 +1,76 @@
+#!/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");
+#           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 runs incorrect query and demonstrates how to handle errors.
+#
+# Tags: UserService.updateUser
+
+require 'dfp_api'
+
+API_VERSION = :v201311
+
+def produce_api_error()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  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')
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Omitting "id" field here to produce an error.
+  user = {:preferred_locale => 'en_UK', :name => 'foo_bar'}
+
+  # Execute request and get the response, this should raise an exception.
+  user = user_service.update_user(user)
+
+  # Output retrieved data.
+  puts "User ID: %d, name: %s, email: %s" %
+      [user[:id], user[:name], user[:email]]
+end
+
+if __FILE__ == $0
+  begin
+    # This function should produce an exception for demo.
+    produce_api_error()
+
+  # One of two kinds of exception might occur, general HTTP error like 403 or
+  # 404 and DFP API error defined in WSDL and described in documentation.
+
+  # Handling HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # Handling API errors.
+  rescue DfpApi::Errors::ApiException => e
+    # Standard DFP API error includes message and array of errors occured.
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    # Print out each of the 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

data/examples/{v201208/common/oauth2_handling.rb → v201311/common/oauth2_jwt_handling.rb}

@@ -18,18 +18,17 @@
 #           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.
+# This example shows how to use OAuth2.0 authorization method with JWT (Service
+# Account).
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201208
+API_VERSION = :v201311
 PAGE_SIZE = 500
-MAX_RETRIES = 3
 
-def oauth2_handling()
+def oauth2_jwt_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -37,14 +36,19 @@ def oauth2_handling()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Forcing authorization. A callback URL and other parameters could be
-  # specified as parameter for OAuth method.
-  token = dfp.authorize({:oauth_callback => 'oob'}) do |oauth_url|
-    # For command-line we ask user to go to URL and type in code.
-    verification_code = get_verification_code(oauth_url)
-    # Return verification code from the block.
-    (verification_code.empty?) ? nil : verification_code
-  end
+  # 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)
@@ -52,30 +56,13 @@ def oauth2_handling()
   # Define initial values.
   offset = 0
   page = Hash.new
-  retry_count = 0
 
   begin
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    begin
-      # Get users by statement.
-      page = user_service.get_users_by_statement(statement)
-
-    # The second way to do OAuth authentication is to make a request and catch
-    # the OAuthVerificationRequired exception. Add the verification code to the
-    # credentials once acquired.
-    rescue AdsCommon::Errors::OAuth2VerificationRequired => e
-      if retry_count < MAX_RETRIES
-        verification_code = get_verification_code(e.oauth_url)
-        dfp.credential_handler.set_credential(
-            :oauth2_verification_code, verification_code)
-        retry_count += 1
-        retry
-      else
-        raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-      end
-    end
+    # Get users by statement.
+    page = user_service.get_users_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -98,17 +85,9 @@ def oauth2_handling()
   end
 end
 
-# Misc util to get the verification code from the console.
-def get_verification_code(url)
-  puts "Hit Auth error, please navigate to URL:\n\t%s" % url
-  print 'Log in and type the verification code: '
-  verification_code = gets.chomp
-  return verification_code
-end
-
 if __FILE__ == $0
   begin
-    oauth2_handling()
+    oauth2_jwt_handling()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e