@adcp/client API Reference - v4.19.0
    Preparing search index...

    Type Alias GetCreativeDeliveryRequest

    GetCreativeDeliveryRequest: { [k: string]: unknown } & {
        account?: AccountReference;
        media_buy_ids?: string[];
        creative_ids?: string[];
        start_date?: string;
        end_date?: string;
        max_variants?: number;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }

    Request parameters for retrieving creative delivery data including variant-level metrics from a creative agent. At least one scoping filter (media_buy_ids or creative_ids) is required.

    Type Declaration

    • [k: string]: unknown
    • Optionalaccount?: AccountReference
    • Optionalmedia_buy_ids?: string[]

      Filter to specific media buys by publisher ID. If omitted, returns creative delivery across all matching media buys.

    • Optionalcreative_ids?: string[]

      Filter to specific creatives by ID. If omitted, returns delivery for all creatives matching the other filters.

    • Optionalstart_date?: string

      Start date for delivery period (YYYY-MM-DD). Interpreted in the platform's reporting timezone.

    • Optionalend_date?: string

      End date for delivery period (YYYY-MM-DD). Interpreted in the platform's reporting timezone.

    • Optionalmax_variants?: number

      Maximum number of variants to return per creative. When omitted, the agent returns all variants. Use this to limit response size for generative creatives that may produce large numbers of variants.

    • Optionalpagination?: PaginationRequest
    • Optionalcontext?: ContextObject
    • Optionalext?: ExtensionObject

    Settings

    Member Visibility