AI-generated Key Takeaways
-
Lists Google audiences accessible to a specified DV360 partner or advertiser, ordered by
googleAudienceId
ordisplayName
. -
Allows filtering by
displayName
using theHAS (:)
operator and pagination usingpageSize
andpageToken
parameters. -
The response includes a list of Google audiences and a token for retrieving subsequent pages if available.
-
Requires authorization with the
https://www.googleapis.com/auth/display-video
scope.
Lists Google audiences.
The order is defined by the orderBy
parameter.
HTTP request
GET https://displayvideo.googleapis.com/v3/googleAudiences
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters | |
---|---|
pageSize |
Requested page size. Must be between |
pageToken |
A token identifying a page of results the server should return. Typically, this is the value of |
orderBy |
Field by which to sort the list. Acceptable values are:
The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: |
filter |
Allows filtering by Google audience fields. Supported syntax:
Supported fields:
Examples:
The length of this field should be no more than 500 characters. Reference our filter |
Union parameter accessor . Required. Identifies which DV360 entity the request is being made within. The LIST request will only return Google audience entities that are accessible to the DV360 entity identified within the accessor . accessor can be only one of the following: |
|
partnerId |
The ID of the partner that has access to the fetched Google audiences. |
advertiserId |
The ID of the advertiser that has access to the fetched Google audiences. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"googleAudiences": [
{
object ( |
Fields | |
---|---|
googleAudiences[] |
The list of Google audiences. This list will be absent if empty. |
nextPageToken |
A token to retrieve the next page of results. Pass this value in the |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/display-video
For more information, see the OAuth 2.0 Overview.