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

    Type Alias CreativeManifest

    CreativeManifest: {
        format_id?: FormatReferenceStructuredObject;
        format_kind?: CanonicalFormatKind;
        format_option_ref?: FormatOptionReference;
        assets: { [k: string]: AssetVariant | AssetVariant[] };
        brand?: BrandReference;
        rights?: RightsConstraint[];
        industry_identifiers?: IndustryIdentifier[];
        provenance?: Provenance;
        ext?: ExtensionObject;
    } & (LegacyManifestNamedFormatReference | ManifestCanonicalFormatKind)

    Creative manifest to transform or generate from. For pure generation, this should include the target format_id and any required input assets. For transformation (e.g., resizing, reformatting), this is the complete creative to adapt. When creative_id is provided, the agent resolves the creative from its library and this field is ignored.

    Type Declaration

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

      Map of slot keys to actual asset content. Legacy named-format path: each key matches an asset_id from the format's assets array (e.g., 'banner_image', 'clickthrough_url', 'video_file', 'vast_tag'). 3.1+ canonical-format path: each key matches an asset_group_id from the format's slots declaration drawn from the canonical vocabulary registry (e.g., 'images_landscape', 'video', 'published_post', 'landing_page_url', 'vast_tag', 'script', 'creative_brief'). Either path produces the same envelope shape; only the slot-key vocabulary differs.

      Each slot value is either a single asset object (most slots — image, video, published_post, vast_tag, landing_page_url, etc.) or an array of asset objects (slots with min/max counts on the format declaration — cards on image_carousel, headlines / descriptions / images_landscape on responsive_creative, etc.). Single-vs-array shape is governed by the format's slots[].min and slots[].max parameters: when max > 1 (or when the slot is conceptually a pool), the value MUST be an array; when the slot is single-valued, the value MUST be a single object. Each asset value (single or array element) carries an asset_type discriminator (image, video, audio, vast, daast, text, markdown, url, html, css, webhook, javascript, brief, catalog, published_post, zip, card) that selects the matching asset schema. Validators with OpenAPI-style discriminator support use asset_type to report errors against only the selected branch instead of all branches.

    • Optionalbrand?: BrandReference
    • Optionalrights?: RightsConstraint[]

      Rights constraints attached to this creative. Each entry represents constraints from a single rights holder. A creative may combine multiple rights constraints (e.g., talent likeness + music license). For v1, rights constraints are informational metadata — the buyer/orchestrator manages creative lifecycle against these terms.

    • Optionalindustry_identifiers?: IndustryIdentifier[]

      Industry-standard or market-specific identifiers for this specific manifest (e.g., Ad-ID, ISCI, Clearcast clock number, IDcrea). When present, overrides creative-level identifiers. Use when different format versions of the same source creative have distinct traffic identifiers (e.g., the :15 and :30 cuts, or separate TV and radio versions). Add a PR to extend creative-identifier-type when another shared identifier scheme needs first-class support.

    • Optionalprovenance?: Provenance
    • Optionalext?: ExtensionObject
    • LegacyManifestNamedFormatReference
    • ManifestCanonicalFormatKind