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

    Interface SupplyPathInput

    interface SupplyPathInput {
        ownerDomain: string;
        hostDomain: string;
        agentUrl: string;
        collectionId?: string;
        requiredHostPropertyIds?: string[];
        requireExplicitHostPublisherDomain?: boolean;
        requireExplicitOwnerPublisherDomain?: boolean;
        ownerManifest: SupplyPathManifest | null;
        hostManifest: SupplyPathManifest | null;
        hostInventoryPartnerDomains: string[] | null;
        hostInventoryPartnerDomainsByFile?: Partial<
            Record<"ads.txt" | "app-ads.txt", string[] | null>,
        >;
        heldRevocations?: { owner?: string[]; host?: string[] };
        inventoryPartnerDomainEvaluated?: boolean;
    }
    Index
    ownerDomain hostDomain agentUrl collectionId? requiredHostPropertyIds? requireExplicitHostPublisherDomain? requireExplicitOwnerPublisherDomain? ownerManifest hostManifest hostInventoryPartnerDomains hostInventoryPartnerDomainsByFile? heldRevocations? inventoryPartnerDomainEvaluated?
    ownerDomain: string

    Canonicalized owner (channel publisher) domain.

    hostDomain: string

    Canonicalized host (carrying property publisher) domain.

    agentUrl: string

    Seller agent URL as the buyer sees it.

    collectionId?: string

    Owner-assigned collection ID. Omit to verify the path at domain level (bulk deals).

    requiredHostPropertyIds?: string[]

    Optional concrete product scope, resolved from the host manifest. Empty means unresolved.

    requireExplicitHostPublisherDomain?: boolean

    Cross-origin authoritative documents must explicitly attribute every host property.

    requireExplicitOwnerPublisherDomain?: boolean

    Cross-origin owner catalogs must explicitly attribute collections and owner agent grants.

    ownerManifest: SupplyPathManifest | null
    hostManifest: SupplyPathManifest | null
    hostInventoryPartnerDomains: string[] | null

    inventorypartnerdomain values from the host's ads.txt/app-ads.txt, already canonicalized. null = the files could not be fetched (distinct from fetched-and-absent, which is an empty array).

    hostInventoryPartnerDomainsByFile?: Partial<
        Record<"ads.txt" | "app-ads.txt", string[] | null>,
    >

    Per-file parsed evidence, so bulk inquiries evaluate each collection's applicable surfaces independently.

    heldRevocations?: { owner?: string[]; host?: string[] }

    Previously observed authority-scoped revocations, even when a current manifest is unavailable.

    inventoryPartnerDomainEvaluated?: boolean

    False when the caller deliberately skipped IAB evidence after host authorization succeeded.

    Settings
    Member Visibility

    On This Page
    Properties