Interface: ExtraContext

An optional context object that can be used to pass additional application, device and user information to the integration. Updates must be performed immutably: always provide a new object to the IntegrationElement#extraContext property when modifying any property or nested field.

interface ExtraContext {    appBundleId?: string;    appName?: string;    appStoreId?: string;    appStoreUrl?: string;    appVersion?: string;    b2bContext?: string;    deviceId?: { id: string; name: DeviceIdName | "aaid" | "afai" | "asia" | "asid" | "tifa" | "vaid" | "idfa" | "idfv" | "lgudid" | "msai" | "oaid" | "psnai" | "rida" | "vida" | "waid" };    presentationalContext?: "curated-list" | "discovery-page";    userIds?: { id: string; name: UserIdName | "netId" | "ppid" | "utiqId" | "liverampId" | "pairId" | "atsDirect"; ext?: Record<string, unknown> }[];}

Properties

appBundleId?

optional appBundleId: string

The bundle id of the app. Only required for iOS apps.

appName?

optional appName: string

The name of the app. When it is a website, fill in the name of the project.

appStoreId?

optional appStoreId: string

The store id of the app. Only required for apps. Depending on the app store, the id is formatted differently. IAB Tech Lab App Identification Guidelines 

appStoreUrl?

optional appStoreUrl: string

The store URL of the app. Only required for apps. IAB Tech Lab App Identification Guidelines 

appVersion?

optional appVersion: string

The version of the app. When it is a website, fill in the deployed version of the website.

b2bContext?

optional b2bContext: string

deviceId?

optional deviceId: object

id

id: string

name

name: DeviceIdName | "aaid" | "afai" | "asia" | "asid" | "tifa" | "vaid" | "idfa" | "idfv" | "lgudid" | "msai" | "oaid" | "psnai" | "rida" | "vida" | "waid"

presentationalContext?

optional presentationalContext: "curated-list" | "discovery-page"

The presentational context of the integration. Do not define it when it is not part of those contexts.

userIds?

optional userIds: object[]

User ids of the user. User ids are only used when the user has given consent for the assigned vendor.

id

id: string

name

name: UserIdName | "netId" | "ppid" | "utiqId" | "liverampId" | "pairId" | "atsDirect"

ext?

optional ext: Record<string, unknown>