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

    Interface GetMediaBuyArtifactsRequest

    Request parameters for retrieving content artifacts from a media buy for validation

    interface GetMediaBuyArtifactsRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        account?: AccountReference;
        media_buy_id: string;
        package_ids?: string[];
        failures_only?: boolean;
        time_range?: { start?: string; end?: string };
        pagination?: { max_results?: number; cursor?: string };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? account? media_buy_id package_ids? failures_only? time_range? pagination? 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.

    account?: AccountReference
    media_buy_id: string

    Media buy to get artifacts from

    package_ids?: string[]

    Filter to specific packages within the media buy

    failures_only?: boolean

    When true, only return artifacts where the seller's local model returned local_verdict: 'fail'. Useful for auditing false positives. Not useful when the seller does not run a local evaluation model (all verdicts are 'unevaluated').

    time_range?: { start?: string; end?: string }

    Filter to specific time period

    Type Declaration

    • Optionalstart?: string

      Start of time range (inclusive)

      date-time

    • Optionalend?: string

      End of time range (exclusive)

      date-time

    pagination?: { max_results?: number; cursor?: string }

    Pagination parameters. Uses higher limits than standard pagination because artifact result sets can be very large.

    Type Declaration

    • Optionalmax_results?: number

      Maximum number of artifacts to return per page

      1

      10000

    • Optionalcursor?: string

      Opaque cursor from a previous response to fetch the next page

    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties