Enable rich media interaction signals in the Connect web library

Rich media interaction represents an interaction with video or audio where a user launches, pauses, continues, completes, stops, enlarges, etc. The rich media signal is useful for retailers who have a lot of video reviews.

Availability

The rich media interaction signal is supported by Premium and Ultimate subscriptions.

Configuration

Required fields

FieldValuesDefinition
categoryString. Valid value - Behavior.The category of the signal. For behavioral signals the category should always be “Behavior”.
effectString. Valid values:

- negative
- positive
Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.
nameString The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals.
signalTypeString. For rich media interaction signals, use
richMediaInteraction.
The type of signal being sent. Must be from the set of supported signals.
mediaIdStringThe identifier of the media

Optional fields

FieldValuesDefinition
interactionType String. Valid values:

- load
- launch
- pause
- continue
- complete
- stop
- enlarge
The type of interaction with the media
mediaCategoryStringThe category that the media falls into, for example, video
mediaNameStringThe name of the media
signalCustomAttributesArray of objectsAllows for custom attributes that are not predefined by the product
urlStringThe URL of the media

Example

{
  "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"
}