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

    Interface GetCreativeDeliveryRequest

    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.

    interface GetCreativeDeliveryRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        account?: AccountReference;
        media_buy_ids?: string[];
        creative_ids?: string[];
        start_date?: string;
        end_date?: string;
        max_variants?: number;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? account? media_buy_ids? creative_ids? start_date? end_date? max_variants? pagination? context? ext?

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: the AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    account?: AccountReference
    media_buy_ids?: string[]

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

    creative_ids?: string[]

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

    start_date?: string

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

    ^\d{4}-\d{2}-\d{2}$

    end_date?: string

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

    ^\d{4}-\d{2}-\d{2}$

    max_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.

    1

    pagination?: PaginationRequest
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties