Method: combinedAudiences.list

Lists combined audiences.

The order is defined by the orderBy parameter.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. 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 combinedAudiences.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:

  • combinedAudienceId (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 combined audience fields.

Supported syntax:

  • Filter expressions for combined audiences currently can only contain at most one restriction.
  • A restriction has the form of {field} {operator} {value}.
  • The operator must be CONTAINS (:).
  • Supported fields:
    • displayName

Examples:

  • All combined audiences for which the display name contains "Google": displayName : "Google".

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

Union parameter accessor. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return combined audience entities that are accessible to the DV360 entity identified within the accessor. accessor can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that has access to the fetched combined audiences.

advertiserId

string (int64 format)

The ID of the advertiser that has access to the fetched combined audiences.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "combinedAudiences": [
    {
      object (CombinedAudience)
    }
  ],
  "nextPageToken": string
}
Fields
combinedAudiences[]

object (CombinedAudience)

The list of combined audiences.

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 combinedAudiences.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.