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

    Interface Package

    A specific product within a media buy (line item)

    interface Package {
        package_id: string;
        product_id?: string;
        budget?: number;
        pacing?: Pacing;
        pricing_option_id?: string;
        bid_price?: number;
        price_breakdown?: PriceBreakdown;
        impressions?: number;
        catalogs?: Catalog[];
        format_ids?: FormatID[];
        targeting_overlay?: TargetingOverlay;
        creative_assignments?: CreativeAssignment[];
        format_ids_to_provide?: FormatID[];
        optimization_goals?: OptimizationGoal[];
        start_time?: string;
        end_time?: string;
        paused?: boolean;
        canceled?: boolean;
        cancellation?: {
            canceled_at: string;
            canceled_by: CanceledBy;
            reason?: string;
            acknowledged_at?: string;
        };
        creative_deadline?: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    package_id product_id? budget? pacing? pricing_option_id? bid_price? price_breakdown? impressions? catalogs? format_ids? targeting_overlay? creative_assignments? format_ids_to_provide? optimization_goals? start_time? end_time? paused? canceled? cancellation? creative_deadline? context? ext?

    Properties

    package_id: string

    Seller's unique identifier for the package

    product_id?: string

    ID of the product this package is based on

    budget?: number

    Budget allocation for this package in the currency specified by the pricing option

    pacing?: Pacing
    pricing_option_id?: string

    ID of the selected pricing option from the product's pricing_options array

    bid_price?: number

    Bid price for auction-based pricing. This is the exact bid/price to honor unless the selected pricing option has max_bid=true, in which case bid_price is the buyer's maximum willingness to pay (ceiling).

    price_breakdown?: PriceBreakdown
    impressions?: number

    Impression goal for this package

    catalogs?: Catalog[]

    Catalogs this package promotes. Each catalog MUST have a distinct type (e.g., one product catalog, one store catalog). This constraint is enforced at the application level — sellers MUST reject requests containing multiple catalogs of the same type with a validation_error. Echoed from the create_media_buy request.

    format_ids?: FormatID[]

    Format IDs active for this package. Echoed from the create_media_buy request; omitted means all formats for the product are active.

    targeting_overlay?: TargetingOverlay
    creative_assignments?: CreativeAssignment[]

    Creative assets assigned to this package

    format_ids_to_provide?: FormatID[]

    Format IDs that creative assets will be provided for this package

    optimization_goals?: OptimizationGoal[]

    Optimization targets for this package. The seller optimizes delivery toward these goals in priority order. Common pattern: event goals (purchase, install) as primary targets at priority 1; metric goals (clicks, views) as secondary proxy signals at priority 2+.

    start_time?: string

    Flight start date/time for this package in ISO 8601 format. When omitted, the package inherits the media buy's start_time. Sellers SHOULD always include the resolved value in responses, even when inherited.

    end_time?: string

    Flight end date/time for this package in ISO 8601 format. When omitted, the package inherits the media buy's end_time. Sellers SHOULD always include the resolved value in responses, even when inherited.

    paused?: boolean

    Whether this package is paused by the buyer. Paused packages do not deliver impressions. Defaults to false.

    canceled?: boolean

    Whether this package has been canceled. Canceled packages stop delivery and cannot be reactivated. Defaults to false.

    cancellation?: {
        canceled_at: string;
        canceled_by: CanceledBy;
        reason?: string;
        acknowledged_at?: string;
    }

    Cancellation metadata. Present only when canceled is true.

    Type Declaration

    • canceled_at: string

      ISO 8601 timestamp when this package was canceled.

    • canceled_by: CanceledBy
    • Optionalreason?: string

      Reason the package was canceled.

    • Optionalacknowledged_at?: string

      ISO 8601 timestamp when the seller acknowledged the cancellation. Confirms inventory has been released and billing stopped. Absent until the seller processes the cancellation.

    creative_deadline?: string

    ISO 8601 timestamp for creative upload or change deadline for this package. After this deadline, creative changes are rejected. When absent, the media buy's creative_deadline applies.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties