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

    Interface IPropertyListAdapter

    Abstract interface for property list adapters. Publishers implement this to provide their storage and resolution logic.

    interface IPropertyListAdapter {
        isSupported(): boolean;
        createList(
            request: CreatePropertyListRequest,
        ): Promise<CreatePropertyListResponse>;
        updateList(
            request: UpdatePropertyListRequest,
        ): Promise<UpdatePropertyListResponse>;
        getList(request: GetPropertyListRequest): Promise<GetPropertyListResponse>;
        listLists(
            request: ListPropertyListsRequest,
        ): Promise<ListPropertyListsResponse>;
        deleteList(
            request: DeletePropertyListRequest,
        ): Promise<DeletePropertyListResponse>;
        isPropertyInList(
            listId: string,
            identifierType: string,
            identifierValue: string,
        ): Promise<boolean>;
        resolveList(
            listId: string,
            maxResults?: number,
            cursor?: string,
        ): Promise<ResolvedProperty[]>;
    }

    Implemented by

    Index

    Methods

    isSupported createList updateList getList listLists deleteList isPropertyInList resolveList

    Methods

    • Check if a property identifier is in a property list. Used by get_products and create_media_buy for filtering.

      Parameters

      • listId: string
      • identifierType: string
      • identifierValue: string

      Returns Promise<boolean>

    • Resolve a property list to its constituent identifiers. Applies filters and returns matching properties.

      Parameters

      • listId: string
      • OptionalmaxResults: number
      • Optionalcursor: string

      Returns Promise<ResolvedProperty[]>

    Settings

    Member Visibility

    On This Page

    Methods