Package com.ooyala.pulse
Class ContentMetadata
java.lang.Object
com.ooyala.pulse.ContentMetadata
Information about the content which a requested ad session is to be played with, as well as information
targeting the desired campaign(s).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Available content form values forsetContentForm(ContentForm)
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
copyContentProviderInformation
(com.ooyala.pulse.ContentProviderInformation contentProviderInformation) Replace the current ContentProviderInformation with the provided instance.SeesetAccountCustomParameters(Map)
for information.SeesetCategory(String)
for information.SeesetContentForm(ContentForm)
for information.SeesetContentPartner(String)
for information.com.ooyala.pulse.ContentProviderInformation
SeesetContentProviderInformation(String, String)
for information.SeesetCustomParameters(Map)
for information.float
SeesetDuration(float)
for information.getFlags()
SeesetFlags(List)
for information.SeesetIdentifier(String)
for information.getTags()
SeesetTags(List)
for information.void
setAccountCustomParameters
(Map<String, String> accountCustomParameters) Account custom parameters to add to the session request.void
setCategory
(String category) Content category is used by Pulse to target ads and determine the ad insertion policy.void
setContentForm
(ContentMetadata.ContentForm contentForm) Content form is used to determine the ad insertion policy.void
setContentPartner
(String contentPartner) Content partner; used to target ads.void
setContentProviderInformation
(String providerCode, String contentId) Content provider information, used to specify provider-specific information about the video content that is being played.void
setCustomParameters
(Map<String, String> customParameters) Custom parameters to add to the session request.void
setDuration
(float duration) The duration of the content.void
Flags which can alter Pulse's ad insertion behaviour.void
setIdentifier
(String identifier) Content identifier, used to identify the content to third parties.void
Pulse content tags, used to target specific ads or campaigns.
-
Constructor Details
-
ContentMetadata
public ContentMetadata()
-
-
Method Details
-
setCategory
Content category is used by Pulse to target ads and determine the ad insertion policy. The content category can be represented by either its unique id or one of its aliases set in Pulse.- Parameters:
category
- Unique category id or alias.
-
getCategory
SeesetCategory(String)
for information.- Returns:
- The category, or null if none is set.
-
setContentForm
Content form is used to determine the ad insertion policy.- Parameters:
contentForm
- The content form of the content.
-
getContentForm
SeesetContentForm(ContentForm)
for information.- Returns:
- The content form.
-
setIdentifier
Content identifier, used to identify the content to third parties.- Parameters:
identifier
- Content identifier.
-
getIdentifier
SeesetIdentifier(String)
for information.- Returns:
- The content identifier, or null if none is set.
-
setContentPartner
Content partner; used to target ads. The content partner can be represented by either its unique id or one of its aliases set in the Pulse manager.- Parameters:
contentPartner
- Unique content partner id or alias.
-
getContentPartner
SeesetContentPartner(String)
for information.- Returns:
- The content partner, or null if none is set.
-
setDuration
public void setDuration(float duration) The duration of the content.- Parameters:
duration
- The content duration, specified in seconds. A duration of 0.0f will be treated as if the value is unset.
-
getDuration
public float getDuration()SeesetDuration(float)
for information.- Returns:
- The content duration.
-
setFlags
Flags which can alter Pulse's ad insertion behaviour. Since flags override Pulse's default, they should be used with caution. For more information please talk to your Ooyala Ad Products contact. Supported flags: nocom, noprerolls, nomidrolls, nopostrolls, nooverlays, noskins.- Parameters:
flags
- The flags to send.
-
getFlags
SeesetFlags(List)
for information.- Returns:
- A list of the assigned flags.
-
setTags
Pulse content tags, used to target specific ads or campaigns.- Parameters:
tags
- The tags to send.
-
getTags
SeesetTags(List)
for information.- Returns:
- A list of the assigned tags.
-
setCustomParameters
Custom parameters to add to the session request. Parameters with names containing invalid characters will be omitted. These parameters are added to the ad request URL in the style of "cp.[parameter_name]=[parameter_value]".- Parameters:
customParameters
- Custom parameters.
-
getCustomParameters
SeesetCustomParameters(Map)
for information.- Returns:
- A map of the assigned custom parameters.
-
setAccountCustomParameters
Account custom parameters to add to the session request. Parameters with names or values containing invalid characters will be omitted. These parameters are added to the ad request URL in the style of "acp.[parameter_name]=[parameter_value]". NOTE: The account custom parameter values cannot contain any spaces or any of the following characters: comma (,), semicolon (;), double quote/quotation mark ("), single quote/apostrophe ('), backslash (\), pipe (|), tilde (~), or ampersand (&).- Parameters:
accountCustomParameters
- Account custom parameters.
-
getAccountCustomParameters
SeesetAccountCustomParameters(Map)
for information.- Returns:
- A map of the assigned account custom parameters.
-
setContentProviderInformation
Content provider information, used to specify provider-specific information about the video content that is being played.- Parameters:
providerCode
- The unique content provider code.contentId
- The unique content identifier.
-
copyContentProviderInformation
public void copyContentProviderInformation(com.ooyala.pulse.ContentProviderInformation contentProviderInformation) Replace the current ContentProviderInformation with the provided instance.- Parameters:
contentProviderInformation
- the provided instance of ContentProviderInformation
-
getContentProviderInformation
public com.ooyala.pulse.ContentProviderInformation getContentProviderInformation()SeesetContentProviderInformation(String, String)
for information.- Returns:
- The assigned content provider information.
-