Skip to main content

Integration Launcher Options

Overview​

Options for the instance of IntegrationLauncher. When an instance of the Integration Launcher is created it is required to pass your unique Rokt Account ID. The other parameters are optional and allow you to configure the behavior of the integration.

Properties​

accountId​

• accountId : string

Your unique Rokt Account ID. See Where can I find my Rokt Account ID? on how to find your Rokt Account ID.

noFunctional (optional)​

• noFunctional? : boolean

default false

A boolean flag allowing management of user preference for functional cookies. Functional cookies allow you to provide the most relevant and optimal customer experiences on your own site, with enhanced personalization. They also help power advanced functionality within the checkout (e.g. selling Upsells). In practice, setting the value to true prevents Rokt from using any 1st party tracking IDs. Details on the functionality and the impact of using this option.

pageInitTimestamp (optional)​

• pageInitTimestamp? : Date

In the event that the Integration Launcher is initialized on a virtual page of a SPA, this value allows you to provide the timestamp of the page being initialized. This allows Rokt to correctly measure the load performance relative to the page that triggered it without external factors such as how long it took user to reach that page. With this information, Rokt can detect any anomaly in the load times that could impact the efficiency of the integration.

default PerformanceNavigationTiming.responseStart

See Anomaly detection for how Rokt tracks load performance.

See Single page applications on details of SPA integrations

sandbox (optional)​

• sandbox? : boolean

default false

A boolean flag marking if the sandbox environment should be used for the session.

note

This should never be set to true in production.

The flag is useful in the following cases:

  • A partner wants to do user acceptance testing against the production configuration without generating any referrals, before launching in production.
  • Sandbox is used in continuous integration environment on the partner side.

See sandbox integration for additional information and examples.

sessionId (optional)​

• sessionId? : string

Rokt session ID to be passed in case you have already generated your session ID.

For example, it is possible to have your session ID generated by connecting with the Rokt backend before visiting a page where your tag is displayed. In this case, you should provide the previously generated Rokt session ID as this parameter so Rokt can pair both interactions together.

• overrideLinkNavigation? : boolean

default false

When set to true, Rokt will no longer handle link openings directly. Instead, a LINK_NAVIGATION_REQUEST partner event will be emitted.

This flag is useful in scenarios where partners require customized link handling. A common use case is managing different link behaviors—such as opening the links within a WebView while using an external browser for links from Rokt and advertisers. To distinguish between Rokt and advertiser links, partners can check if the URL contains the substring "rokt.com".

To ensure proper event handling, a timeout mechanism is in place. If a LINK_NAVIGATION_REQUEST event is not consumed within 3 seconds, an error will be raised. This precaution ensures that active subscriptions exist on the partner’s side for processing the event and if that is not the case then Rokt will be notified.

Was this article helpful?