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

    Interface SyncCreativesRequest

    Request parameters for syncing creative assets with upsert semantics - supports bulk operations, scoped updates, and assignment management

    interface SyncCreativesRequest {
        adcp_version?: string;
        adcp_major_version?: number;
        account: AccountReference;
        creatives: CreativeAsset[];
        creative_ids?: string[];
        assignments?: {
            creative_id: string;
            package_id: string;
            weight?: number;
            placement_ids?: string[];
        }[];
        idempotency_key: string;
        delete_missing?: boolean;
        dry_run?: boolean;
        validation_mode?: ValidationMode;
        push_notification_config?: PushNotificationConfig;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_version? adcp_major_version? account creatives creative_ids? assignments? idempotency_key delete_missing? dry_run? validation_mode? push_notification_config? 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
    creatives: CreativeAsset[]

    Array of creative assets to sync (create or update)

    creative_ids?: string[]

    Optional filter to limit sync scope to specific creative IDs. When provided, only these creatives will be created/updated. Other creatives in the library are unaffected. Useful for partial updates and error recovery.

    assignments?: {
        creative_id: string;
        package_id: string;
        weight?: number;
        placement_ids?: string[];
    }[]

    Optional bulk assignment of creatives to packages. Each entry maps one creative to one package with optional weight and placement targeting. Standalone creative agents that do not manage media buys ignore this field.

    Type Declaration

    • creative_id: string

      ID of the creative to assign

    • package_id: string

      ID of the package to assign the creative to

    • Optionalweight?: number

      Relative delivery weight (0-100). When multiple creatives are assigned to the same package, weights determine impression distribution proportionally. When omitted, the creative receives equal rotation with other unweighted creatives. A weight of 0 means the creative is assigned but paused (receives no delivery).

      0

      100

    • Optionalplacement_ids?: string[]

      Restrict this creative to specific placements within the package. When omitted, the creative is eligible for all placements.

    idempotency_key: string

    Client-generated idempotency key for safe retries. If a sync fails without a response, resending with the same idempotency_key guarantees at-most-once execution. 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}$

    delete_missing?: boolean

    When true, creatives not included in this sync will be archived. Use with caution for full library replacement. Invalid when creative_ids is provided — delete_missing applies to the entire library scope, not a filtered subset.

    dry_run?: boolean

    When true, preview changes without applying them. Returns what would be created/updated/deleted.

    validation_mode?: ValidationMode
    push_notification_config?: PushNotificationConfig
    context?: ContextObject
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties