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

    Interface GetPropertyListRequest

    Request parameters for retrieving a property list with resolved identifiers

    interface GetPropertyListRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        list_id: string;
        account?: AccountReference;
        resolve?: boolean;
        pagination?: { max_results?: number; cursor?: string };
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? list_id account? resolve? 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.

    list_id: string

    ID of the property list to retrieve

    account?: AccountReference
    resolve?: boolean

    Whether to apply filters and return resolved identifiers (default: true)

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

    Pagination parameters. Uses higher limits than standard pagination because property lists can contain tens of thousands of identifiers.

    Type Declaration

    • Optionalmax_results?: number

      Maximum number of identifiers 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