google-dfp-api 0.6.3 → 0.7.0

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

@@ -18,13 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all audience segments.
+# This code example gets all audience segments. To create audience segments, run
+# create_audience_segments.rb.
 #
 # Tags: AudienceSegmentService.getAudienceSegmentsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201203
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_audience_segments()
@@ -59,7 +60,7 @@ 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" %
+        puts "%d) Audience segment ID: %d, name: '%s'" %
             [index + start_index, segment[:id], segment[:name]]
       end
     end

data/examples/{v201204/audience_segment_service/get_all_audience_segments.rb → v201308/audience_segment_service/get_first_party_audience_segments.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+# 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.
@@ -18,16 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all audience segments.
+# 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 = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
-def get_all_audience_segments()
+def get_first_party_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -38,13 +39,17 @@ def get_all_audience_segments()
   # 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 => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+    statement = {:query => statement_text % [PAGE_SIZE, offset]}
 
     # Get audience segments by statement.
     page =
@@ -59,7 +64,7 @@ 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" %
+        puts "%d) First party audience segment ID: %d, name: '%s'" %
             [index + start_index, segment[:id], segment[:name]]
       end
     end
@@ -67,13 +72,14 @@ def get_all_audience_segments()
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of audience segments: %d" % page[: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_all_audience_segments()
+    get_first_party_audience_segments()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201308/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 = :v201308
+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/v201308/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 = :v201308
+
+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/{v201204 → v201308}/common/error_handling.rb

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

data/examples/{v201206 → v201308}/common/oauth2_handling.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 PAGE_SIZE = 500
 MAX_RETRIES = 3
 

data/examples/{v201206/user_service/get_all_users.rb → v201308/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,17 @@
 #           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 shows how to use OAuth2.0 authorization method with JWT (Service
+# Account).
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 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 +36,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 +87,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_users()
+    oauth2_jwt_handling()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201204 → v201308}/company_service/create_companies.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201204 → v201308}/company_service/get_all_companies.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201204
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
 def get_all_companies()

data/examples/{v201204 → v201308}/company_service/get_companies_by_statement.rb

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

data/examples/{v201204 → v201308}/company_service/get_company.rb

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

data/examples/{v201206 → v201308}/company_service/update_companies.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -55,7 +55,14 @@ def update_companies()
     companies = page[:results]
 
     # Update each local company object by appending ' LLC.' to its name.
-    companies.each {|company| company[:name] += ' LLC.'}
+    companies.each do |company|
+      company[:name] += ' LLC.'
+      # Workaround for issue #94.
+      [:address, :email, :fax_phone, :primary_phone,
+          :external_id, :comment].each do |item|
+        company[item] = "" if company[item].nil?
+      end
+    end
 
     # Update the companies on the server.
     return_companies = company_service.update_companies(companies)