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

    Interface SyncGovernanceRequest

    Sync governance agent endpoints against specific accounts. The seller persists these governance agents and calls them for approval during media buy lifecycle events via check_governance. Uses replace semantics: each call replaces any previously synced agents on the specified accounts. The seller MUST verify that the authenticated agent has authority over each referenced account before persisting governance agents.

    interface SyncGovernanceRequest {
        adcp_major_version?: number;
        idempotency_key: string;
        accounts: {
            account: AccountReference;
            governance_agents: {
                url: string;
                authentication: { schemes: AuthenticationScheme[]; credentials: string };
                categories?: string[];
            }[];
        }[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version? idempotency_key accounts context? ext?

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    idempotency_key: string

    Client-generated unique key for at-most-once execution. account gives resource-level dedup, but governance changes emit audit events and can trigger reapproval flows — this key prevents those side effects from firing twice on retry. MUST be unique per (seller, request) pair. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    accounts: {
        account: AccountReference;
        governance_agents: {
            url: string;
            authentication: { schemes: AuthenticationScheme[]; credentials: string };
            categories?: string[];
        }[];
    }[]

    Per-account governance agent configuration. Each entry pairs an account reference with the governance agents for that account.

    Type Declaration

    • account: AccountReference
    • governance_agents: {
          url: string;
          authentication: { schemes: AuthenticationScheme[]; credentials: string };
          categories?: string[];
      }[]

      Governance agent endpoints for this account. The seller calls these agents via check_governance during media buy lifecycle events.

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties