This parameter is a legacy one, and describes the relation between a website, and LiveIntent's media business entities. This field does not have the default value. If it is not set, the appId calculation can be done server side, on the collector. Example:
{
appId: "a-00xx"
}This parameter is an identifier for distributors.
It does not have a default value and must be set in case of distributors scripts.
If distributorId is provided, the appId configuration parameter must not be set.
Example:
{
distributorId: "did-00xx"
}This parameter should be used when this module is required/imported in within another tracker. Often times, we'd like to separate the events received from a specific library encapsulating LiveConnect. If that is the case, it's recommended to set this parameter accordingly. Example
{
wrapperName:"prebid"
}This parameter defines whether the first party identifiers that LiveConnect creates and updates are stored in a cookie jar, or in local storage. If nothing is set, default behaviour would be cookie.
Example for storing the identifiers in a cookie jar:
{
storageStrategy: 'cookie'
}or if putting the identifier in local storage is an option:
{
storageStrategy: 'ls'
}There's also an option for the module to never create any first party identifiers, and that can be achieved by setting this parameter as follows:
{
storageStrategy: 'none'
}By setting this flag, LiveConnect will never write anything into any storage, but will still attempt to read from it.
There's also an option for the module to never read or create any first or third party identifiers. That can be achieved by setting this parameter as follows:
{
storageStrategy: 'disabled'
}LiveConnect uses this strategy if it is required by the provided privacy settings. Currently, if config.gdprApplies is true (config.gdprConsent is not evaluated for that setting yet), disabled strategy will be used. In that case a potentially explicitly configured storage strategy will be overwritten with disabled.
The parameter defines where the signal pixels are pointing to. The params and paths will be defined subsequently.
If the parameter is not set, LiveConnect will by default emit the signal towards https://rp.liadm.com.
The collectorUrl can be any service that can understand the query parameter structure LiveConnect emits.
Example:
{
collectorUrl:"https://rp.liadm.com"
}The IAB (https://iabtechlab.com/standards/ccpa/) privacy string that will be sent along with each request.
Example:
{
usPrivacyString:"1YYY"
}The IAB (https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md) flag that notifies us whether GDPR policies apply.
Example:
{
gdprApplies: true
}The IAB (https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md) consent string.
Example:
{
gdprConsent: 'base64url-encoded TC string with segments'
}The GPP (https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform) consent string.
Example:
{
gppString: 'DBABMA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA'
}The GPP (https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform) applicable sections considered to be in force for this transaction provided as array of numbers.
Example:
{
gppApplicableSections: [1]
}The expiration time of an identifier created and updated by LiveConnect. By default, 730 days.
Example:
{
expirationDays:729
}The names of identifiers which can be found in local storage or in the cookie jar. Those key-value pairs will be sent along with the request. Think of as a way to do first party cookie syncs, because you'll be able to receive multiple first party identifiers in the same request.
Example:
{
identifiersToResolve:["tdid","some-fpc"]
}You might want multiple trackerVersion on the page, so this can be the used to separate multiple use cases. By default, LC will use the version of this module.
The default value will be taken from package.json if it's not set.
Example:
{
trackerVersion:"v2.11.4"
}This configuration parameter sets the maximum duration of calls to all endpoints. By default, there is no timeout. Please refer to identityResolutionConfig.ajaxTimeout for the special handling of the timeout for the IdentityResolution endpoint.
LiveConnect module comes with a functionality to resolve all the identifiers set in the identifiersToResolve, additionally to the first party ones created by LiveConnect (in case storageStrategy is anything else than none, and an actual identifier has been stored).
This configuration setting consists of the following
By default, https://idx.liadm.com/idex.
This parameter should be used in case you might have a specific CNAME per customer, so you can change settings between websites accordingly.
Example:
{
identityResolutionConfig: {
url: 'https://publisher.liveintent.com/idex'
}
}By default, 5000 milliseconds.
This configuration parameter sets the maximum duration of a call to the IdentityResolution endpoint, after which the callback passed to the resolve function will be invoked. If identityResolutionConfig.ajaxTimeout is not configured and the global ajaxTimeout is configured, the global setting is used. If none of the two is configured, the default of 5000ms is used.
Example:
{
identityResolutionConfig: {
ajaxTimeout: 3000
}
}sets the timeout to 3000 millis.
By default, unknown.
This parameter can be used to differentiate the source of the calls to the IdentityResolution endpoint, in case your IdentityResolution endpoint is capturing multiple wrappers containing LiveConnect.
Example:
{
identityResolutionConfig: {
source: 'prebid'
}
}By default, any.
This parameter can be used to track the specific publisher/website that's making use of the stable id returned by the IdentityResolution endpoint.
Example:
{
identityResolutionConfig: {
publisherId: 1234
}
}Attributes that should be resolved by the identity resolution endpoint. Example:
{
identityResolutionConfig: {
requestedAttributes: ['nonId', 'uid2']
}
}Strategy that will be used by live-connect to resolve the idCookie identifier.
generated (default) : live-connect will use an internally generated value as the idcookie.
provided: live-connect will return a user provided identifier as the idCookie. See the idCookie
section for how to configure this identifier.
Example:
{
identityResolutionConfig: {
idCookieMode: 'generated'
}
}IPv4 and IPv6 provided by prebid or clients.
Example:
{
identityResolutionConfig: {
extraAttributes: {
ipv4: '1.2.3.4',
ipv6: '2001:db8:3333:4444:5555:6666:7777:8888'
}
}
}The context selectors to collect from the current page. Example:
{
contextSelectors: "h1,h2,p"
}The maximum string length for the collected elements, truncated at this length when it exceeds. Example:
{
contextElementsLength: 6000
}Usage of this parameter is discouraged and it will be deprecated in a future version of this module. This parameter allows to define the name for the LiveConnect instance that is attached to the window object. If none is provided, Liveconnect will not be attached to the window object.
For example globalVarName: "liQ2" will make the instance name window.liQ2.
Example:
{
globalVarName: "liQ2"
}This parameter defines the way LiveConnect collects the event url. It has 2 possible values:
full: the full url is collected with no changes.no_path: the path part of the url is ignored. Only the domain part will be collected.
The default mode, in case a valid value is not provided, is full
Example:
{
urlCollectionMode: "no_path"
}This parameter allows to define a regular expression which can be used to restrict the collected query parameters.
Any parameter name that matches the regular expression will not be collected. For example queryParametersFilter: "^(foo|bar)$" will block any query parameters named foo or bar, and only collect the remaining ones.
Example:
{
queryParametersFilter: "^(foo|bar)$"
}This parameter allows to configure a custom cookie or localstorage entry as an additional identifier that will be used for user identification.
Setting this to a stable, long-lived and unique identifier will improve tracking performance of live-connect which will in turn improve identity resolution. For these reasons we strongly recommend using this setting if a suitable identifier is available.
Setting this to an identifier that does not meet these requirements might negatively affect id resolution.
Example for providing a custom cookie
{
strategy: "cookie" // or "localStorage"
name: "foobar" // name of the entry
}