google-dfp-api 0.6.2 → 0.6.3

data/ChangeLog

@@ -1,3 +1,6 @@
+0.6.3:
+  - Added support and examples for v201306.
+
 0.6.2:
   - Added support and examples for v201302.
 

data/README

@@ -68,14 +68,18 @@ file. Alternatively, you can pass a configuration hash directly to the
 constructor:
   dfp = DfpApi::Api.new({
      :authentication => {
-         :method => 'ClientLogin',
+         :method => 'OAuth2',
+         :oauth2_client_id: 'INSERT_OAUTH2_CLIENT_ID_HERE',
+         :oauth2_client_secret: 'INSERT_OAUTH2_CLIENT_SECRET_HERE',
          :application_name => 'Ruby DFP Sample',
-         :email => 'user@domain.com',
-         :password => 'PASSWORD',
          :network_code => 123456
      }
    })
 
+To obtain OAuth2 client credentials, follow instructions on the wiki:
+
+  http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2
+
 An example of configuration file is available as part of this library.
 
 *Note*: if you are using Ruby 1.8 you may need to include RubyGems to be able
@@ -112,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. :v201206.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201306.
 
 Then you should be able to execute service methods:
 
@@ -146,7 +150,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201206/user_service
+  $ cd examples/v201306/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example
@@ -222,12 +226,17 @@ Questions can be asked on forum
 
   http://groups.google.com/group/google-doubleclick-for-publishers-api/
 
+Make sure to subscribe to our Google Plus page for API change announcements and
+other news:
+
+  https://plus.google.com/+GoogleAdsDevelopers
+
 
 = Copyright/License Info
 
 == License
 
-Copyright 2011-2012, Google Inc. All Rights Reserved.
+Copyright 2011-2013, Google Inc. All Rights Reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License.

data/dfp_api.yml

@@ -6,14 +6,14 @@
 :authentication:
   # Authentication method, methods currently supported: OAUTH2, OAUTH2_JWT,
   # ClientLogin.
-  :method: ClientLogin
+  :method: OAuth2
 
   # Auth parameters for OAUTH2 method.
   # Set the OAuth2 client id and secret. Register your application here to
   # obtain these values:
   #   https://code.google.com/apis/console#access
-  #:oauth2_client_id: INSERT_OAUTH2_CLIENT_ID_HERE
-  #:oauth2_client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
+  :oauth2_client_id: INSERT_OAUTH2_CLIENT_ID_HERE
+  :oauth2_client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
   # Optional, see: https://developers.google.com/accounts/docs/OAuth2WebServer
   #:oauth2_callback: INSERT_OAUTH2_CALLBACK_URL_HERE
   #:oauth2_state: INSERT_OAUTH2_STATE_HERE
@@ -31,8 +31,9 @@
   #:oauth2_prn: INSERT_OAUTH2_PRN_HERE
 
   # Auth parameters for ClientLogin method.
-  :password: INSERT_PASSWORD_HERE
-  :email: INSERT_EMAIL_HERE
+  # NOTE: ClientLogin method is deprecated, use OAuth2.0 instead.
+  #:password: INSERT_PASSWORD_HERE
+  #:email: INSERT_EMAIL_HERE
   # To manage your auth tokens manually, use the 'auth_token' property.
   #:auth_token: INSERT_AUTH_TOKEN_HERE
 

data/examples/v201302/report_service/run_reach_report.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # Author:: api.davidtorres@gmail.com (David Torres)
 #

data/examples/v201306/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 = :v201306
+
+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/v201306/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 = :v201306
+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/v201306/activity_group_service/get_all_activity_groups.rb

@@ -0,0 +1,95 @@
+#!/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 activity groups. To create activity groups,
+# run create_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroupsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+PAGE_SIZE = 500
+
+def get_all_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 => '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)
+
+    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_all_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/v201306/activity_group_service/update_activity_groups.rb

@@ -0,0 +1,87 @@
+#!/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 updates activity groups by adding a company. To determine which
+# activity groups exist, run get_all_activity_groups.rb.
+#
+# Tags: ActivityGroupService.getActivityGroup
+# Tags: ActivityGroupService.updateActivityGroups
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def update_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 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 the activity group.
+  activity_group = activity_group_service.get_activity_group(activity_group_id)
+
+  # Update the companies.
+  activity_group[:company_ids] << advertiser_company_id
+
+  # Update the activity groups on the server.
+  return_activity_groups = activity_group_service.update_activity_groups([
+      activity_group])
+
+  # 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
+  begin
+    update_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