Method: firstAndThirdPartyAudiences.list

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

    • The content describes how to list first and third party audiences using an HTTP GET request.

    • The request allows for filtering, sorting, and pagination of the results.

    • The response body will contain a list of first and third party audiences and a token for the next page.

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

    Lists first and third party audiences.

    The order is defined by the orderBy parameter.

    HTTP request

    GET https://displayvideo.googleapis.com/v3/firstAndThirdPartyAudiences

    The URL uses gRPC Transcoding syntax.

    Query parameters

    Parameters
    pageSize

    integer

    Requested page size. Must be between 1 and 5000 . If unspecified, this value defaults to 5000 . 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 firstAndThirdPartyAudiences.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:

    • firstAndThirdPartyAudienceId (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 first and third party audience fields.

    Supported syntax:

    • Filter expressions for first and third party audiences 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 first and third party audiences 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 first and third party 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 first and third party audiences.

    advertiserId

    string ( int64 format)

    The ID of the advertiser that has access to the fetched first and third party audiences.

    Request body

    The request body must be empty.

    Response body

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

    JSON representation 
     { 
 "firstAndThirdPartyAudiences" 
 : 
 [ 
 { 
 object (  FirstAndThirdPartyAudience 
 
) 
 } 
 ] 
 , 
 "nextPageToken" 
 : 
 string 
 }
    Fields
    firstAndThirdPartyAudiences[]

    object ( FirstAndThirdPartyAudience )

    The list of first and third party audiences. Audience size properties will not be included.

    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 firstAndThirdPartyAudiences.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 .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: