Skip to Content

title: ExtraContext

Interface: ExtraContext

Legacy publisher-facing context object for static page/app context and publisher-supplied user ids. Replaced by HostContextData; accepted on the integration element for backward compatibility only.

Deprecated

Use HostContextData via IntegrationElement.hostContext instead.

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: "ppid" | "netId" | "theAdexId" | UserIdName | "utiqId" | "yieldlabId" | "liverampId" | "pairId" | "atsDirect" | "sharedId" | "id5Id" | "criteoId" | "lotamePanoramaId" | "unifiedId2Id" | "euId"; ext?: Record<string, unknown> }[];}

Properties

appBundleId?

optional appBundleId: string

HostContextData.appBundleId


appName?

optional appName: string

HostContextData.appName


appStoreId?

optional appStoreId: string

HostContextData.appStoreId


appStoreUrl?

optional appStoreUrl: string

HostContextData.appStoreUrl


appVersion?

optional appVersion: string

HostContextData.appVersion


b2bContext?

optional b2bContext: string

HostContextData.b2bContext


deviceId?

optional deviceId: object

HostContextData.deviceId

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"

HostContextData.presentationalContext


userIds?

optional userIds: object[]

User ids to expose. Each entry is translated to a static hostContextData.userIds registration.

id

id: string

name

name: "ppid" | "netId" | "theAdexId" | UserIdName | "utiqId" | "yieldlabId" | "liverampId" | "pairId" | "atsDirect" | "sharedId" | "id5Id" | "criteoId" | "lotamePanoramaId" | "unifiedId2Id" | "euId"

ext?

optional ext: Record<string, unknown>