Requests that Contextual Commerce show the specified campaign (or message) within this session.
Once requested, the campaign matching campaignId will be shown at the next available opportunity. As campaigns are designed
with various limitations around their presentation (e.g. only showing on a product page), the campaign may not appear
immediately after this call is made.
This method is not intended for regular use and should not be called during regular customer shopping sessions. It is a
business review tool that grants the ability to preview what a given Contextual Commerce campaign will look like within your
application. We strongly recommend creating an easy way for trusted users to trigger this function. This will simplify the
previewing and testing of new campaigns as they become available.
The campaignId strings, used to request campaigns, can be obtained from your Contextual Commerce Strategist.
Parameters
campaignId: string
The id of the campaign to display.
Returns void
Placement
This function can be called any time after activate has been called.
Requests that Contextual Commerce show the specified campaign (or message) within this session.
Once requested, the campaign matching
campaignId
will be shown at the next available opportunity. As campaigns are designed with various limitations around their presentation (e.g. only showing on a product page), the campaign may not appear immediately after this call is made.This method is not intended for regular use and should not be called during regular customer shopping sessions. It is a business review tool that grants the ability to preview what a given Contextual Commerce campaign will look like within your application. We strongly recommend creating an easy way for trusted users to trigger this function. This will simplify the previewing and testing of new campaigns as they become available.
The
campaignId
strings, used to request campaigns, can be obtained from your Contextual Commerce Strategist.