@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface SyncPlansResponse

    Response from syncing campaign plans. Returns status and active validation categories for each plan.

    interface SyncPlansResponse {
        plans: {
            plan_id: string;
            status: "active" | "error";
            version: number;
            categories?: { category_id: string; status: "active" | "inactive" }[];
            resolved_policies?: {
                policy_id: string;
                source: "explicit" | "auto_applied";
                enforcement: PolicyEnforcementLevel;
                reason?: string;
            }[];
        }[];
        replayed?: boolean;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    plans replayed? context? ext?

    Properties

    plans: {
        plan_id: string;
        status: "active" | "error";
        version: number;
        categories?: { category_id: string; status: "active" | "inactive" }[];
        resolved_policies?: {
            policy_id: string;
            source: "explicit" | "auto_applied";
            enforcement: PolicyEnforcementLevel;
            reason?: string;
        }[];
    }[]

    Status for each synced plan.

    Type Declaration

    • plan_id: string

      Plan identifier.

    • status: "active" | "error"

      Sync result status. 'active' means sync succeeded; 'error' means sync failed.

    • version: number

      Plan version (increments on each sync).

    • Optionalcategories?: { category_id: string; status: "active" | "inactive" }[]

      Validation categories active for this plan.

    • Optionalresolved_policies?: {
          policy_id: string;
          source: "explicit" | "auto_applied";
          enforcement: PolicyEnforcementLevel;
          reason?: string;
      }[]

      Policies the governance agent will enforce for this plan. Includes explicitly referenced policies from the brand compliance configuration and auto-applied policies matched by jurisdiction or policy category. Present when the governance agent supports policy resolution.

    replayed?: boolean

    Set to true when this response is a cached replay returned for an idempotency_key that was already processed. Set to false (or omitted) when the request was executed fresh. Buyers use this to distinguish cached replays from new executions — matters for billing reconciliation, audit logs, and any downstream system that assumes exactly-once event semantics. Only present on responses to mutating requests that carry idempotency_key.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties