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

    Interface Proposal

    Extension object for platform-specific, vendor-namespaced parameters. Extensions are always optional and must be namespaced under a vendor/platform key (e.g., ext.gam, ext.roku). Used for custom capabilities, partner-specific configuration, and features being proposed for standardization.

    interface Proposal {
        proposal_id: string;
        name: string;
        description?: string;
        allocations: [ProductAllocation, ...ProductAllocation[]];
        expires_at?: string;
        total_budget_guidance?: {
            min?: number;
            recommended?: number;
            max?: number;
            currency?: string;
            [k: string]: unknown;
        };
        brief_alignment?: string;
        ext?: ExtensionObject;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    proposal_id name description? allocations expires_at? total_budget_guidance? brief_alignment? ext?

    Properties

    proposal_id: string

    Unique identifier for this proposal. Used to refine the proposal in subsequent get_products calls or 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, ...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.

    1

    expires_at?: string

    When this proposal expires and can no longer be executed. After expiration, referenced products or pricing may no longer be available.

    total_budget_guidance?: {
        min?: number;
        recommended?: number;
        max?: number;
        currency?: string;
        [k: string]: unknown;
    }

    Optional budget guidance for this proposal

    Type Declaration

    • [k: string]: unknown
    • 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

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties