@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Type Alias LegacyCompatibleCreativeAsset

    LegacyCompatibleCreativeAsset: {} & {
        creative_id: string;
        name: string;
        format_id?: LegacyFormatReferenceStructuredObject;
        format_kind?: CanonicalFormatKind;
        format_option_ref?: FormatOptionReference;
        representation_selection?: RepresentationSelection;
        assets: { [k: string]: AssetVariant | AssetVariant[] };
        component_assets?: { [k: string]: CreativeAssets | undefined };
        inputs?: {
            name: string;
            macros?: { [k: string]: string | undefined };
            context_description?: string;
        }[];
        tags?: string[];
        status?: CreativeStatus;
        weight?: number;
        placement_refs?: [PlacementReference, ...PlacementReference[]];
        placement_ids?: [string, ...string[]];
        industry_identifiers?: IndustryIdentifier[];
        provenance?: Provenance;
        rights?: [RightsConstraint, ...RightsConstraint[]];
    } & (V1CreativeNamedFormatReference | V2CreativeCanonicalFormatKind)

    Creative asset for upload to library — supports static assets, generative formats, and third-party snippets. Identifies which format this creative conforms to via EITHER a legacy format_id (structured {agent_url, id}) OR a 3.1+ format_kind (canonical format name), with optional format_option_ref when the target product needs disambiguation. Mutually exclusive — see the oneOf at the schema root.

    Type Declaration

      • creative_id: string

        Unique identifier for the creative. Stable across legacy named-format and 3.1+ canonical-format paths — a creative registered against format_id retains the same creative_id when later viewed through a canonical-format flatten.

      • name: string

        Human-readable creative name

      • Optionalformat_id?: LegacyFormatReferenceStructuredObject
      • Optionalformat_kind?: CanonicalFormatKind
      • Optionalformat_option_ref?: FormatOptionReference
      • Optionalrepresentation_selection?: RepresentationSelection
      • assets: { [k: string]: AssetVariant | AssetVariant[] }

        Assets required by the format, keyed by asset_id or canonical asset_group_id. Each slot value is either a single asset object or an array of asset objects (for slots with min/max > 1 like carousel cards or responsive_creative headlines). Each asset value carries an asset_type discriminator that selects the matching asset schema, including reference assets such as published_post when a product accepts already-published post references.

      • Optionalcomponent_assets?: { [k: string]: CreativeAssets | undefined }

        Component-addressed canonical asset maps for coordinated_placements. Keys match coordinated component IDs. This field is preserved by creative-library sync and list readback; it MUST be absent for every other format kind.

      • Optionalinputs?: {
            name: string;
            macros?: { [k: string]: string | undefined };
            context_description?: string;
        }[]

        Preview contexts for generative formats - defines what scenarios to generate previews for

      • Optionaltags?: string[]

        User-defined tags for organization and searchability

      • Optionalstatus?: CreativeStatus
      • Optionalweight?: number

        Optional delivery weight for creative rotation when uploading via create_media_buy or update_media_buy (0-100). If omitted, platform determines rotation. Only used during upload to media buy - not stored in creative library.

      • Optionalplacement_refs?: [PlacementReference, ...PlacementReference[]]

        Optional structured product-context placement references where this uploaded creative should run when uploading via create_media_buy or update_media_buy. These items always use placement-ref product-context semantics, even when tolerated additional members make an item resemble placement-identity. Receivers match only against the target package's committed placement set; kind and seller_agent are non-authoritative for routing and MUST NOT expand or reinterpret that set. A receiver MUST reject a ref when the enclosing product and committed set do not yield one unambiguous match. New senders SHOULD include publisher_domain for publisher-catalog placements. If omitted, creative runs on all buyer-targetable placements. If both placement_refs and legacy placement_ids are present, placement_refs wins and receivers MUST ignore placement_ids. Only used during upload to media buy - not stored in creative library.

        1

      • Optionalplacement_ids?: [string, ...string[]]

        Legacy shorthand array of placement IDs where this creative should run when uploading via create_media_buy or update_media_buy. New senders SHOULD use placement_refs because placement IDs are publisher-scoped and strings are ambiguous in multi-publisher products. If omitted, creative runs on all buyer-targetable placements. If placement_refs is also present, receivers MUST ignore this field. Only used during upload to media buy - not stored in creative library.

        1

      • Optionalindustry_identifiers?: IndustryIdentifier[]

        Industry-standard or market-specific identifiers for this creative (e.g., Ad-ID, ISCI, Clearcast clock number, IDcrea). In broadcast and scheduled audio/video buying, these identifiers tie the creative to rotation instructions, clearance records, and traffic systems. A creative may have multiple identifiers when different systems reference the same asset. Add a PR to extend creative-identifier-type when another shared identifier scheme needs first-class support.

      • Optionalprovenance?: Provenance
      • Optionalrights?: [RightsConstraint, ...RightsConstraint[]]

        Rights constraints that MUST survive sync, package assignment, and list readback. Buyer-carried constraints and references do not authorize serving; the seller evaluates them under media_buy.rights_attestations and its adcp.attestations policy.

        1

      • V1CreativeNamedFormatReference
      • V2CreativeCanonicalFormatKind