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

    Interface AdAgentsJson

    adagents.json structure

    interface AdAgentsJson {
        $schema?: string;
        authoritative_location?: string;
        authorized_agents?: AuthorizedAgent[];
        properties?: Property[];
        formats?: AdAgentsPublisherFormat[];
        revoked_publisher_domains?: RevokedPublisherDomain[];
        last_updated?: string;
    }
    Index

    Properties

    $schema? authoritative_location? authorized_agents? properties? formats? revoked_publisher_domains? last_updated?

    Properties

    $schema?: string
    authoritative_location?: string

    URL pointing to the authoritative adagents.json file. When present, the client should fetch from this URL instead. Used by publishers who centralize their authorization files.

    authorized_agents?: AuthorizedAgent[]
    properties?: Property[]
    formats?: AdAgentsPublisherFormat[]

    Publisher-published format catalog (AdCP 3.1). Each entry declares a v2 ProductFormatDeclaration (or v1 named-format ref) the publisher's inventory accepts, optionally scoped to specific properties via applies_to_property_ids / applies_to_property_tags. Consumed by src/lib/v2/publisher-catalog/ for property-scoped lookup + format_option_id resolution from placement.format_options[]. Optional; absent on 3.0.x adagents.json files.

    revoked_publisher_domains?: RevokedPublisherDomain[]

    Publisher domains whose inline properties[] entries on THIS file are revoked — even if a matching entry is still present. Honored by inline publisher_properties resolution: a selector targeting a revoked domain resolves to zero properties, and the SDK MUST NOT fall through to a federated fetch for that domain.

    Per adcontextprotocol/adcp#4825 + PR #4827, both parent and child adagents.json files MAY carry this field; first match revokes. resolveInlinePublisherProperties consults the parent's list (the file passed in). Child-file revocation is the federated fetcher's responsibility — see fetchAgentAuthorizationsFromDirectory (#1885 part 2) and the SDK's property-crawler for the consumer-side cross-check.

    last_updated?: string

    Settings

    Member Visibility

    On This Page

    Properties