@adcp/client API Reference - v3.3.3
    Preparing search index...

    Interface BrandManifest

    Inline brand manifest object

    interface BrandManifest {
        url?: string;
        name: string;
        logos?: { url: string; tags?: string[]; width?: number; height?: number }[];
        colors?: {
            primary?: string;
            secondary?: string;
            accent?: string;
            background?: string;
            text?: string;
        };
        fonts?: { primary?: string; secondary?: string; font_urls?: string[] };
        tone?: string;
        tagline?: string;
        assets?: {
            asset_id: string;
            asset_type: AssetContentType;
            url: string;
            tags?: string[];
            name?: string;
            description?: string;
            width?: number;
            height?: number;
            duration_seconds?: number;
            file_size_bytes?: number;
            format?: string;
            metadata?: { [k: string]: unknown };
        }[];
        product_catalog?: {
            feed_url: string;
            feed_format?: "google_merchant_center"
            | "facebook_catalog"
            | "custom";
            categories?: string[];
            last_updated?: string;
            update_frequency?: "realtime" | "hourly" | "daily" | "weekly";
        };
        disclaimers?: { text: string; context?: string; required?: boolean }[];
        industry?: string;
        target_audience?: string;
        contact?: { email?: string; phone?: string };
        metadata?: {
            created_date?: string;
            updated_date?: string;
            version?: string;
        };
    }
    Index

    Properties

    url?: string

    Primary brand URL for context and asset discovery. Creative agents can infer brand information from this URL.

    name: string

    Brand or business name

    logos?: { url: string; tags?: string[]; width?: number; height?: number }[]

    Brand logo assets with semantic tags for different use cases

    Type Declaration

    • url: string

      URL to the logo asset

    • Optionaltags?: string[]

      Semantic tags describing the logo variant (e.g., 'dark', 'light', 'square', 'horizontal', 'icon')

    • Optionalwidth?: number

      Logo width in pixels

    • Optionalheight?: number

      Logo height in pixels

    colors?: {
        primary?: string;
        secondary?: string;
        accent?: string;
        background?: string;
        text?: string;
    }

    Brand color palette

    Type Declaration

    • Optionalprimary?: string

      Primary brand color (hex format)

    • Optionalsecondary?: string

      Secondary brand color (hex format)

    • Optionalaccent?: string

      Accent color (hex format)

    • Optionalbackground?: string

      Background color (hex format)

    • Optionaltext?: string

      Text color (hex format)

    fonts?: { primary?: string; secondary?: string; font_urls?: string[] }

    Brand typography guidelines

    Type Declaration

    • Optionalprimary?: string

      Primary font family name

    • Optionalsecondary?: string

      Secondary font family name

    • Optionalfont_urls?: string[]

      URLs to web font files if using custom fonts

    tone?: string

    Brand voice and messaging tone (e.g., 'professional', 'casual', 'humorous', 'trustworthy', 'innovative')

    tagline?: string

    Brand tagline or slogan

    assets?: {
        asset_id: string;
        asset_type: AssetContentType;
        url: string;
        tags?: string[];
        name?: string;
        description?: string;
        width?: number;
        height?: number;
        duration_seconds?: number;
        file_size_bytes?: number;
        format?: string;
        metadata?: { [k: string]: unknown };
    }[]

    Brand asset library with explicit assets and tags. Assets are referenced inline with URLs pointing to CDN-hosted files.

    Type Declaration

    • asset_id: string

      Unique identifier for this asset

    • asset_type: AssetContentType
    • url: string

      URL to CDN-hosted asset file

    • Optionaltags?: string[]

      Tags for asset discovery (e.g., 'holiday', 'lifestyle', 'product_shot')

    • Optionalname?: string

      Human-readable asset name

    • Optionaldescription?: string

      Asset description or usage notes

    • Optionalwidth?: number

      Image/video width in pixels

    • Optionalheight?: number

      Image/video height in pixels

    • Optionalduration_seconds?: number

      Video/audio duration in seconds

    • Optionalfile_size_bytes?: number

      File size in bytes

    • Optionalformat?: string

      File format (e.g., 'jpg', 'mp4', 'mp3')

    • Optionalmetadata?: { [k: string]: unknown }

      Additional asset-specific metadata

    product_catalog?: {
        feed_url: string;
        feed_format?: "google_merchant_center" | "facebook_catalog" | "custom";
        categories?: string[];
        last_updated?: string;
        update_frequency?: "realtime" | "hourly" | "daily" | "weekly";
    }

    Product catalog information for e-commerce advertisers. Enables SKU-level creative generation and product selection.

    Type Declaration

    • feed_url: string

      URL to product catalog feed

    • Optionalfeed_format?: "google_merchant_center" | "facebook_catalog" | "custom"

      Format of the product feed

    • Optionalcategories?: string[]

      Product categories available in the catalog (for filtering)

    • Optionallast_updated?: string

      When the product catalog was last updated

    • Optionalupdate_frequency?: "realtime" | "hourly" | "daily" | "weekly"

      How frequently the product catalog is updated

    disclaimers?: { text: string; context?: string; required?: boolean }[]

    Legal disclaimers or required text that must appear in creatives

    Type Declaration

    • text: string

      Disclaimer text

    • Optionalcontext?: string

      When this disclaimer applies (e.g., 'financial_products', 'health_claims', 'all')

    • Optionalrequired?: boolean

      Whether this disclaimer must appear

    industry?: string

    Industry or vertical (e.g., 'retail', 'automotive', 'finance', 'healthcare')

    target_audience?: string

    Primary target audience description

    contact?: { email?: string; phone?: string }

    Brand contact information

    Type Declaration

    • Optionalemail?: string

      Contact email

    • Optionalphone?: string

      Contact phone number

    metadata?: { created_date?: string; updated_date?: string; version?: string }

    Additional brand metadata

    Type Declaration

    • Optionalcreated_date?: string

      When this brand manifest was created

    • Optionalupdated_date?: string

      When this brand manifest was last updated

    • Optionalversion?: string

      Brand card version number