@adcp/client API Reference - v3.11.2
    Preparing search index...

    Interface PackageRequest

    Package configuration for media buy creation

    interface PackageRequest {
        buyer_ref: string;
        product_id: string;
        format_ids?: [FormatID, ...FormatID[]];
        budget: number;
        pacing?: Pacing;
        pricing_option_id: string;
        bid_price?: number;
        impressions?: number;
        paused?: boolean;
        targeting_overlay?: TargetingOverlay;
        creative_assignments?: CreativeAssignment[];
        creatives?: CreativeAsset[];
        ext?: ExtensionObject;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    buyer_ref product_id format_ids? budget pacing? pricing_option_id bid_price? impressions? paused? targeting_overlay? creative_assignments? creatives? ext?

    Properties

    buyer_ref: string

    Buyer's reference identifier for this package

    product_id: string

    Product ID for this package

    format_ids?: [FormatID, ...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.

    1

    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 CPM pricing (required if using cpm-auction-option)

    impressions?: number

    Impression goal for this package

    paused?: boolean

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

    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.

    100

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties