Skip to Content

title: HostContextUserIdDefinition

Interface: HostContextUserIdDefinition

Publisher-facing shape of a user ID entry.

Internal ortb2 metadata (atype, gvlId) is applied centrally by the consumer. source may be overridden by the resolver; pass '' to suppress the EID entirely.

interface HostContextUserIdDefinition {    id: string;    additionalUids?: { id: string; ext?: Record<string, unknown> }[];    ext?: Record<string, unknown>;    source?: string;}

Properties

id

id: string


additionalUids?

optional additionalUids: object[]

Additional UIDs for the same EID source (ortb2 uids[1..]). The atype for each entry is inherited from the registry, matching the primary uid. Useful when an id vendor returns multiple IDs per source (e.g. Prebid.js EIDs with more than one uid).

id

id: string

ext?

optional ext: Record<string, unknown>


ext?

optional ext: Record<string, unknown>

Optional ortb2 ext payload merged into the resulting EID.


source?

optional source: string

Optional ortb2 EID source override. Pass '' to keep the id internal-only.