@adcp/sdk API Reference - v14.0.0-beta.6
    Preparing search index...

    Interface GovernanceIntentDetails

    interface GovernanceIntentDetails {
        proposedCommitment?: GovernanceCommitment;
        proposal?: {
            proposal_id: string;
            proposal_kind:
                | "new_media_buy"
                | "media_buy_update"
                | "media_buy_cancellation";
            parent_proposal_id?: string;
            media_buy_id?: string;
            opportunity_id?: string;
            base_media_buy_revision?: number;
            proposal_status: ProposalStatus;
            accepted_at?: string;
            expires_at?: string;
            name: string;
            description?: string;
            brief_alignment?: string;
            commercial_terms: CommercialTerms;
            terms_digest: string;
            insertion_order?: InsertionOrder;
        };
        purchaseType?: PurchaseType;
        runtimeAttestations?: (
            {
                issuer: AttestationIssuer;
                claim_type: string;
                subject: AttestationSubject;
                locator?: | AttestationCredentialUriLocator
                | AttestationIssuerCredentialIdLocator;
                embedded_credential?: {
                    format: string;
                    value: string
                    | {};
                    ext?: ExtensionObject;
                };
                content_digest?: string;
                credential_version?: string;
                validity_hint?: { not_before?: string; expires_at?: string };
                verify_agent?: { agent_url: string };
                ext?: ExtensionObject;
            } & {
                issuer: AttestationIssuer;
                claim_type: string;
                subject: AttestationSubject;
                locator?: | AttestationCredentialUriLocator
                | AttestationIssuerCredentialIdLocator;
                embedded_credential?: {
                    format: string;
                    value: string
                    | {};
                    ext?: ExtensionObject;
                };
                content_digest?: string;
                credential_version?: string;
                validity_hint?: { not_before?: string; expires_at?: string };
                verify_agent?: { agent_url: string };
                ext?: ExtensionObject;
            } & {
                subject?: {
                    type: "resource";
                    resource_type: "https://adcontextprotocol.org/claims/subjects/signal";
                };
            }
        )[];
        invoiceRecipient?: BusinessEntity;
    }
    Index

    Properties

    proposedCommitment?: GovernanceCommitment

    Required for tasks whose commitment is not directly derivable from payload.

    proposal?: {
        proposal_id: string;
        proposal_kind:
            | "new_media_buy"
            | "media_buy_update"
            | "media_buy_cancellation";
        parent_proposal_id?: string;
        media_buy_id?: string;
        opportunity_id?: string;
        base_media_buy_revision?: number;
        proposal_status: ProposalStatus;
        accepted_at?: string;
        expires_at?: string;
        name: string;
        description?: string;
        brief_alignment?: string;
        commercial_terms: CommercialTerms;
        terms_digest: string;
        insertion_order?: InsertionOrder;
    }

    Required for accept_proposal so governance can verify commercial terms.

    Type Declaration

    • proposal_id: string
    • proposal_kind: "new_media_buy" | "media_buy_update" | "media_buy_cancellation"
    • Optionalparent_proposal_id?: string

      Immediate predecessor this snapshot was forked from. Every proposal produced by refine_proposals carries it, equal to the request's source proposal_id, so negotiation lineage is reconstructible from proposals alone.

    • Optionalmedia_buy_id?: string
    • Optionalopportunity_id?: string

      Buyer planning cycle associated with this proposal. Revisions inherit it; it does not participate in proposal identity.

    • Optionalbase_media_buy_revision?: number
    • proposal_status: ProposalStatus
    • Optionalaccepted_at?: string
    • Optionalexpires_at?: string

      For a draft, the indicative-terms freshness deadline. For a committed proposal, the inventory-hold deadline.

    • name: string
    • Optionaldescription?: string
    • Optionalbrief_alignment?: string
    • commercial_terms: CommercialTerms
    • terms_digest: string

      Base64url SHA-256 digest of the RFC 8785 JCS serialization of commercial_terms, prefixed with sha256:.

    • Optionalinsertion_order?: InsertionOrder
    purchaseType?: PurchaseType

    Overrides the task-derived purchase type when a future task needs one.

    runtimeAttestations?: (
        {
            issuer: AttestationIssuer;
            claim_type: string;
            subject: AttestationSubject;
            locator?: | AttestationCredentialUriLocator
            | AttestationIssuerCredentialIdLocator;
            embedded_credential?: {
                format: string;
                value: string
                | {};
                ext?: ExtensionObject;
            };
            content_digest?: string;
            credential_version?: string;
            validity_hint?: { not_before?: string; expires_at?: string };
            verify_agent?: { agent_url: string };
            ext?: ExtensionObject;
        } & {
            issuer: AttestationIssuer;
            claim_type: string;
            subject: AttestationSubject;
            locator?: | AttestationCredentialUriLocator
            | AttestationIssuerCredentialIdLocator;
            embedded_credential?: {
                format: string;
                value: string
                | {};
                ext?: ExtensionObject;
            };
            content_digest?: string;
            credential_version?: string;
            validity_hint?: { not_before?: string; expires_at?: string };
            verify_agent?: { agent_url: string };
            ext?: ExtensionObject;
        } & {
            subject?: {
                type: "resource";
                resource_type: "https://adcontextprotocol.org/claims/subjects/signal";
            };
        }
    )[]

    Runtime evidence used by signal-activation intent checks.

    Type Declaration

    • issuer: AttestationIssuer
    • claim_type: string

      Open, absolute URI identifying the claim vocabulary. The URI is an identifier and need not be dereferenceable. AdCP does not maintain an enum of approved claims.

    • subject: AttestationSubject
    • Optionallocator?: AttestationCredentialUriLocator | AttestationIssuerCredentialIdLocator

      Stable locator for resolving the credential. Credential URLs are permitted only when their canonical origin is allowlisted for the matched issuer. Issuer-scoped IDs name a resolver_id already published by the evaluator; the presentation cannot introduce a resolver URL.

    • Optionalembedded_credential?: { format: string; value: string | {}; ext?: ExtensionObject }

      Optional inline credential for private, authenticated, or offline delivery. It may accompany locator or be the only delivery path. Its format must be supported by the evaluator, and the evaluator MUST verify the credential exactly as it would a resolved credential.

      • format: string

        Open, absolute URI identifying the credential/proof format. AdCP does not impose a universal issuer payload schema.

      • value: string | {}

        Credential encoded as a JSON object or a compact string, according to format.

      • Optionalext?: ExtensionObject
    • Optionalcontent_digest?: string

      Optional SHA-256 digest pin for the exact credential bytes, formatted as sha256:. The credential format defines its canonical byte representation. A mismatch is invalid and MUST NOT fall back to the unpinned credential. REQUIRED when both locator and embedded_credential are present; both byte representations MUST match this digest.

    • Optionalcredential_version?: string

      Optional issuer-defined credential version hint. It is advisory; the resolved credential is authoritative.

    • Optionalvalidity_hint?: { not_before?: string; expires_at?: string }

      Optional planning-time validity hint copied from issuer metadata. Evaluators MUST use the resolved or embedded credential's signed validity and revocation state as authoritative.

    • Optionalverify_agent?: { agent_url: string }

      Optional presenter nomination of a verifier already published by the evaluator. This is a representation, not routing authority: agent_url MUST match an accepted_verifiers[] entry after canonicalization, and the evaluator may choose another accepted verifier or verify locally.

    • Optionalext?: ExtensionObject
    • issuer: AttestationIssuer
    • claim_type: string

      Open, absolute URI identifying the claim vocabulary. The URI is an identifier and need not be dereferenceable. AdCP does not maintain an enum of approved claims.

    • subject: AttestationSubject
    • Optionallocator?: AttestationCredentialUriLocator | AttestationIssuerCredentialIdLocator

      Stable locator for resolving the credential. Credential URLs are permitted only when their canonical origin is allowlisted for the matched issuer. Issuer-scoped IDs name a resolver_id already published by the evaluator; the presentation cannot introduce a resolver URL.

    • Optionalembedded_credential?: { format: string; value: string | {}; ext?: ExtensionObject }

      Optional inline credential for private, authenticated, or offline delivery. It may accompany locator or be the only delivery path. Its format must be supported by the evaluator, and the evaluator MUST verify the credential exactly as it would a resolved credential.

      • format: string

        Open, absolute URI identifying the credential/proof format. AdCP does not impose a universal issuer payload schema.

      • value: string | {}

        Credential encoded as a JSON object or a compact string, according to format.

      • Optionalext?: ExtensionObject
    • Optionalcontent_digest?: string

      Optional SHA-256 digest pin for the exact credential bytes, formatted as sha256:. The credential format defines its canonical byte representation. A mismatch is invalid and MUST NOT fall back to the unpinned credential. REQUIRED when both locator and embedded_credential are present; both byte representations MUST match this digest.

    • Optionalcredential_version?: string

      Optional issuer-defined credential version hint. It is advisory; the resolved credential is authoritative.

    • Optionalvalidity_hint?: { not_before?: string; expires_at?: string }

      Optional planning-time validity hint copied from issuer metadata. Evaluators MUST use the resolved or embedded credential's signed validity and revocation state as authoritative.

    • Optionalverify_agent?: { agent_url: string }

      Optional presenter nomination of a verifier already published by the evaluator. This is a representation, not routing authority: agent_url MUST match an accepted_verifiers[] entry after canonicalization, and the evaluator may choose another accepted verifier or verify locally.

    • Optionalext?: ExtensionObject
    • Optionalsubject?: {
          type: "resource";
          resource_type: "https://adcontextprotocol.org/claims/subjects/signal";
      }
    invoiceRecipient?: BusinessEntity

    Billing override that governance must evaluate with the commitment.