google-dfp-api 0.3.3 → 0.4.0

data/examples/v201208/user_team_association_service/get_all_user_team_associations.rb

@@ -0,0 +1,94 @@
+#!/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 gets all user team associations. To create user team
+# associations, run create_user_team_assocations.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+PAGE_SIZE = 500
+
+def get_all_user_team_associations()
+  # 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 UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  begin
+    # Create statement for one page with current offset.
+    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+
+    # Get the user team associations by statement.
+    page = uta_service.get_user_team_associations_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 user team association in results page.
+      page[:results].each_with_index do |association, index|
+        puts "%d) User team association between team ID: %d and user ID %d" %
+            [index + start_index, association[:team_id], association[:user_id]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer
+  if page.include?(:total_result_set_size)
+    puts "Total number of user team associations: %d" %
+        page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_user_team_associations()
+
+  # 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/v201208/user_team_association_service/get_user_team_association.rb

@@ -0,0 +1,76 @@
+#!/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 gets a user team association by user and team IDs. To determine
+# which teams exist, run get_all_teams.rb. To determine which users exist, run
+# get_all_users.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociation
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+
+def get_user_team_association()
+  # 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 UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Set the users and team to add them to.
+  team_id = 'INSERT_TEAM_ID_HERE'.to_i
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Get the user team association.
+  association = uta_service.get_user_team_association(team_id, user_id)
+
+  if association
+    puts "User team association with team ID %d and user ID %d was found." %
+        [association[:team_id], association[:user_id]]
+  else
+    puts 'No user team associations found for these IDs.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_user_team_association()
+
+  # 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/v201208/user_team_association_service/get_user_team_associations_by_statement.rb

@@ -0,0 +1,94 @@
+#!/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 gets all teams that the current user belongs to. The statement
+# retrieves up to the maximum page size limit of 500. To create teams, run
+# create_user_team_associations.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserService.getCurrentUser
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+PAGE_SIZE = 500
+
+def get_user_team_associations_by_statement()
+  # 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 UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Get the UserService.
+  user_service = dfp.service(:UserService, API_VERSION)
+
+  # Get the current user.
+  user = user_service.get_current_user()
+
+  # Create filter text to select user team associations by the user ID.
+  statement = {
+      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
+      :values => [
+          {:key => 'user_id',
+           :value => {:value => user[:id], :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Get user team associations by statement.
+  page = uta_service.get_user_team_associations_by_statement(statement)
+
+  if page and page[:results]
+    page[:results].each_with_index do |association, index|
+      puts "%d) Team user association between team ID %d and user ID %d." %
+          [index, association[:team_id], association[:user_id]]
+    end
+  end
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_user_team_associations_by_statement()
+
+  # 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/v201208/user_team_association_service/update_user_team_associations.rb

@@ -0,0 +1,102 @@
+#!/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 updates user team associations. It updates a user team
+# association by setting the overridden access type to read only for the first
+# 500 teams that the user belongs to. To determine which users exists, run
+# get_all_users.rb.
+#
+# Tags: UserTeamAssociationService.getUserTeamAssociationsByStatement
+# Tags: UserTeamAssociationService.updateUserTeamAssociations
+
+require 'dfp_api'
+
+API_VERSION = :v201208
+PAGE_SIZE = 500
+
+def update_user_team_associations()
+  # 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 UserTeamAssociationService.
+  uta_service = dfp.service(:UserTeamAssociationService, API_VERSION)
+
+  # Set the user to set to read only access within its teams.
+  user_id = 'INSERT_USER_ID_HERE'.to_i
+
+  # Create filter text to select user team associations by the user ID.
+  statement = {
+      :query => "WHERE userId = :user_id LIMIT %s" % PAGE_SIZE,
+      :values => [
+          {:key => 'user_id',
+           :value => {:value => user_id, :xsi_type => 'NumberValue'}},
+      ]
+  }
+
+  # Get user team associations by statement.
+  page = uta_service.get_user_team_associations_by_statement(statement)
+
+  if page[:results] and !page[:results].empty?
+    associations = page[:results]
+    associations.each do |association|
+      # Update local user team association to read-only access.
+      association[:overridden_team_access_type] = 'READ_ONLY'
+    end
+
+    # Update the user team association on the server.
+    return_associations =
+        uta_service.update_user_team_associations(associations)
+
+    # Display results.
+    return_associations.each do |association|
+      puts ("User team association between user ID %d and team ID %d was " +
+          "updated with access type '%s'") %
+          [association[:user_id], association[:team_id],
+           association[:overridden_team_access_type]]
+    end
+  else
+    puts 'No user team associations were updated.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_user_team_associations()
+
+  # 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/lib/dfp_api.rb

@@ -48,20 +48,17 @@ module DfpApi
     private
 
     # Retrieve DFP HeaderHandler per credential.
-    def soap_header_handler(auth_handler, version, namespace)
+    def soap_header_handler(auth_handler, version, header_ns, default_ns)
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
-      handler = case auth_method
-        when :CLIENTLOGIN
-          DfpApi::ClientLoginHeaderHandler
-        when :OAUTH, :OAUTH2
-          AdsCommon::SavonHeaders::OAuthHeaderHandler
+      handler_class  = case auth_method
+        when :CLIENTLOGIN then DfpApi::ClientLoginHeaderHandler
+        when :OAUTH, :OAUTH2 then AdsCommon::SavonHeaders::OAuthHeaderHandler
         else
           raise AdsCommon::Errors::AuthError,
               "Unknown auth method: %s" % auth_method
       end
-      ns = api_config.client_login_config(:HEADER_NAMESPACE_PREAMBLE) +
-          version.to_s
-      return handler.new(@credential_handler, auth_handler, ns, version)
+      return handler_class.new(@credential_handler, auth_handler, header_ns,
+                               default_ns, version)
     end
   end
 end

data/lib/dfp_api/api_config.rb

@@ -35,9 +35,9 @@ module DfpApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201206
+    DEFAULT_VERSION = :v201208
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201206
+    LATEST_VERSION = :v201208
 
     # Set other constants
     API_NAME = 'DfpApi'
@@ -84,6 +84,15 @@ module DfpApi
                    :TeamService, :AudienceSegmentService, :CustomFieldService,
                    :UserTeamAssociationService],
       :v201206 => [:CompanyService, :CreativeService, :ForecastService,
+                   :InventoryService, :LineItemCreativeAssociationService,
+                   :LineItemService, :NetworkService, :OrderService,
+                   :PlacementService, :ReportService, :UserService,
+                   :CustomTargetingService, :PublisherQueryLanguageService,
+                   :LabelService, :ThirdPartySlotService, :ContentService,
+                   :SuggestedAdUnitService, :CreativeTemplateService,
+                   :TeamService, :AudienceSegmentService, :CustomFieldService,
+                   :UserTeamAssociationService, :CreativeSetService],
+      :v201208 => [:CompanyService, :CreativeService, :ForecastService,
                    :InventoryService, :LineItemCreativeAssociationService,
                    :LineItemService, :NetworkService, :OrderService,
                    :PlacementService, :ReportService, :UserService,
@@ -98,20 +107,20 @@ module DfpApi
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => 'https://www.google.com/apis/ads/publisher/',
+        :header_ns => 'https://www.google.com/apis/ads/publisher/',
         :v201108 => 'https://www.google.com/apis/ads/publisher/',
         :v201111 => 'https://www.google.com/apis/ads/publisher/',
         :v201201 => 'https://www.google.com/apis/ads/publisher/',
         :v201203 => 'https://www.google.com/apis/ads/publisher/',
         :v201204 => 'https://www.google.com/apis/ads/publisher/',
-        :v201206 => 'https://www.google.com/apis/ads/publisher/'
+        :v201206 => 'https://www.google.com/apis/ads/publisher/',
+        :v201208 => 'https://www.google.com/apis/ads/publisher/'
       }
     }
 
     # Auth constants for ClientLogin method.
     @@client_login_config = {
       :AUTH_SERVER => 'https://www.google.com',
-      :HEADER_NAMESPACE_PREAMBLE =>
-          'https://www.google.com/apis/ads/publisher/',
       :LOGIN_SERVICE_NAME => 'gam'
     }