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

    Interface ClientProductPropertyPolicy

    interface ClientProductPropertyPolicy {
        mode?: ProductPropertyPolicyMode;
        enforceRequestPropertyList?: boolean;
        propertyListResolveOptions?: ResolveListOptions;
        message?: string;
        allowedDomains?: readonly string[];
        allowedPropertyIdentifiers?: readonly ProductPropertyPolicyIdentifier[];
        requireAllowedPropertyMatch?: boolean;
        excludedDomains?: readonly string[];
        excludedPropertyIds?: readonly string[];
        strict?: boolean;
        unknownSelectorBehavior?: ProductPropertyPolicySelectorBehavior;
        missingPublisherPropertiesBehavior?: ProductPropertyPolicySelectorBehavior;
    }

    Hierarchy (View Summary)

    Index

    Properties

    mode? enforceRequestPropertyList? propertyListResolveOptions? message? allowedDomains? allowedPropertyIdentifiers? requireAllowedPropertyMatch? excludedDomains? excludedPropertyIds? strict? unknownSelectorBehavior? missingPublisherPropertiesBehavior?

    Properties

    mode?: ProductPropertyPolicyMode

    Enforcement mode for completed get_products responses.

    • filter (default): remove rejected products before handlers/callers see them
    • reject_response: fail the task when any product violates the policy
    • audit: keep products but attach diagnostics
    enforceRequestPropertyList?: boolean

    When true, a get_products request carrying property_list is resolved and used as an allow-list for the returned products. Defaults to true.

    propertyListResolveOptions?: ResolveListOptions

    Resolver options for request-derived property-list validation. The default uses the SDK's process-local resolved-list cache.

    message?: string

    Message surfaced in debug logs and failed results when the policy rejects products.

    'Property list not adhered to'
    allowedDomains?: readonly string[]

    Domains the buyer will accept in returned products.

    allowedPropertyIdentifiers?: readonly ProductPropertyPolicyIdentifier[]

    Resolved property-list identifiers the buyer will accept in returned products. Domain identifiers are matched with AdCP property-list domain semantics (example.com matches www.example.com and m.example.com; *.example.com matches subdomains only).

    requireAllowedPropertyMatch?: boolean

    Require products to match the allowed domain/identifier set even when that set is empty. Used when a request property_list resolves successfully to zero identifiers; the safe interpretation is that no properties are eligible.

    excludedDomains?: readonly string[]

    Domains the buyer will not accept in returned products.

    excludedPropertyIds?: readonly string[]

    Publisher-scoped property IDs the buyer will not accept in returned products.

    strict?: boolean

    Shorthand for strict brand-safety evaluation. Defaults unresolved tag selectors and missing publisher_properties to rejection unless the more specific behavior fields override it.

    unknownSelectorBehavior?: ProductPropertyPolicySelectorBehavior

    How to handle selectors the SDK cannot confidently evaluate, such as selection_type: "by_tag" without resolved property metadata.

    Default: reject when strict is true, otherwise flag.

    missingPublisherPropertiesBehavior?: ProductPropertyPolicySelectorBehavior

    How to handle products that omit publisher_properties.

    Default: reject when strict is true, otherwise allow.

    Settings

    Member Visibility

    On This Page

    Properties