@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface RegistrySupplyPathResult

    Canonical registry request; collection_id omission is a domain-level inquiry.

    interface RegistrySupplyPathResult {
        semantics_version: "1";
        resolved_collection_id?: string;
        state: SupplyPathState;
        owner_domain: string;
        host_domain: string;
        agent_url: string;
        collection_id?: string;
        legs: {
            owner_collection_declared: Omit<Leg<OwnerCollectionFailure>, "failure"> & {
                failure?: string;
            };
            owner_distribution_carriage: Omit<
                Leg<OwnerCarriageFailure> & {
                    property_ids_matched?: string[];
                    property_ids_unmatched?: string[];
                },
                "failure",
            > & { failure?: string };
            owner_agent_declared: Omit<Leg<OwnerAgentFailure>, "failure"> & {
                failure?: string;
            };
            host_authorization: Omit<
                Leg<HostAuthorizationFailure> & {
                    matched_entry?: {
                        url: string;
                        authorization_type?: string;
                        delegation_type?: string;
                        collections?: {
                            publisher_domain: string;
                            collection_ids?: (...) | (...);
                        }[];
                    };
                },
                "failure",
            > & { failure?: string };
            inventory_partner_domain: Omit<
                Leg<"not_declared" | "ads_txt_unavailable" | "not_evaluated">,
                "failure",
            > & { failure?: string };
        };
        sources: {
            owner_adagents_url: string;
            host_adagents_url: string;
            cached: boolean;
            owner_fetched_at: string
            | null;
            host_fetched_at: string | null;
            owner_resolved_url: string | null;
            host_resolved_url: string | null;
        };
        checked_at: string;
    }

    Hierarchy (View Summary)

    Index
    semantics_version resolved_collection_id? state owner_domain host_domain agent_url collection_id? legs sources checked_at
    semantics_version: "1"

    Version of the canonical evaluator semantics and shared vector corpus.

    resolved_collection_id?: string

    Concrete winning collection, including domain-level inquiries.

    state: SupplyPathState
    owner_domain: string
    host_domain: string
    agent_url: string
    collection_id?: string
    legs: {
        owner_collection_declared: Omit<Leg<OwnerCollectionFailure>, "failure"> & {
            failure?: string;
        };
        owner_distribution_carriage: Omit<
            Leg<OwnerCarriageFailure> & {
                property_ids_matched?: string[];
                property_ids_unmatched?: string[];
            },
            "failure",
        > & { failure?: string };
        owner_agent_declared: Omit<Leg<OwnerAgentFailure>, "failure"> & {
            failure?: string;
        };
        host_authorization: Omit<
            Leg<HostAuthorizationFailure> & {
                matched_entry?: {
                    url: string;
                    authorization_type?: string;
                    delegation_type?: string;
                    collections?: {
                        publisher_domain: string;
                        collection_ids?: (...) | (...);
                    }[];
                };
            },
            "failure",
        > & { failure?: string };
        inventory_partner_domain: Omit<
            Leg<"not_declared" | "ads_txt_unavailable" | "not_evaluated">,
            "failure",
        > & { failure?: string };
    }

    Type Declaration

    • owner_collection_declared: Omit<Leg<OwnerCollectionFailure>, "failure"> & { failure?: string }

      Owner's adagents.json declares the collection (kind noted in detail).

    • owner_distribution_carriage: Omit<
          Leg<OwnerCarriageFailure> & {
              property_ids_matched?: string[];
              property_ids_unmatched?: string[];
          },
          "failure",
      > & { failure?: string }

      The collection's distribution[] names the host, and any property_ids resolve in the host manifest.

    • owner_agent_declared: Omit<Leg<OwnerAgentFailure>, "failure"> & { failure?: string }

      Owner's own adagents.json lists the sales agent.

    • host_authorization: Omit<
          Leg<HostAuthorizationFailure> & {
              matched_entry?: {
                  url: string;
                  authorization_type?: string;
                  delegation_type?: string;
                  collections?: {
                      publisher_domain: string;
                      collection_ids?: (...) | (...);
                  }[];
              };
          },
          "failure",
      > & { failure?: string }

      Host adagents.json authorizes the agent for the property, collection-scoped.

    • inventory_partner_domain: Omit<Leg<"not_declared" | "ads_txt_unavailable" | "not_evaluated">, "failure"> & {
          failure?: string;
      }

      Host ads.txt / app-ads.txt names the owner via inventorypartnerdomain=.

    sources: {
        owner_adagents_url: string;
        host_adagents_url: string;
        cached: boolean;
        owner_fetched_at: string | null;
        host_fetched_at: string | null;
        owner_resolved_url: string | null;
        host_resolved_url: string | null;
    }

    Type Declaration

    • owner_adagents_url: string
    • host_adagents_url: string
    • cached: boolean
    • owner_fetched_at: string | null

      Cache observation times, distinct from the verdict's checked_at.

    • host_fetched_at: string | null
    • owner_resolved_url: string | null
    • host_resolved_url: string | null
    checked_at: string

    Settings
    Member Visibility

    On This Page
    Properties