google-dfp-api 0.3.0 → 0.3.1

data/examples/v201204/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 = :v201204
+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/v201204/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 = :v201204
+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

@@ -20,12 +20,10 @@
 # Contains the main classes for the client library. Takes care of all
 # dependencies.
 
-gem 'google-ads-common', '~>0.6.1'
+gem 'google-ads-common', '~>0.7.0'
 
 require 'ads_common/api'
-require 'ads_common/savon_service'
 require 'ads_common/savon_headers/oauth_header_handler'
-require 'ads_common/savon_headers/simple_header_handler'
 require 'dfp_api/api_config'
 require 'dfp_api/client_login_header_handler'
 require 'dfp_api/credential_handler'
@@ -50,27 +48,23 @@ module DfpApi
       DfpApi::ApiConfig
     end
 
-    # Sets the logger to use.
-    def logger=(logger)
-      super(logger)
-      AdsCommon::SavonService.logger = logger
-    end
-
     private
 
-    # Retrieve DFP HeaderHandlers per credential.
-    def soap_header_handlers(auth_handler, header_list, version, namespace)
-      handler = nil
+    # Retrieve DFP HeaderHandler per credential.
+    def soap_header_handler(auth_handler, version, namespace)
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
       handler = case auth_method
         when :CLIENTLOGIN
           DfpApi::ClientLoginHeaderHandler
         when :OAUTH
           AdsCommon::SavonHeaders::OAuthHeaderHandler
+        else
+          raise AdsCommon::Errors::AuthError,
+              "Unknown auth method: %s" % auth_method
       end
-      ns = api_config.headers_config[:HEADER_NAMESPACE_PREAMBLE] + version.to_s
-      return [handler.new(@credential_handler, auth_handler,
-          api_config.headers_config[:REQUEST_HEADER], ns, version)]
+      ns = api_config.client_login_config(:HEADER_NAMESPACE_PREAMBLE) +
+          version.to_s
+      return handler.new(@credential_handler, auth_handler, ns, version)
     end
   end
 end

data/lib/dfp_api/api_config.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -34,9 +35,9 @@ module DfpApi
     end
 
     # Set defaults
-    DEFAULT_VERSION = :v201203
+    DEFAULT_VERSION = :v201204
     DEFAULT_ENVIRONMENT = :PRODUCTION
-    LATEST_VERSION = :v201203
+    LATEST_VERSION = :v201204
 
     # Set other constants
     API_NAME = 'DfpApi'
@@ -72,7 +73,16 @@ module DfpApi
                    :CustomTargetingService, :PublisherQueryLanguageService,
                    :LabelService, :ThirdPartySlotService, :ContentService,
                    :SuggestedAdUnitService, :CreativeTemplateService,
-                   :TeamService, :AudienceSegmentService]
+                   :TeamService, :AudienceSegmentService],
+      :v201204 => [:CompanyService, :CreativeService, :ForecastService,
+                   :InventoryService, :LineItemCreativeAssociationService,
+                   :LineItemService, :NetworkService, :OrderService,
+                   :PlacementService, :ReportService, :UserService,
+                   :CustomTargetingService, :PublisherQueryLanguageService,
+                   :LabelService, :ThirdPartySlotService, :ContentService,
+                   :SuggestedAdUnitService, :CreativeTemplateService,
+                   :TeamService, :AudienceSegmentService, :CustomFieldService,
+                   :UserTeamAssociationService]
     }
 
     # Configure the different environments, with the base URL for each one
@@ -82,17 +92,14 @@ module DfpApi
         :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/'
+        :v201203 => 'https://www.google.com/apis/ads/publisher/',
+        :v201204 => 'https://www.google.com/apis/ads/publisher/'
       }
     }
 
-    # Configure the auth servers to use for each environment
-    @@auth_server_config = {
-      :PRODUCTION => 'https://www.google.com'
-    }
-
-    @@headers_config = {
-      :REQUEST_HEADER => 'RequestHeader',
+    # 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'
@@ -121,24 +128,21 @@ module DfpApi
       @@service_config
     end
 
-    def self.environment_config
-      @@environment_config
+    def self.environment_config(environment, key)
+      return @@environment_config.include?(environment) ?
+          @@environment_config[environment][key] : nil
     end
 
     def self.subdir_config
       nil
     end
 
-    def self.auth_server_config
-      @@auth_server_config
+    def self.client_login_config(key)
+      return @@client_login_config[key]
     end
 
     def self.default_config_filename
       DEFAULT_CONFIG_FILENAME
     end
-
-    def self.headers_config
-      @@headers_config
-    end
   end
 end

data/lib/dfp_api/client_login_header_handler.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Authors:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -19,14 +20,14 @@
 #
 # Handles SOAP headers and namespaces definition for ClientLogin type header.
 
-require 'ads_common/savon_headers/simple_header_handler'
+require 'ads_common/savon_headers/base_header_handler'
 
 module DfpApi
-  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::SimpleHeaderHandler
+  class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::BaseHeaderHandler
     private
 
-    # Generates SOAP request header with login credentials and namespace
-    # definition.
+    # Generates DFP API specific request header with ClientLogin data in
+    # required namespace.
     #
     # Args:
     #  - None
@@ -35,22 +36,17 @@ module DfpApi
     #  - Hash containing a header with filled in credentials
     #
     def generate_request_header()
-      headers = @auth_handler.headers(@credential_handler.credentials)
-      return headers.inject({}) do |request_header, (header, value)|
-        if header == :authToken
-          auth_header = prepend_namespace('authentication')
-          request_header[auth_header] = {
-              prepend_namespace('token') => value
-          }
-          request_header[:attributes!] ||= {}
-          request_header[:attributes!][auth_header] = {
-              'xsi:type' => prepend_namespace('ClientLogin'),
-          }
-        else
-          request_header[prepend_namespace(header)] = value
-        end
-        request_header
-      end
+      request_header = super()
+      auth_header = prepend_namespace('authentication')
+      credentials = @credential_handler.credentials
+      request_header[auth_header] = {
+          prepend_namespace('token') => @auth_handler.get_token(credentials)
+      }
+      request_header[:attributes!] ||= {}
+      request_header[:attributes!][auth_header] = {
+          'xsi:type' => prepend_namespace('ClientLogin'),
+      }
+      return request_header
     end
   end
 end

data/lib/dfp_api/credential_handler.rb

@@ -26,37 +26,29 @@ module DfpApi
   class CredentialHandler < AdsCommon::CredentialHandler
     # Create the list of credentials to be used by the auth handler for header
     # generation.
-    def credentials(version = nil)
-      validate_headers_for_server()
+    def credentials(credentials_override = nil)
+      result = super(credentials_override)
+      validate_headers_for_server(result)
+      result[:extra_headers] = {
+          'applicationName' => generate_soap_user_agent(),
+          'networkCode' => result[:network_code]
+      }
+      return result
+    end
 
-      result = case @credentials[:method]
-        when :CLIENTLOGIN
-          {:email => @credentials[:email],
-           :password => @credentials[:password],
-           :auth_token => @credentials[:auth_token]}
-        when :OAUTH
-          {:oauth_consumer_key => @credentials[:oauth_consumer_key],
-           :oauth_consumer_secret => @credentials[:oauth_consumer_secret],
-           :oauth_verification_code => @credentials[:oauth_verification_code],
-           :oauth_token => @credentials[:oauth_token],
-           :oauth_token_secret => @credentials[:oauth_token_secret],
-           :oauth_callback => @credentials[:oauth_callback],
-           :oauth_method => @credentials[:oauth_method],
-           :oauth_request_token => @credentials[:oauth_request_token]}
-      end
-      client_lib = "DfpApi-Ruby-%s" % DfpApi::ApiConfig::CLIENT_LIB_VERSION
-      application_name = @credentials[:application_name] || $0
-      result[:applicationName] = "%s|%s" % [client_lib, application_name]
-      result[:networkCode] = @credentials[:network_code]
-      return result.reject {|k, v| v.nil?}
+    # Generates string to user as user agent in SOAP headers.
+    def generate_soap_user_agent(extra_ids = [])
+      extra_ids << ["DfpApi-Ruby-%s" % DfpApi::ApiConfig::CLIENT_LIB_VERSION]
+      super(extra_ids)
     end
 
     private
 
     # Validates that the right credentials are being used for the chosen
     # environment.
-    def validate_headers_for_server()
-      if @credentials[:application_name].nil?
+    # TODO(dklimkin): implement NetworkCode check.
+    def validate_headers_for_server(credentials)
+      if credentials[:application_name].nil?
         raise AdsCommon::Errors::AuthError, 'Application name is not specified'
       end
       return nil