v1

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

Retrieves first and third party user lists available for forecasting.

get/v4/advertisers/{+advertiserId}/reachForecast:retrievePlannableUserLists

Path parameters

advertiserIdstring required

Required. The ID of the advertiser to retrieve plannable user lists for.

Query parameters

filterstring

Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by AND or OR logical operators. * A restriction has the form of {field} {operator} {value}. * The displayName field must use the HAS (:) operator. * All other fields must use the EQUALS (=) operator. Supported fields: * plannableStatus * displayName * userListType * name Examples: * All plannable user lists: plannableStatus="PLANNABLE" * Plannable user lists with display name containing "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping" * First party user lists: userListType="FIRST_PARTY" The length of this field should be no more than 500 characters. Reference our filter LIST requests guide for more information.

pageSizeinteger

Optional. Requested page size. Must be between 1 and 5000. If unspecified will default to 5000.

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 RetrievePlannableUserLists method. If not specified, the first page of results will be returned.

Response

Successful response