@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface UpdateContentStandardsRequest

    Request parameters for updating an existing content standards configuration. Creates a new version.

    interface UpdateContentStandardsRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        standards_id: string;
        scope?: {
            countries_all?: string[];
            channels_any?: MediaChannel[];
            languages_any?: string[];
            description?: string;
        };
        registry_policy_ids?: string[];
        policies?: PolicyEntry[];
        calibration_exemplars?: {
            pass?: (Artifact | { type: "url"; value: string; language?: string })[];
            fail?: (Artifact | { type: "url"; value: string; language?: string })[];
        };
        context?: ContextObject;
        ext?: ExtensionObject;
        idempotency_key: string;
    }
    Index

    Properties

    adcp_version? adcp_major_version? standards_id scope? registry_policy_ids? policies? calibration_exemplars? context? ext? idempotency_key

    Properties

    adcp_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    standards_id: string

    ID of the standards configuration to update

    scope?: {
        countries_all?: string[];
        channels_any?: MediaChannel[];
        languages_any?: string[];
        description?: string;
    }

    Updated scope for where this standards configuration applies

    Type Declaration

    • Optionalcountries_all?: string[]

      ISO 3166-1 alpha-2 country codes. Standards apply in ALL listed countries (AND logic).

    • Optionalchannels_any?: MediaChannel[]

      Advertising channels. Standards apply to ANY of the listed channels (OR logic).

    • Optionallanguages_any?: string[]

      BCP 47 language tags (e.g., 'en', 'de', 'fr'). Standards apply to content in ANY of these languages (OR logic). Content in unlisted languages is not covered by these standards.

    • Optionaldescription?: string

      Human-readable description of this scope

    registry_policy_ids?: string[]

    Registry policy IDs to use as the evaluation basis. When provided, the agent resolves policies from the registry and uses their policy text and exemplars as the evaluation criteria.

    policies?: PolicyEntry[]

    Updated bespoke policies for this content-standards configuration, using the same shape as registry entries. Replaces the existing policies array; use stable policy_ids to track policies across versions. Combines with registry_policy_ids. Bespoke policy_ids MUST be flat (no colons/slashes).

    calibration_exemplars?: {
        pass?: (Artifact | { type: "url"; value: string; language?: string })[];
        fail?: (Artifact | { type: "url"; value: string; language?: string })[];
    }

    Updated training/test set to calibrate policy interpretation. Use URL references for pages to be fetched and analyzed, or full artifacts for pre-extracted content.

    Type Declaration

    • Optionalpass?: (Artifact | { type: "url"; value: string; language?: string })[]

      Content that passes the standards

    • Optionalfail?: (Artifact | { type: "url"; value: string; language?: string })[]

      Content that fails the standards

    context?: ContextObject
    ext?: ExtensionObject
    idempotency_key: string

    Client-generated unique key for at-most-once execution. If a request with the same key has already been processed, the server returns the original response without re-processing. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    16

    255

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

    Settings

    Member Visibility

    On This Page

    Properties