Rich Media¶

The Rich Media plugin enables dropping segments on shoppers to store and view Rich Media for that customer. This is done by dropping a segment on the shopper, and additionally collecting information on the Rich Media we tie to that segment.

Installation¶

This plugin requires no additional installation to be used correctly.

Configuration¶

This plugin provides the following configuration variables:

Variable	Type	Required	Description
pixelID	string	yes	the Orbee Rich Media PixelID for your account

Methods¶

This plugin provides the following function to drop a segment:

Method	Parameters	Description
dropSegment	(params)	drops a Rich Media segment with the given params on the shopper

Events¶

Generated¶

This plugin generates the following events:

Action

Spec

Trigger

marker

{
    object: 'visit',
    vendor: 'Orbee',
    product: 'Segments',
    implementations: ['Rich Media'],
    pixelID: "",
    label: "",
    extractor: "",
    richMediaType: "",
    trackerPayload: { /* information on the Rich Media dropped */ }
}

Heartbeat w/ activity

Listening¶

This plugin does not listen for any events.

Dependencies¶

This plugin does not depend on any other services or plugins.

Last update: 2023-04-13