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

    Interface CommittedCheckRequest

    Committed governance check request from the seller's perspective.

    interface CommittedCheckRequest {
        planId: string;
        mediaBuyId: string;
        governanceContext?: string;
        plannedDelivery: PlannedDelivery;
        phase?: GovernancePhase;
        deliveryMetrics?: {
            reporting_period: { start: string; end: string };
            spend?: number;
            cumulative_spend?: number;
            impressions?: number;
            cumulative_impressions?: number;
            geo_distribution?: { [k: string]: number | undefined };
            channel_distribution?: { [k: string]: number | undefined };
            pacing?: "ahead" | "on_track" | "behind";
            audience_distribution?: {
                baseline: "custom" | "platform" | "census";
                baseline_description?: string;
                indices: { [k: string]: number | undefined };
                cumulative_indices?: { [k: string]: number | undefined };
            };
        };
        modificationSummary?: string;
    }
    Index

    Properties

    planId: string

    Campaign governance plan ID

    mediaBuyId: string

    The seller's media buy ID

    governanceContext?: string

    Opaque governance context from the buyer's protocol envelope. Pass through verbatim.

    plannedDelivery: PlannedDelivery

    What the seller will actually deliver

    Lifecycle phase of the check

    deliveryMetrics?: {
        reporting_period: { start: string; end: string };
        spend?: number;
        cumulative_spend?: number;
        impressions?: number;
        cumulative_impressions?: number;
        geo_distribution?: { [k: string]: number | undefined };
        channel_distribution?: { [k: string]: number | undefined };
        pacing?: "ahead" | "on_track" | "behind";
        audience_distribution?: {
            baseline: "custom" | "platform" | "census";
            baseline_description?: string;
            indices: { [k: string]: number | undefined };
            cumulative_indices?: { [k: string]: number | undefined };
        };
    }

    Delivery metrics for delivery-phase checks

    Type Declaration

    • reporting_period: { start: string; end: string }

      Start and end timestamps for the reporting window.

    • Optionalspend?: number

      Total spend during the reporting period.

    • Optionalcumulative_spend?: number

      Total spend since the media buy started.

    • Optionalimpressions?: number

      Impressions delivered during the reporting period.

    • Optionalcumulative_impressions?: number

      Total impressions since the media buy started.

    • Optionalgeo_distribution?: { [k: string]: number | undefined }

      Actual geographic distribution. Keys are ISO 3166-1 alpha-2 codes, values are percentages.

    • Optionalchannel_distribution?: { [k: string]: number | undefined }

      Actual channel distribution. Keys are channel enum values, values are percentages.

    • Optionalpacing?: "ahead" | "on_track" | "behind"

      Whether delivery is ahead of, on track with, or behind the planned pace.

    • Optionalaudience_distribution?: {
          baseline: "custom" | "platform" | "census";
          baseline_description?: string;
          indices: { [k: string]: number | undefined };
          cumulative_indices?: { [k: string]: number | undefined };
      }

      Actual audience composition during the reporting period. Enables mid-flight drift detection when actual delivery skews from planned audience targeting.

      • baseline: "custom" | "platform" | "census"

        Population baseline used for index calculation. 'census': national census or equivalent population data. 'platform': the seller's active user base. 'custom': a custom baseline defined by the seller (describe in baseline_description).

      • Optionalbaseline_description?: string

        Description of the baseline when baseline is 'custom' (e.g., 'US adults 18+ with broadband access').

      • indices: { [k: string]: number | undefined }

        Audience index values for the current reporting period. Keys are seller-defined dimension:value strings (e.g., 'age:25-34', 'gender:female', 'income:high'). The protocol does not mandate a taxonomy — dimensions and value labels vary by seller. Values are index relative to the declared baseline (1.0 = at parity, >1.0 = over-indexed, <1.0 = under-indexed).

      • Optionalcumulative_indices?: { [k: string]: number | undefined }

        Cumulative audience index values since the media buy started. Same key format as indices (dimension:value). Use for detecting sustained bias drift that may not appear in a single reporting period.

    modificationSummary?: string

    Summary of changes for modification-phase checks