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

    Interface Product

    Represents available advertising inventory

    interface Product {
        product_id: string;
        name: string;
        description: string;
        publisher_properties: [
            PublisherPropertySelector,
            ...PublisherPropertySelector[],
        ];
        format_ids: FormatID[];
        placements?: [Placement, ...Placement[]];
        delivery_type: DeliveryType;
        pricing_options: [PricingOption, ...PricingOption[]];
        estimated_exposures?: number;
        measurement?: Measurement;
        delivery_measurement: { provider: string; notes?: string };
        reporting_capabilities?: ReportingCapabilities;
        creative_policy?: CreativePolicy;
        is_custom?: boolean;
        brief_relevance?: string;
        expires_at?: string;
        product_card?: { format_id: FormatID1; manifest: { [k: string]: unknown } };
        product_card_detailed?: {
            format_id: FormatID2;
            manifest: { [k: string]: unknown };
        };
        ext?: ExtensionObject;
    }
    Index

    Properties

    product_id name description publisher_properties format_ids placements? delivery_type pricing_options estimated_exposures? measurement? delivery_measurement reporting_capabilities? creative_policy? is_custom? brief_relevance? expires_at? product_card? product_card_detailed? ext?

    Properties

    product_id: string

    Unique identifier for the product

    name: string

    Human-readable product name

    description: string

    Detailed description of the product and its inventory

    publisher_properties: [
        PublisherPropertySelector,
        ...PublisherPropertySelector[],
    ]

    Publisher properties covered by this product. Buyers fetch actual property definitions from each publisher's adagents.json and validate agent authorization. Selection patterns mirror the authorization patterns in adagents.json for consistency.

    1

    format_ids: FormatID[]

    Array of supported creative format IDs - structured format_id objects with agent_url and id

    placements?: [Placement, ...Placement[]]

    Optional array of specific placements within this product. When provided, buyers can target specific placements when assigning creatives.

    1

    delivery_type: DeliveryType
    pricing_options: [PricingOption, ...PricingOption[]]

    Available pricing models for this product

    1

    estimated_exposures?: number

    Estimated exposures/impressions for guaranteed products

    measurement?: Measurement
    delivery_measurement: { provider: string; notes?: string }

    Measurement provider and methodology for delivery metrics. The buyer accepts the declared provider as the source of truth for the buy. REQUIRED for all products.

    Type Declaration

    • provider: string

      Measurement provider(s) used for this product (e.g., 'Google Ad Manager with IAS viewability', 'Nielsen DAR', 'Geopath for DOOH impressions')

    • Optionalnotes?: string

      Additional details about measurement methodology in plain language (e.g., 'MRC-accredited viewability. 50% in-view for 1s display / 2s video', 'Panel-based demographic measurement updated monthly')

    reporting_capabilities?: ReportingCapabilities
    creative_policy?: CreativePolicy
    is_custom?: boolean

    Whether this is a custom product

    brief_relevance?: string

    Explanation of why this product matches the brief (only included when brief is provided)

    expires_at?: string

    Expiration timestamp for custom products

    product_card?: { format_id: FormatID1; manifest: { [k: string]: unknown } }

    Optional standard visual card (300x400px) for displaying this product in user interfaces. Can be rendered via preview_creative or pre-generated.

    Type Declaration

    • format_id: FormatID1
    • manifest: { [k: string]: unknown }

      Asset manifest for rendering the card, structure defined by the format

    product_card_detailed?: {
        format_id: FormatID2;
        manifest: { [k: string]: unknown };
    }

    Optional detailed card with carousel and full specifications. Provides rich product presentation similar to media kit pages.

    Type Declaration

    • format_id: FormatID2
    • manifest: { [k: string]: unknown }

      Asset manifest for rendering the detailed card, structure defined by the format

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties