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

    Interface PackageRequest

    Package configuration for media buy creation

    interface PackageRequest {
        product_id: string;
        format_ids?: FormatID[];
        budget: number;
        pacing?: Pacing;
        pricing_option_id: string;
        bid_price?: number;
        impressions?: number;
        start_time?: string;
        end_time?: string;
        paused?: boolean;
        catalogs?: Catalog[];
        optimization_goals?: OptimizationGoal[];
        targeting_overlay?: TargetingOverlay;
        creative_assignments?: CreativeAssignment[];
        creatives?: CreativeAsset[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    product_id: string

    Product ID for this package

    format_ids?: FormatID[]

    Array of format IDs that will be used for this package - must be supported by the product. If omitted, defaults to all formats supported by the product.

    budget: number

    Budget allocation for this package in the media buy's currency

    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 options. This is the exact bid/price to honor unless selected pricing_option has max_bid=true, in which case bid_price is the buyer's maximum willingness to pay (ceiling).

    impressions?: number

    Impression goal for this package

    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. Must fall within the media buy's date range.

    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. Must fall within the media buy's date range.

    paused?: boolean

    Whether this package should be created in a paused state. Paused packages do not deliver impressions. Defaults to false.

    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. Makes the package catalog-driven: one budget envelope, platform optimizes across items.

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

    targeting_overlay?: TargetingOverlay
    creative_assignments?: CreativeAssignment[]

    Assign existing library creatives to this package with optional weights and placement targeting

    creatives?: CreativeAsset[]

    Upload new creative assets and assign to this package (creatives will be added to library). Use creative_assignments instead for existing library creatives.

    context?: ContextObject
    ext?: ExtensionObject