@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface ProductAllocation

    A product included in a proposal's budget plan. Fixed proposals use allocation_percentage. Seller-optimized proposals use optional minimum-spend targets and maximum-spend constraints instead of an exact allocation.

    interface ProductAllocation {
        product_id: string;
        allocation_percentage?: number;
        min_spend_target_percentage?: number;
        max_spend_percentage?: number;
        pacing?: Pacing;
        pricing_option_id?: string;
        rationale?: string;
        sequence?: number;
        tags?: string[];
        start_time?: string;
        end_time?: string;
        daypart_targets?: [DaypartTarget, ...DaypartTarget[]];
        forecast?: DeliveryForecast;
        ext?: ExtensionObject;
    }
    Index

    Properties

    product_id allocation_percentage? min_spend_target_percentage? max_spend_percentage? pacing? pricing_option_id? rationale? sequence? tags? start_time? end_time? daypart_targets? forecast? ext?

    Properties

    product_id: string

    ID of the product (must reference a product in the products array)

    allocation_percentage?: number

    Exact percentage of total budget allocated to this product in a fixed proposal. Percentages across all allocations MUST sum to 100. Must be absent in a seller-optimized proposal.

    min_spend_target_percentage?: number

    Soft minimum-spend target as a percentage of the executed total budget. Only valid in seller-optimized proposals. The seller SHOULD attempt to reach it, but it is not a delivery guarantee. Minimum targets across allocations MUST sum to no more than 100.

    max_spend_percentage?: number

    Hard maximum share of the executed total budget that this product may spend. Only valid in seller-optimized proposals. Maximums across allocations MUST collectively permit 100 percent of the budget to be spent.

    pacing?: Pacing
    pricing_option_id?: string

    Selected pricing option ID from the product's pricing_options array. Required when the containing proposal is committed so create_media_buy executes the exact disclosed commercial terms; optional on legacy draft proposals.

    rationale?: string

    Explanation of why this product and allocation are recommended

    sequence?: number

    Optional ordering hint for multi-line-item plans (1-based)

    tags?: string[]

    Categorical tags for this allocation (e.g., 'desktop', 'german', 'mobile') - useful for grouping/filtering allocations by dimension

    start_time?: string

    Recommended flight start date/time for this allocation in ISO 8601 format. Allows publishers to propose per-flight scheduling within a proposal. When omitted, the allocation applies to the full campaign date range.

    end_time?: string

    Recommended flight end date/time for this allocation in ISO 8601 format. Allows publishers to propose per-flight scheduling within a proposal. When omitted, the allocation applies to the full campaign date range.

    daypart_targets?: [DaypartTarget, ...DaypartTarget[]]

    Recommended time windows for this allocation in spot-plan proposals.

    1

    forecast?: DeliveryForecast
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties