Packagecom.adobe.mediacore.adresolver
Classpublic class AuditudeAdResolverSettings
InheritanceAuditudeAdResolverSettings Inheritance Object

The configuration object for for the AuditudeAdResolver module. This is passed into the AdResolver's initialize method.


Public Properties
 PropertyDefined By
  customParameters : Object
[read-only] Returns the custom parameters as an enumerable set of key/value pairs.
AuditudeAdResolverSettings
  defaultStreamID : String
[read-only] The default media Id associated with the auditude publisher account
AuditudeAdResolverSettings
  responseType : String
[read-only] The XML response format from the Auditude ad servers.
AuditudeAdResolverSettings
  serverURL : String
[read-only] The URL of Auditude's ad server.
AuditudeAdResolverSettings
  streamID : String
[read-only] The corresponding asset ID in the Auditude system.
AuditudeAdResolverSettings
  targetingParameters : Object
[read-only] Returns the user targeting parameters as an enumerable set of key/value pairs.
AuditudeAdResolverSettings
  timeout : Number
[read-only] Max time in seconds to wait for response from Auditude, defaults to 5.0 seconds.
AuditudeAdResolverSettings
  zoneID : String
[read-only] The content provider's ad targeting zone identifier at Auditude.
AuditudeAdResolverSettings
Public Methods
 MethodDefined By
  
AuditudeAdResolverSettings(adMetadata:AdMetadata = null)
Constructor.
AuditudeAdResolverSettings
  
isValid():Boolean
Checks the validity of the settings object.
AuditudeAdResolverSettings
Public Constants
 ConstantDefined By
  AUDITUDE_RESPONSE_TYPE_1_4 : String = 1.4
[static] Auditude's default ad response format.
AuditudeAdResolverSettings
  EXCLUDED_CUSTOM_PARAM_KEYS : Array
[static] List of parameter keys not allowed for ad resolver custom parameters.
AuditudeAdResolverSettings
Property Detail
customParametersproperty
customParameters:Object  [read-only]

Returns the custom parameters as an enumerable set of key/value pairs.


Implementation
    public function get customParameters():Object
defaultStreamIDproperty 
defaultStreamID:String  [read-only]

The default media Id associated with the auditude publisher account


Implementation
    public function get defaultStreamID():String
responseTypeproperty 
responseType:String  [read-only]

The XML response format from the Auditude ad servers. Different tracking modules could warrant different types of responses from Auditude such as VAST 2 or Auditude's default format 1.4.


Implementation
    public function get responseType():String
serverURLproperty 
serverURL:String  [read-only]

The URL of Auditude's ad server.


Implementation
    public function get serverURL():String
streamIDproperty 
streamID:String  [read-only]

The corresponding asset ID in the Auditude system.


Implementation
    public function get streamID():String
targetingParametersproperty 
targetingParameters:Object  [read-only]

Returns the user targeting parameters as an enumerable set of key/value pairs.


Implementation
    public function get targetingParameters():Object
timeoutproperty 
timeout:Number  [read-only]

Max time in seconds to wait for response from Auditude, defaults to 5.0 seconds.


Implementation
    public function get timeout():Number
zoneIDproperty 
zoneID:String  [read-only]

The content provider's ad targeting zone identifier at Auditude.


Implementation
    public function get zoneID():String
Constructor Detail
AuditudeAdResolverSettings()Constructor
public function AuditudeAdResolverSettings(adMetadata:AdMetadata = null)

Constructor.

Parameters
adMetadata:AdMetadata (default = null)
Method Detail
isValid()method
public function isValid():Boolean

Checks the validity of the settings object.

Returns
Boolean
Constant Detail
AUDITUDE_RESPONSE_TYPE_1_4Constant
public static const AUDITUDE_RESPONSE_TYPE_1_4:String = 1.4

Auditude's default ad response format. This is a SMIL formatted XML document with additional extensions that offer more benefits than a standard VAST 2 response.

EXCLUDED_CUSTOM_PARAM_KEYSConstant 
public static const EXCLUDED_CUSTOM_PARAM_KEYS:Array

List of parameter keys not allowed for ad resolver custom parameters. This is to avoid overwritting of other settings gathered from the AdMetadata and of reserved URL parameters of the Auditude AdRequest. Excluded AdRequest URL parameters: g: OS Group ID l: Local Time u: Stream/Media ID z: Zone of: Output Format tm: Impression Format tl: Timeline geo: Geo location Excluded AdResolver Settings: serverURL: URL to Auditude server streamID: ID of stream





Tue Jan 7 2014, 04:16 PM +02:00