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

    Interface ReportPlanOutcomeRequest

    Report the outcome of an action to the governance agent. Called by the orchestrator (buyer-side agent) after a seller responds. This is the 'after' half of the governance loop. Sellers do not call this task -- they report delivery data via check_governance with phase 'delivery'.

    interface ReportPlanOutcomeRequest {
        plan_id: string;
        check_id?: string;
        idempotency_key?: string;
        outcome: OutcomeType;
        seller_response?: {
            media_buy_id?: string;
            committed_budget?: number;
            packages?: { budget?: number }[];
            planned_delivery?: PlannedDelivery;
            creative_deadline?: string;
        };
        delivery?: {
            media_buy_id?: string;
            reporting_period?: { start: string; end: string };
            impressions?: number;
            spend?: number;
            cpm?: number;
            viewability_rate?: number;
            completion_rate?: number;
        };
        error?: { code?: string; message?: string };
        governance_context: string;
    }
    Index

    Properties

    plan_id check_id? idempotency_key? outcome seller_response? delivery? error? governance_context

    Properties

    plan_id: string

    The plan this outcome is for.

    check_id?: string

    The check_id from check_governance. Links the outcome to the governance check that authorized it. Required for 'completed' and 'failed' outcomes.

    idempotency_key?: string

    Client-generated unique key for this request. Prevents duplicate outcome reports on retries. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    outcome: OutcomeType
    seller_response?: {
        media_buy_id?: string;
        committed_budget?: number;
        packages?: { budget?: number }[];
        planned_delivery?: PlannedDelivery;
        creative_deadline?: string;
    }

    The seller's full response. Required when outcome is 'completed'.

    Type Declaration

    • Optionalmedia_buy_id?: string

      Seller's media buy identifier.

    • Optionalcommitted_budget?: number

      Total budget committed across all confirmed packages. When present, the governance agent uses this directly instead of summing package budgets.

    • Optionalpackages?: { budget?: number }[]

      Confirmed packages with actual budget and targeting.

    • Optionalplanned_delivery?: PlannedDelivery
    • Optionalcreative_deadline?: string

      ISO 8601 deadline for creative submission.

    delivery?: {
        media_buy_id?: string;
        reporting_period?: { start: string; end: string };
        impressions?: number;
        spend?: number;
        cpm?: number;
        viewability_rate?: number;
        completion_rate?: number;
    }

    Delivery metrics. Required when outcome is 'delivery'.

    Type Declaration

    • Optionalmedia_buy_id?: string

      The media buy being reported on.

    • Optionalreporting_period?: { start: string; end: string }

      Start and end timestamps for the reporting window.

    • Optionalimpressions?: number

      Impressions delivered in the period.

    • Optionalspend?: number

      Spend in the period.

    • Optionalcpm?: number

      Effective CPM for the period.

    • Optionalviewability_rate?: number

      Viewability rate (0-1).

    • Optionalcompletion_rate?: number

      Video completion rate (0-1).

    error?: { code?: string; message?: string }

    Error details. Required when outcome is 'failed'.

    Type Declaration

    • Optionalcode?: string

      Error code from the seller.

    • Optionalmessage?: string

      Human-readable error description.

    governance_context: string

    Opaque governance context from the check_governance response that authorized this action. Enables the governance agent to correlate the outcome to the original check.

    Settings

    Member Visibility

    On This Page

    Properties