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

    Interface CreativeApprovalRequest

    Payload submitted by the buyer to the approval_webhook URL from acquire_rights. Contains the creative for rights holder review before distribution.

    interface CreativeApprovalRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        rights_id: string;
        creative_id?: string;
        creative_url: string;
        creative_format?: FormatReferenceStructuredObject;
        description?: string;
        metadata?: {};
        idempotency_key: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? rights_id creative_id? creative_url creative_format? description? metadata? idempotency_key context? ext?

    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.

    rights_id: string

    Rights grant this creative was produced under

    creative_id?: string

    Buyer-assigned creative identifier. Equivalent to OpenRTB crid. Used to track approval status across resubmissions.

    creative_url: string

    URL where the creative asset can be retrieved for review

    creative_format?: FormatReferenceStructuredObject
    description?: string

    Description of the creative for reviewer context

    metadata?: {}

    Additional creative metadata (duration, dimensions, target audience, etc.)

    idempotency_key: string

    Client-generated key for safe retries. Resubmitting with the same key returns the original response. 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}$

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties