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

    Interface GetAdCPCapabilitiesResponse

    Standardized advertising media channels describing how buyers allocate budget. Channels are planning abstractions, not technical substrates. See the Media Channel Taxonomy specification for detailed definitions.

    interface GetAdCPCapabilitiesResponse {
        adcp: { major_versions: number[] };
        supported_protocols: (
            | "signals"
            | "governance"
            | "creative"
            | "media_buy"
            | "sponsored_intelligence"
        )[];
        media_buy?: {
            features?: MediaBuyFeatures;
            execution?: {
                axe_integrations?: string[];
                creative_specs?: {
                    vast_versions?: string[];
                    mraid_versions?: string[];
                    vpaid?: boolean;
                    simid?: boolean;
                };
                targeting?: {
                    geo_countries?: boolean;
                    geo_regions?: boolean;
                    geo_metros?: {
                        nielsen_dma?: boolean;
                        uk_itl1?: boolean;
                        uk_itl2?: boolean;
                        eurostat_nuts2?: boolean;
                    };
                    geo_postal_areas?: {
                        us_zip?: boolean;
                        us_zip_plus_four?: boolean;
                        gb_outward?: boolean;
                        gb_full?: boolean;
                        ca_fsa?: boolean;
                        ca_full?: boolean;
                        de_plz?: boolean;
                        fr_code_postal?: boolean;
                        au_postcode?: boolean;
                    };
                };
            };
            portfolio?: {
                publisher_domains: string[];
                primary_channels?: MediaChannel[];
                primary_countries?: string[];
                description?: string;
                advertising_policies?: string;
            };
        };
        signals?: { features?: { [k: string]: undefined
        | boolean } };
        governance?: {
            property_features?: {
                feature_id: string;
                type: "binary" | "quantitative" | "categorical";
                range?: { min: number; max: number };
                categories?: string[];
                description?: string;
                methodology_url?: string;
            }[];
        };
        sponsored_intelligence?: {
            endpoint: {
                transports: { type: "mcp"
                | "a2a"; url: string }[];
                preferred?: "mcp" | "a2a";
            };
            capabilities: SICapabilities;
            brand_manifest_url?: string;
        };
        extensions_supported?: string[];
        last_updated?: string;
        errors?: Error[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp: { major_versions: number[] }

    Core AdCP protocol information

    Type Declaration

    • major_versions: number[]

      AdCP major versions supported by this seller. Major versions indicate breaking changes.

    supported_protocols: (
        | "signals"
        | "governance"
        | "creative"
        | "media_buy"
        | "sponsored_intelligence"
    )[]

    Which AdCP domain protocols this seller supports

    media_buy?: {
        features?: MediaBuyFeatures;
        execution?: {
            axe_integrations?: string[];
            creative_specs?: {
                vast_versions?: string[];
                mraid_versions?: string[];
                vpaid?: boolean;
                simid?: boolean;
            };
            targeting?: {
                geo_countries?: boolean;
                geo_regions?: boolean;
                geo_metros?: {
                    nielsen_dma?: boolean;
                    uk_itl1?: boolean;
                    uk_itl2?: boolean;
                    eurostat_nuts2?: boolean;
                };
                geo_postal_areas?: {
                    us_zip?: boolean;
                    us_zip_plus_four?: boolean;
                    gb_outward?: boolean;
                    gb_full?: boolean;
                    ca_fsa?: boolean;
                    ca_full?: boolean;
                    de_plz?: boolean;
                    fr_code_postal?: boolean;
                    au_postcode?: boolean;
                };
            };
        };
        portfolio?: {
            publisher_domains: string[];
            primary_channels?: MediaChannel[];
            primary_countries?: string[];
            description?: string;
            advertising_policies?: string;
        };
    }

    Media-buy protocol capabilities. Only present if media_buy is in supported_protocols.

    Type Declaration

    • Optionalfeatures?: MediaBuyFeatures
    • Optionalexecution?: {
          axe_integrations?: string[];
          creative_specs?: {
              vast_versions?: string[];
              mraid_versions?: string[];
              vpaid?: boolean;
              simid?: boolean;
          };
          targeting?: {
              geo_countries?: boolean;
              geo_regions?: boolean;
              geo_metros?: {
                  nielsen_dma?: boolean;
                  uk_itl1?: boolean;
                  uk_itl2?: boolean;
                  eurostat_nuts2?: boolean;
              };
              geo_postal_areas?: {
                  us_zip?: boolean;
                  us_zip_plus_four?: boolean;
                  gb_outward?: boolean;
                  gb_full?: boolean;
                  ca_fsa?: boolean;
                  ca_full?: boolean;
                  de_plz?: boolean;
                  fr_code_postal?: boolean;
                  au_postcode?: boolean;
              };
          };
      }

      Technical execution capabilities for media buying

      • Optionalaxe_integrations?: string[]

        Agentic ad exchange (AXE) integrations supported. URLs are canonical identifiers for exchanges this seller can execute through.

      • Optionalcreative_specs?: {
            vast_versions?: string[];
            mraid_versions?: string[];
            vpaid?: boolean;
            simid?: boolean;
        }

        Creative specification support

        • Optionalvast_versions?: string[]

          VAST versions supported for video creatives

        • Optionalmraid_versions?: string[]

          MRAID versions supported for rich media mobile creatives

        • Optionalvpaid?: boolean

          VPAID support for interactive video ads

        • Optionalsimid?: boolean

          SIMID support for interactive video ads

      • Optionaltargeting?: {
            geo_countries?: boolean;
            geo_regions?: boolean;
            geo_metros?: {
                nielsen_dma?: boolean;
                uk_itl1?: boolean;
                uk_itl2?: boolean;
                eurostat_nuts2?: boolean;
            };
            geo_postal_areas?: {
                us_zip?: boolean;
                us_zip_plus_four?: boolean;
                gb_outward?: boolean;
                gb_full?: boolean;
                ca_fsa?: boolean;
                ca_full?: boolean;
                de_plz?: boolean;
                fr_code_postal?: boolean;
                au_postcode?: boolean;
            };
        }

        Targeting capabilities. If declared true/supported, buyer can use these targeting parameters and seller MUST honor them.

        • Optionalgeo_countries?: boolean

          Supports country-level geo targeting using ISO 3166-1 alpha-2 codes (e.g., 'US', 'GB', 'DE')

        • Optionalgeo_regions?: boolean

          Supports region/state-level geo targeting using ISO 3166-2 subdivision codes (e.g., 'US-NY', 'GB-SCT', 'DE-BY')

        • Optionalgeo_metros?: {
              nielsen_dma?: boolean;
              uk_itl1?: boolean;
              uk_itl2?: boolean;
              eurostat_nuts2?: boolean;
          }

          Metro area targeting support. Specifies which classification systems are supported.

          • Optionalnielsen_dma?: boolean

            Supports Nielsen DMA codes (US market, e.g., '501' for NYC)

          • Optionaluk_itl1?: boolean

            Supports UK ITL Level 1 regions

          • Optionaluk_itl2?: boolean

            Supports UK ITL Level 2 regions

          • Optionaleurostat_nuts2?: boolean

            Supports Eurostat NUTS Level 2 regions (EU)

        • Optionalgeo_postal_areas?: {
              us_zip?: boolean;
              us_zip_plus_four?: boolean;
              gb_outward?: boolean;
              gb_full?: boolean;
              ca_fsa?: boolean;
              ca_full?: boolean;
              de_plz?: boolean;
              fr_code_postal?: boolean;
              au_postcode?: boolean;
          }

          Postal area targeting support. Specifies which postal code systems are supported. System names encode country and precision.

          • Optionalus_zip?: boolean

            US 5-digit ZIP codes (e.g., '10001')

          • Optionalus_zip_plus_four?: boolean

            US 9-digit ZIP+4 codes (e.g., '10001-1234')

          • Optionalgb_outward?: boolean

            UK postcode district / outward code (e.g., 'SW1', 'EC1')

          • Optionalgb_full?: boolean

            UK full postcode (e.g., 'SW1A 1AA')

          • Optionalca_fsa?: boolean

            Canadian Forward Sortation Area (e.g., 'K1A')

          • Optionalca_full?: boolean

            Canadian full postal code (e.g., 'K1A 0B1')

          • Optionalde_plz?: boolean

            German Postleitzahl, 5 digits (e.g., '10115')

          • Optionalfr_code_postal?: boolean

            French code postal, 5 digits (e.g., '75001')

          • Optionalau_postcode?: boolean

            Australian postcode, 4 digits (e.g., '2000')

    • Optionalportfolio?: {
          publisher_domains: string[];
          primary_channels?: MediaChannel[];
          primary_countries?: string[];
          description?: string;
          advertising_policies?: string;
      }

      Information about the seller's media inventory portfolio

      • publisher_domains: string[]

        Publisher domains this seller is authorized to represent. Buyers should fetch each publisher's adagents.json for property definitions.

      • Optionalprimary_channels?: MediaChannel[]

        Primary advertising channels in this portfolio

      • Optionalprimary_countries?: string[]

        Primary countries (ISO 3166-1 alpha-2) where inventory is concentrated

      • Optionaldescription?: string

        Markdown-formatted description of the inventory portfolio

      • Optionaladvertising_policies?: string

        Advertising content policies, restrictions, and guidelines

    signals?: { features?: { [k: string]: undefined | boolean } }

    Signals protocol capabilities. Only present if signals is in supported_protocols. Reserved for future use.

    Type Declaration

    • Optionalfeatures?: { [k: string]: undefined | boolean }

      Optional signals features supported

    governance?: {
        property_features?: {
            feature_id: string;
            type: "binary" | "quantitative" | "categorical";
            range?: { min: number; max: number };
            categories?: string[];
            description?: string;
            methodology_url?: string;
        }[];
    }

    Governance protocol capabilities. Only present if governance is in supported_protocols. Governance agents provide property data like compliance scores, brand safety ratings, and sustainability metrics.

    Type Declaration

    • Optionalproperty_features?: {
          feature_id: string;
          type: "binary" | "quantitative" | "categorical";
          range?: { min: number; max: number };
          categories?: string[];
          description?: string;
          methodology_url?: string;
      }[]

      Property features this governance agent can evaluate. Each feature describes a score, rating, or certification the agent can provide for properties.

    sponsored_intelligence?: {
        endpoint: {
            transports: { type: "mcp" | "a2a"; url: string }[];
            preferred?: "mcp" | "a2a";
        };
        capabilities: SICapabilities;
        brand_manifest_url?: string;
    }

    Sponsored Intelligence protocol capabilities. Only present if sponsored_intelligence is in supported_protocols. SI agents handle conversational brand experiences.

    Type Declaration

    • endpoint: {
          transports: { type: "mcp" | "a2a"; url: string }[];
          preferred?: "mcp" | "a2a";
      }

      SI agent endpoint configuration

      • transports: { type: "mcp" | "a2a"; url: string }[]

        Available protocol transports. Hosts select based on their capabilities.

      • Optionalpreferred?: "mcp" | "a2a"

        Preferred transport when host supports multiple

    • capabilities: SICapabilities
    • Optionalbrand_manifest_url?: string

      URL to brand manifest with colors, fonts, logos, tone

    extensions_supported?: string[]

    Extension namespaces this agent supports. Buyers can expect meaningful data in ext.{namespace} fields on responses from this agent. Extension schemas are published in the AdCP extension registry.

    last_updated?: string

    ISO 8601 timestamp of when capabilities were last updated. Buyers can use this for cache invalidation.

    errors?: Error[]

    Task-specific errors and warnings

    context?: ContextObject
    ext?: ExtensionObject