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

    Interface Proposal

    A proposed media plan with budget allocations across products. Represents the publisher's strategic recommendation for how to structure a campaign based on the brief. Proposals are actionable - buyers can execute them directly via create_media_buy by providing the proposal_id.

    interface Proposal {
        proposal_id: string;
        name: string;
        description?: string;
        allocations: ProductAllocation[];
        proposal_status?: ProposalStatus;
        expires_at?: string;
        insertion_order?: InsertionOrder;
        total_budget_guidance?: {
            min?: number;
            recommended?: number;
            max?: number;
            currency?: string;
        };
        brief_alignment?: string;
        forecast?: DeliveryForecast;
        ext?: ExtensionObject;
    }
    Index

    Properties

    proposal_id name description? allocations proposal_status? expires_at? insertion_order? total_budget_guidance? brief_alignment? forecast? ext?

    Properties

    proposal_id: string

    Unique identifier for this proposal. Used to execute it via create_media_buy.

    name: string

    Human-readable name for this media plan proposal

    description?: string

    Explanation of the proposal strategy and what it achieves

    allocations: ProductAllocation[]

    Budget allocations across products. Allocation percentages MUST sum to 100. Publishers are responsible for ensuring the sum equals 100; buyers SHOULD validate this before execution.

    proposal_status?: ProposalStatus
    expires_at?: string

    When this proposal expires and can no longer be executed. For draft proposals, indicates when indicative pricing becomes stale. For committed proposals, indicates when the inventory hold lapses — the buyer must call create_media_buy before this time.

    insertion_order?: InsertionOrder
    total_budget_guidance?: {
        min?: number;
        recommended?: number;
        max?: number;
        currency?: string;
    }

    Optional budget guidance for this proposal

    Type Declaration

    • Optionalmin?: number

      Minimum recommended budget

    • Optionalrecommended?: number

      Recommended budget for optimal performance

    • Optionalmax?: number

      Maximum budget before diminishing returns

    • Optionalcurrency?: string

      ISO 4217 currency code

    brief_alignment?: string

    Explanation of how this proposal aligns with the campaign brief

    forecast?: DeliveryForecast
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties