google-dfp-api 0.6.3 → 0.7.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTk4NTYxNTQwMjZkN2YyMDRiZmE1MjNjODQ2MzgxYTRiZDM1ODBmMQ==
+  data.tar.gz: !binary |-
+    YjE1Y2QxODM4MzYyOTFmNjMzYTgwMTQ3OGEwYWY5N2ZhODY2ZDM0YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzUzNjYyYTQ4ZTVhMDU3MjJkZTk5NTY5OWRhMmZmYmY4NTY1NTcxMzhmNzJm
+    NzUzYzJjNjEyMWY4OTI3OTYxOTVhMWMzOWRjNGMyOWJjNDA3NjdmODU4Nzk0
+    YjFhY2EwZmM2MDdmZjMzYzFlOTgwNzM5Y2M0NjhiNzVjODhiMjc=
+  data.tar.gz: !binary |-
+    MTRhYmE2YmRmNWYzYTQwNWVhZjU1NmRmZGM4ZGFlZGU5MDBkZjBhZDdhMTgz
+    OTY5MDhjZWNlYTY2ODM3MjVhZDgxMTFjMDhjZTJiY2IzMTgyYWY1ZTk4Yjhl
+    MjkxYmUwNjhkZDdjNzJjZWZmMjAzMmVkYWM2NDUxNTk4M2QzZmU=

data/ChangeLog

@@ -1,3 +1,7 @@
+0.7.0:
+  - Added support and examples for v201308.
+  - Removed support for deprecated v201203, v201204, v201206.
+
 0.6.3:
   - Added support and examples for v201306.
 

data/README

@@ -116,7 +116,7 @@ Once the library object is created you can request services with a 'service'
 method:
   user_service = dfp.service(:UserService, <API_VERSION>)
 
-where <API_VERSION> is required version of DFP API as symbol, e.g. :v201306.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201308.
 
 Then you should be able to execute service methods:
 
@@ -150,7 +150,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201306/user_service
+  $ cd examples/v201308/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example

data/dfp_api.yml

@@ -40,9 +40,7 @@
   # Other parameters.
   :application_name: dfp_ruby_examples
 
-  # Starting in v201203, network_code is required for all calls other than
-  # GetAllNetworks and MakeTestNetwork. In earlier versions, networkCode is
-  # optional if the user belongs to only one network.
+  # Required for all calls other than GetAllNetworks and MakeTestNetwork.
   :network_code: INSERT_NETWORK_CODE_HERE
 :service:
   # Only production environment is now available.

data/examples/v201208/publisher_query_language_service/get_all_cities.rb

@@ -21,7 +21,7 @@
 # This example gets first 500 cities available to target. A full list of
 # available tables can be found at:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 

data/examples/v201211/publisher_query_language_service/get_all_cities.rb

@@ -21,7 +21,7 @@
 # This example gets first 500 cities available to target. A full list of
 # available tables can be found at:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 

data/examples/v201302/publisher_query_language_service/get_all_cities.rb

@@ -21,7 +21,7 @@
 # This example gets first 500 cities available to target. A full list of
 # available tables can be found at:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 

data/examples/v201306/publisher_query_language_service/get_all_cities.rb

@@ -21,7 +21,7 @@
 # This example gets first 500 cities available to target. A full list of
 # available tables can be found at:
 #
-# https://developers.google.com/doubleclick-publishers/docs/reference/v201204/PublisherQueryLanguageService
+# https://developers.google.com/doubleclick-publishers/docs/reference/latest/PublisherQueryLanguageService
 #
 # Tags: PublisherQueryLanguageService.select
 

data/examples/v201308/activity_group_service/create_activity_groups.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 creates new activity groups. To determine which activity groups
+# exist, run get_all_activity_groups.rb.
+#
+# Tags: ActivityGroupService.createActivityGroups
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+
+def create_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Set the ID of the advertiser company this activity group is associated
+  # with.
+  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE';
+
+  # Create a short-term activity group.
+  short_term_activity_group = {
+    :name => 'Short-term activity group',
+    :company_ids => [advertiser_company_id],
+    :clicks_lookback => 1,
+    :impressions_lookback => 1
+  }
+
+  # Create a long-term activity group.
+  long_term_activity_group = {
+    :name => 'Long-term activity group',
+    :company_ids => [advertiser_company_id],
+    :clicks_lookback => 30,
+    :impressions_lookback => 30
+  }
+
+  # Create the activity groups on the server.
+  return_activity_groups = activity_group_service.create_activity_groups([
+      short_term_activity_group, long_term_activity_group])
+
+  if return_activity_groups
+    return_activity_groups.each do |activity_group|
+      puts "An activity group with ID: %d and name: %s was created." %
+          [activity_group[:id], activity_group[:name]]
+    end
+  else
+    raise 'No activity groups were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_activity_groups()
+
+  # 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/activity_group_service/get_active_activity_groups.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.davidtorres@gmail.com (David Torres)
+#
+# 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 gets all active activity groups. To create activity groups,
+# run create_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroupsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201308
+PAGE_SIZE = 500
+
+def get_active_activity_groups()
+  # 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 ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  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)
+
+    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,
+            activity_group[:id], activity_group[:name]]
+      end
+    end
+  end while 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]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_active_activity_groups()
+
+  # 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/{v201203/content_service/get_all_content.rb → v201308/activity_group_service/get_all_activity_groups.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, 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.
@@ -17,18 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all content.
+# This example gets all activity groups. To create activity groups,
+# run create_activity_groups.rb.
 #
