Rich media interaction signals
Rich media interaction represents an interaction with video or audio where a user launches, pauses, continues, completes, stops, enlarges, etc.
Configuration
Required fields
Field | Values | Definition |
---|---|---|
category | String. Valid value - Behavior . | The category of the signal. For behavioral signals the category should always be “Behavior”. |
name | String | The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals. |
signalType | String. For rich media interaction signals, userichMediaInteraction . | The type of signal being sent. Must be from the set of supported signals. |
mediaId | String | Identifier of the media |
url | String | URL of the media |
mediaCategory | String | Category that the media falls into, for example, video |
mediaName | String | Name of the media |
interactionType | String. Valid values: - load - launch - pause - continue - complete - stop - enlarge | Type of interaction with the media |
Optional fields
Field | Values | Definition |
---|---|---|
effect | String. Valid values: - negative - positive | Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring. |
signalCustomAttributes | String | Allows for custom attributes that are not predefined by the product |
Sample payload
{
"signalType": "richMediaInteraction",
"name": "richMediaInteraction from product page",
"category": "Behavior",
"mediaId": "blob:https://www.nike.com/52abbeb9-e9f1-45fb-abbc-e51578224825",
"url": "https://www.nike.com/mx/",
"mediaCategory": "home page",
"mediaName": "video",
"interactionType": "click",
"effect": "positive"
}
All data in the SDK payload must be collected manually, there is no automatic binding to the payload fields.
Updated 22 days ago