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

    Interface GetPropertyListResponse

    A source of properties for a property list. Supports three selection patterns: publisher with tags, publisher with property IDs, or direct identifiers.

    interface GetPropertyListResponse {
        list: PropertyList;
        identifiers?: Identifier[];
        total_count?: number;
        returned_count?: number;
        pagination?: { has_more?: boolean; cursor?: string };
        resolved_at?: string;
        cache_valid_until?: string;
        coverage_gaps?: { [k: string]: undefined | Identifier[] };
        ext?: ExtensionObject;
    }
    Index

    Properties

    list identifiers? total_count? returned_count? pagination? resolved_at? cache_valid_until? coverage_gaps? ext?

    Properties

    list: PropertyList
    identifiers?: Identifier[]

    Resolved identifiers that passed filters (if resolve=true). Cache these locally for real-time use.

    total_count?: number

    Total number of identifiers in resolved list

    returned_count?: number

    Number of identifiers returned in this response

    pagination?: { has_more?: boolean; cursor?: string }

    Pagination information

    Type Declaration

    • Optionalhas_more?: boolean

      Whether more results are available

    • Optionalcursor?: string

      Cursor for next page

    resolved_at?: string

    When the list was resolved

    cache_valid_until?: string

    Cache expiration timestamp. Re-fetch the list after this time to get updated identifiers.

    coverage_gaps?: { [k: string]: undefined | Identifier[] }

    Properties included in the list despite missing feature data. Only present when a feature_requirement has if_not_covered='include'. Maps feature_id to list of identifiers not covered for that feature.

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties