Skip to main content

Integration Launcher

Overview#

The integration launcher is a singleton service loaded onto your page that enables interaction with the Rokt ecosystem throughout user's journey on your site.

Methods#

captureConversion#

captureConversion(options: CaptureConversionOptions): Promise<void>

Allows advertisers to log a potential conversion. The method is intended for advertisers only and as such should not be used if it is expected to display placements on a page. In this case, IntegrationLauncher.selectPlacements should be used instead.

See Reporting conversions for information on how to report a conversion.

Parameters:

NameType
optionsCaptureConversionOptions

Returns: Promise<void>


hashAttributes#

hashAttributes(attributes: Attributes): Promise<Record<string, string>>

Utility method allowing to hash passed attributes with the Rokt's preferred hashing method, currently SHA256. This method is preferred over a custom implementation as it hides the complexity of normalizing each attribute value and changing the attribute name to denominate its value as hashed.

See Two-step data integration for more details.

Parameters:

NameType
attributesAttributes

Returns: Promise<Record<string, string>>


selectPlacements#

selectPlacements(options: SelectPlacementsOptions): Promise<Selection>

Allows selecting placements to be displayed on the page and interacting with it through a returned instance of a Selection. The method returns before the selection concludes to allow interacting with the selected placements before they are displayed on a page. For example, to set up listeners to events or close selection if it is no longer relevant.

If the intention is to only capture a potential conversion, IntegrationLauncher.captureConversion should be used instead.

Parameters:

NameType
optionsSelectPlacementsOptions

Returns: Promise<Selection>


terminate#

terminate(): Promise<void>

Finishes and cleans up the Rokt integration from the page.

Returns: Promise<void>

Properties#

version#

version : string

Version of the Integration Launcher used on the page.

Was this article helpful?