@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface EventCustomData

    Event-specific data (value, currency, items, etc.)

    interface EventCustomData {
        value?: number;
        currency?: string;
        order_id?: string;
        content_ids?: string[];
        content_type?: string;
        content_name?: string;
        content_category?: string;
        num_items?: number;
        search_string?: string;
        progress_percent?: number;
        progress_seconds?: number;
        contents?: {
            id: string;
            quantity?: number;
            price?: number;
            brand?: string;
        }[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    value? currency? order_id? content_ids? content_type? content_name? content_category? num_items? search_string? progress_percent? progress_seconds? contents? ext?

    Properties

    value?: number

    Monetary value of the event (should be accompanied by currency)

    0

    currency?: string

    ISO 4217 currency code

    ^[A-Z]{3}$

    order_id?: string

    Unique order or transaction identifier

    Optionalcontent_ids

    content_ids?: string[]

    Item identifiers for catalog attribution. Values are matched against catalog items using the identifier type declared by the catalog's content_id_type field (e.g., SKUs, GTINs, or vertical-specific IDs like job_id).

    Optionalcontent_type

    content_type?: string

    Category of content associated with the event (e.g., 'product', 'job', 'hotel'). Corresponds to the catalog type when used for catalog attribution.

    Optionalcontent_name

    content_name?: string

    Name of the product or content

    Optionalcontent_category

    content_category?: string

    Category of the product or content

    num_items?: number

    Number of items in the event

    0

    search_string?: string

    Search query for search events

    progress_percent?: number

    Content progress percentage reached, primarily for watch_milestone events. Use 25, 50, 75, or 100 for quartiles, or another publisher-defined threshold. Do not use value for non-monetary progress.

    0

    100

    progress_seconds?: number

    Content progress duration reached in seconds, primarily for watch_milestone events. Use when the milestone is time-based rather than percentage-based.

    0

    contents?: { id: string; quantity?: number; price?: number; brand?: string }[]

    Per-item details for e-commerce events

    Type Declaration

    • id: string

      Product or content identifier

    • Optionalquantity?: number

      Quantity of this item

      1

    • Optionalprice?: number

      Price per unit of this item

      0

    • Optionalbrand?: string

      Brand name of this item

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties