v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
firstPartyAndPartnerAudiences

Lists first party and partner audiences. The order is defined by the order_by parameter.

get/v4/firstPartyAndPartnerAudiences

Query parameters

advertiserIdstring

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

filterstring

Optional. Allows filtering by first party and partner audience fields. Supported syntax: * Filter expressions for first party and partner 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 party and partner 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.

orderBystring

Optional. Field by which to sort the list. Acceptable values are: * FirstPartyAndPartnerAudienceId (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.

pageSizeinteger

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

pageTokenstring

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

partnerIdstring

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

Response

Successful response