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

    Interface GetMediaBuysRequest

    Request parameters for retrieving media buy status, creative approval state, and optional delivery snapshots

    interface GetMediaBuysRequest {
        account?: AccountReference;
        media_buy_ids?: string[];
        status_filter?: MediaBuyStatus | MediaBuyStatus[];
        include_snapshot?: boolean;
        include_history?: number;
        pagination?: PaginationRequest;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    media_buy_ids?: string[]

    Array of media buy IDs to retrieve. When omitted, returns a paginated set of accessible media buys matching status_filter.

    status_filter?: MediaBuyStatus | MediaBuyStatus[]

    Filter by status. Can be a single status or array of statuses. Defaults to ["active"] when media_buy_ids is omitted. When media_buy_ids is provided, no implicit status filter is applied.

    include_snapshot?: boolean

    When true, include a near-real-time delivery snapshot for each package. Snapshots reflect the latest available entity-level stats from the platform (e.g., updated every ~15 minutes on GAM, ~1 hour on batch-only platforms). The staleness_seconds field on each snapshot indicates data freshness. If a snapshot cannot be returned, package.snapshot_unavailable_reason explains why. Defaults to false.

    include_history?: number

    When present, include the last N revision history entries for each media buy (returns min(N, available entries)). Each entry contains revision number, timestamp, actor, and a summary of what changed. Omit or set to 0 to exclude history (default). Recommended: 5-10 for monitoring, 50+ for audit.

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