Method: customLists.list

    • Display & Video 360 API v1 has been sunset.

    • This document provides information on how to list custom lists using the DV360 API.

    • Custom lists can be filtered, sorted, and paginated using query parameters.

    • The response body contains a list of custom lists and a token for the next page of results.

    • Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

    Lists custom lists.

    The order is defined by the orderBy parameter.

    HTTP request

    GET https://displayvideo.googleapis.com/v1/customLists

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    pageSize

    integer

    Requested page size. Must be between 1 and 200 . If unspecified will default to 100 . Returns error code INVALID_ARGUMENT if an invalid value is specified.

    pageToken

    string

    A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to customLists.list method. If not specified, the first page of results will be returned.

    orderBy

    string

    Field by which to sort the list. Acceptable values are:

    • customListId (default)
    • displayName

    The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: displayName desc .

    filter

    string

    Allows filtering by custom list fields.

    Supported syntax:

    • Filter expressions for custom lists can only contain at most one restriction.
    • A restriction has the form of {field} {operator} {value} .
    • All fields must use the HAS (:) operator.

    Supported fields:

    • displayName

    Examples:

    • All custom lists for which the display name contains "Google": displayName:"Google" .

    The length of this field should be no more than 500 characters.

    Reference our filter LIST requests guide for more information.

    advertiserId

    string ( int64 format)

    The ID of the DV360 advertiser that has access to the fetched custom lists.

    Request body

    The request body must be empty.

    Response body

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "customLists" 
 : 
 [ 
 { 
 object (  CustomList 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    customLists[]

    object ( CustomList )

    The list of custom lists.

    This list will be absent if empty.
    nextPageToken

    string

    A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to customLists.list method to retrieve the next page of results.

    Authorization Scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/display-video

    For more information, see the OAuth 2.0 Overview .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: