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

    Interface CreateMediaBuySuccess

    Success response - media buy created successfully

    interface CreateMediaBuySuccess {
        media_buy_id: string;
        account?: Account;
        invoice_recipient?: BusinessEntity;
        media_buy_status?: MediaBuyStatus;
        status?: MediaBuyStatus;
        confirmed_at?: string | null;
        creative_deadline?: string;
        revision?: number;
        currency?: string;
        total_budget?: number;
        valid_actions?: MediaBuyValidAction[];
        available_actions?: MediaBuyAvailableAction[];
        packages: Package[];
        planned_delivery?: PlannedDelivery;
        sandbox?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    media_buy_id account? invoice_recipient? media_buy_status? status? confirmed_at? creative_deadline? revision? currency? total_budget? valid_actions? available_actions? packages planned_delivery? sandbox? context? ext?

    Properties

    media_buy_id: string

    Seller's unique identifier for the created media buy

    account?: Account
    invoice_recipient?: BusinessEntity
    media_buy_status?: MediaBuyStatus
    status?: MediaBuyStatus
    confirmed_at?: string | null

    ISO 8601 timestamp when this media buy was committed by the seller. Stable after it is set; do not update on later pause/resume/status/reporting transitions. May be null in deferred or manual-approval flows until seller commitment occurs.

    date-time

    creative_deadline?: string

    ISO 8601 timestamp for creative upload deadline

    date-time

    revision?: number

    Initial revision number for this media buy. Use in subsequent update_media_buy requests intended to change state for optimistic concurrency.

    1

    currency?: string

    ISO 4217 currency code (e.g., USD, EUR, GBP) for monetary values at this media buy level. total_budget is denominated in this currency. Package-level fields may override with package.currency. In proposal mode the seller derives this from the request's total_budget object (total_budget.currency); in manual mode it is present when all packages share a currency. Matches the currency field in subsequent get_media_buys responses.

    ^[A-Z]{3}$

    total_budget?: number

    Total budget amount across all packages, denominated in currency. Note: the create_media_buy request encodes total_budget as an object {amount, currency} (proposal mode only); this response field is the flattened scalar amount, with currency promoted to the sibling currency field. Present when the seller can compute a deterministic aggregate — always in proposal mode, conditionally in manual mode when all packages share a currency. Matches the total_budget field in subsequent get_media_buys responses.

    0

    valid_actions?: MediaBuyValidAction[]

    Flat-vocabulary actions the buyer can perform on this media buy after creation. Saves a round-trip to get_media_buys. Deprecated in favor of available_actions[], which carries mode, optional SLA, and optional terms_ref. Sellers SHOULD populate both during the 3.x deprecation window; consumers MUST prefer available_actions[] when both are present. Removed in 4.0.

    available_actions?: MediaBuyAvailableAction[]

    Structured per-buy resolution of actions available immediately after creation. Authoritative — see get-media-buys-response.json for full semantics.

    packages: Package[]

    Array of created packages with complete state information

    planned_delivery?: PlannedDelivery
    sandbox?: boolean

    When true, this response contains simulated data from sandbox mode.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties