Method: customLists.list

  • Display & Video 360 API v3 has sunset and users should use v4 instead.

  • This page describes how to list custom lists using the v3 API via an HTTP GET request.

  • The request allows for query parameters to control pagination, sorting, and filtering of results.

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

  • The request requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Lists custom lists.

The order is defined by the orderBy parameter.

HTTP request

GET https://displayvideo.googleapis.com/v3/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.
Union parameter accessor. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return custom list entities that are accessible to the DV360 entity identified within the accessor. accessor can be only one of the following:
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.