Options
All
  • Public
  • Public/Protected
  • All
Menu

Additional options you can pass to the constructor

Hierarchy

  • InitOptions

Index

Properties

Optional ampEnabled

ampEnabled?: boolean

This option is responsible of enabling AMP

Optional blockDataLayerPush

blockDataLayerPush?: boolean

Block push to the data layer

Optional controllerId

controllerId?: string

User's generated controllerId. NOTE: Always use a controllerId provided by the SDK.

Optional createTcfApiStub

createTcfApiStub?: boolean

Indicate if the TCF stub will be enabled on on load time. We can not wait for this information to come from the settings, as by the TCF guidelines the __tcfapi need to be exposed from the very start.

Optional disableTracking

disableTracking?: boolean

When disabled, analytics will not track ui events

Optional euMode

euMode?: boolean

When enabled, only servers with EU IPs are used (including CDN)

Optional language

language?: string

Enforce a certain initial language for the user (default: user's browser language)

Optional prefetchServices

prefetchServices?: boolean

Enforce the preload of the services information on init

Optional rulesetId

rulesetId?: string

Ruleset id which points to an existing geolocation config settingsIds mapping

Optional sandboxEnv

sandboxEnv?: boolean

When enable, we use sandbox API only

Optional settingsCache

settingsCache?: string

Optional string, which is added to all settings GET requests, allowing instant cache-busting

Optional storeServiceIdToNameMapping

storeServiceIdToNameMapping?: boolean

Store service id to name mapping

Optional suppressCmpDisplay

suppressCmpDisplay?: boolean

Optional boolean, this will force InitialUIValues initialLayer to be UI_LAYER.PRIVACY_BUTTON OR UI_LAYER.NONE

Optional useOnlySettingsV2

useOnlySettingsV2?: boolean

Optional useRulesetId

useRulesetId?: boolean

Optional boolean, if true browser SDK will use the config map Id to fetch the settings id depending on user's geolocation

Optional userCountryData

userCountryData?: UserCountryData

Optional userCountry data to simulate user location

Optional userSessionData

userSessionData?: null | UserSessionData

Optional User Session data to be restored on init

Optional version

version?: string

Lock into a specific Usercentrics settings version (default: latest)