com.adobe.mediacore.metadata
Class AuditudeSettings

java.lang.Object
  com.adobe.mediacore.metadata.MetadataNode
      com.adobe.mediacore.metadata.AdvertisingMetadata
          com.adobe.mediacore.metadata.AuditudeSettings

All Implemented Interfaces:

Metadata, Serializable

Direct Known Subclasses:

AuditudeMetadata

public class AuditudeSettings
extends AdvertisingMetadata

Public class which support ad information provided by the Auditude ad-resolving WEB service.

See Also:

Serialized Form

Constructor Summary

AuditudeSettings()

Method Summary

Metadata	getCustomParameters() Retrieve the custom parameters information.
Object	getData() Retrieve the custom data object attached to this Auditude metadata object.
String	getDefaultMediaId() Retrieve the Auditude "default media id" parameter This parameter (known in advance by the developer) is not mandatory, but it highly recommended to be used.
String	getDomain() Retrieve the domain name corresponding to the Auditude service.
String	getMediaId() Retrieve the Auditude "media id" parameter.
Metadata	getTargetingParameters() Retrieve the custom ad-targeting information.
String	getZoneId() Retrieve the Auditude "zone id" parameter.
boolean	isCreativeRepackagingEnabled() Retrieve whether Auditude should perform creative repackaging.
void	setCreativeRepackagingEnabled(boolean enabled) Set whether Auditude should perform creative repackaging.
void	setCustomParameters(Metadata customParameters) Set the custom parameters information.
void	setData(Object data) Set the custom data object attached to this Auditude metadata object.
void	setDefaultMediaId(String defaultMediaId) Set the Auditude "default media id" parameter.
void	setDomain(String domainName) Set the domain name corresponding to the Auditude service.
void	setMediaId(String mediaId) Set the Auditude "media id" parameter.
void	setTargetingParameters(Metadata targetingInfo) Set the custom ad-targeting information.
void	setZoneId(String zoneId) Set the Auditude "zone id" parameter.

Methods inherited from class com.adobe.mediacore.metadata.AdvertisingMetadata

getAdBreakAsWatched, getSignalingMode, setAdBreakAsWatched, setSignalingMode

Methods inherited from class com.adobe.mediacore.metadata.MetadataNode

containsKey, containsNode, fromByteArray, getNode, getValue, isEmpty, keySet, setNode, setValue, toByteArray, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuditudeSettings

public AuditudeSettings()

Method Detail

getZoneId

public String getZoneId()

Retrieve the Auditude "zone id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.

Returns:

the Auditude "zone id" parameter

setZoneId

public void setZoneId(String zoneId)

Set the Auditude "zone id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.

Parameters:

zoneId - the Auditude "zone id" parameter

getMediaId

public String getMediaId()

Retrieve the Auditude "media id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server. This value targets a specific ad-configuration on the Auditude back-end server.

Returns:

the Auditude "media id" parameter

setMediaId

public void setMediaId(String mediaId)

Set the Auditude "media id" parameter. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server. This value targets a specific ad-configuration on the Auditude back-end server.

Parameters:

mediaId - the Auditude "media id" parameter

getDomain

public String getDomain()

Retrieve the domain name corresponding to the Auditude service. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.

Returns:

the Auditude "domain name" parameter

setDomain

public void setDomain(String domainName)

Set the domain name corresponding to the Auditude service. This parameter (known in advance by the developer) is required in order to be able to issue valid requests to the Auditude back-end server.

Parameters:

domainName - the Auditude "domain name" parameter

getTargetingParameters

public Metadata getTargetingParameters()

Retrieve the custom ad-targeting information. The ad-targeting information is not mandatory to issue valid requests to the Auditude back-end server. This optional parameter can be used restrict the pool of ads that are considered during the ad-selection process.

Returns:

the Auditude targeting parameters, in the form of a metadata dictionary.

setTargetingParameters

public void setTargetingParameters(Metadata targetingInfo)

Set the custom ad-targeting information. The ad-targeting information is not mandatory to issue valid requests to the Auditude back-end server. This optional parameter can be used restrict the pool of ads that are considered during the ad-selection process.

Parameters:

targetingInfo - the Auditude targeting parameters, specified as a metadata dictionary.

getCustomParameters

public Metadata getCustomParameters()

Retrieve the custom parameters information. The custom parameters are not mandatory to issue valid requests to the Auditude back-end server. These are the global custom parameters. It is possible to also dynamically add cue-specific custom parameters. The two collections are combined into one and is sent to Auditude, when an ad resolving request is being initiated.

Returns:

the Auditude custom parameters, in the form of a metadata dictionary.

setCustomParameters

public void setCustomParameters(Metadata customParameters)

Set the custom parameters information. The custom parameters are not mandatory to issue valid requests to the Auditude back-end server. These are the global custom parameters. It is possible to also dynamically add cue-specific custom parameters. The two collections are combined into one and is sent to Auditude, when an ad resolving request is being initiated.

Parameters:

customParameters - Auditude custom parameters, in the form of a metadata dictionary.

isCreativeRepackagingEnabled

public boolean isCreativeRepackagingEnabled()

Retrieve whether Auditude should perform creative repackaging. This information is not mandatory to issue valid requests to the Auditude back-end server. The server might be configured to have a pool of ads that are not supported by this platform, such as f4m. When this option is enabled, the Auditude back-end will try to perform on the fly ad transcoding. In this way, ads that are not supported will be repackaged to compliant formats (such as m3u8), seamlessly to the client. The repackaged ad is cached and it will be served directly the next time it is requested.

setCreativeRepackagingEnabled

public void setCreativeRepackagingEnabled(boolean enabled)

Set whether Auditude should perform creative repackaging. This information is not mandatory to issue valid requests to the Auditude back-end server. The server might be configured to have a pool of ads that are not supported by this platform, such as f4m. When this option is enabled, the Auditude back-end will try to perform on the fly ad transcoding. In this way, ads that are not supported will be repackaged to compliant formats (such as m3u8), seamlessly to the client. The repackaged ad is cached and it will be served directly the next time it is requested.

Parameters:

enabled - whether the repackaging should take place or not.

getDefaultMediaId

public String getDefaultMediaId()

Retrieve the Auditude "default media id" parameter This parameter (known in advance by the developer) is not mandatory, but it highly recommended to be used. This parameter will be used to server ad impressions in the case of faulty configuration or delay in propagation in the Auditude content ingestion and ad server.

Returns:

defaultMediaId the Auditude "default media id" parameter

setDefaultMediaId

public void setDefaultMediaId(String defaultMediaId)

Set the Auditude "default media id" parameter. This parameter (known in advance by the developer) is not mandatory, but it highly recommended to be used. This parameter will be used to server ad impressions in the case of faulty configuration or delay in propagation in the Auditude content ingestion and ad server.

Parameters:

defaultMediaId - the Auditude "default media id" parameter

getData

public Object getData()

Retrieve the custom data object attached to this Auditude metadata object. The AuditudeSettings object supports arbitrary objects to be attached to it. Passing the AuditudeSettings object around, also ensures the transport of the passing of the attached data object.

Returns:

the custom data object

setData

public void setData(Object data)

Set the custom data object attached to this Auditude metadata object. This method this is intended for internal P-SDK use only. The AuditudeSettings object supports arbitrary objects to be attached to it. Passing the AuditudeSettings object around, also ensures the passing of the custom data object.

Parameters:

data - the custom data object