-# This feature is only available to DFP video publishers.
-#
-# Tags: ContentService.getContentByStatement
+# Tags: ActivityGroupService.getActivityGroupsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201203
+API_VERSION = :v201308
 PAGE_SIZE = 500
 
-def get_all_content()
+def get_all_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,8 +36,8 @@ def get_all_content()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the ContentService.
-  content_service = dfp.service(:ContentService, API_VERSION)
+  # Get the ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -45,10 +45,12 @@ def get_all_content()
 
   begin
     # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+    statement = {
+       :query => 'ORDER BY id LIMIT %d OFFSET %d' % [PAGE_SIZE, offset],
+    }
 
-    # Get content by statement.
-    page = content_service.get_content_by_statement(statement)
+    # Get activity groups by statement.
+    page = activity_group_service.get_activity_groups_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -58,9 +60,9 @@ def get_all_content()
       start_index = page[:start_index]
 
       # Print details about each content object in results page.
-      page[:results].each_with_index do |content, index|
-        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
-             content[:id], content[:name], content[:status]]
+      page[:results].each_with_index do |activity_group, index|
+        puts "%d) Activity group with ID: %d, name: %s." % [index + start_index,
+            activity_group[:id], activity_group[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
@@ -73,7 +75,7 @@ end
 
 if __FILE__ == $0
   begin
-    get_all_content()
+    get_all_activity_groups()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201206/user_service/update_users.rb → v201308/activity_group_service/update_activity_groups.rb}

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+# Author:: api.davidtorres@gmail.com (David Torres)
 #
-# Copyright:: Copyright 2011, 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,17 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates all users by adding "Sr." to the end of each name (after
-# a very large baby boom and lack of creativity). To determine which users
-# exist, run get_all_users.rb.
+# This example updates activity groups by adding a company. To determine which
+# activity groups exist, run get_all_activity_groups.rb.
 #
-# Tags: UserService.getUsersByStatement, UserService.updateUsers
+# Tags: ActivityGroupService.getActivityGroup
+# Tags: ActivityGroupService.updateActivityGroups
 
 require 'dfp_api'
 
-API_VERSION = :v201206
+API_VERSION = :v201308
 
-def update_users()
+def update_activity_groups()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -36,40 +36,38 @@ def update_users()
   # 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)
+  # Get the ActivityGroupService.
+  activity_group_service = dfp.service(:ActivityGroupService, API_VERSION)
 
-  # Create a statement to get all users.
-  statement = {:query => 'LIMIT 500'}
+  # Set the ID of the activity group and the company to update it with.
+  activity_group_id = 'INSERT_ACTIVITY_GROUP_ID_HERE'
+  advertiser_company_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'
 
-  # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  # Get the activity group.
+  activity_group = activity_group_service.get_activity_group(activity_group_id)
 
-  if page[:results]
-    users = page[:results]
+  # Update the companies.
+  activity_group[:company_ids] << advertiser_company_id
 
-    # Update each local users object by changing its name.
-    users.each {|user| user[:name] += ' Sr.'}
+  # Update the activity groups on the server.
+  return_activity_groups = activity_group_service.update_activity_groups([
+      activity_group])
 
-    # Update the users on the server.
-    return_users = user_service.update_users(users)
-
-    if return_users
-      return_users.each do |user|
-        puts ("User ID: %d, email: %s was updated with name %s") %
-            [user[:id], user[:email], user[:name]]
-      end
-    else
-      raise 'No users were updated.'
+  # 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
-    puts 'No users found to update.'
+    raise 'No activity groups were updated.'
   end
+
 end
 
 if __FILE__ == $0
   begin
-    update_users()
+    update_activity_groups()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e