Required. Parent customer resource name, e.g. 'customers/123'.
Query parameters
Parameters
pageSize
integer
Maximum number of items to return. If 0, the server will determine the number of user lists to return.
pageToken
string
Page token, returned by a previous call, used to request the next page of results.
filter
string
Example filter: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND populateTime > "2012-04-21T11:30:00-04:00"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists user lists managed by a specified Ads Data Hub customer using the \u003ccode\u003ecustomers.userLists.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering, pagination, and specifying the view of user list data returned.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eProvides options to include deleted user lists and control the fields included in the response.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of user lists and a token for pagination.\u003c/p\u003e\n"]]],["This document details how to list user lists in Ads Data Hub. A `GET` HTTP request is made to a specific URL, including the parent customer ID in the path. The request can utilize query parameters like `pageSize`, `pageToken`, `filter`, `view`, and `showDeleted` to refine the results. The request body should be empty. The response contains an array of `userLists` and a `nextPageToken` for pagination, requiring the `https://www.googleapis.com/auth/adsdatahub` authorization scope. The `view` enum in the query parameter enables users to select specific information that will be returned.\n"],null,["# Method: customers.userLists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListUserListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [UserListView](#UserListView)\n\nLists the user lists managed by the specified Ads Data Hub customer.\n\n### HTTP request\n\n`GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------|\n| `parent` | `string` Required. Parent customer resource name, e.g. 'customers/123'. |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of items to return. If 0, the server will determine the number of user lists to return. |\n| `pageToken` | `string` Page token, returned by a previous call, used to request the next page of results. |\n| `filter` | `string` Example filter: title = \"user\\*\" AND title = \"\\*name\\*\" AND -type = FREQUENCY_BASED AND createEmail = \"creator@email.com\" AND listSize \\\u003e 10 AND populateTime \\\u003e \"2012-04-21T11:30:00-04:00\" |\n| `view` | `enum (`[UserListView](/ads-data-hub/marketers/reference/rest/v1/customers.userLists/list#UserListView)`)` Specifies which fields to include in each user list. |\n| `showDeleted` | `boolean` If set to true, deleted user lists will be included in the response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to a userLists.list request. Contains the user lists managed by the specified Ads Data Hub customer.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"userLists\": [ { object (/ads-data-hub/marketers/reference/rest/v1/customers.userLists#UserList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `userLists[]` | `object (`[UserList](/ads-data-hub/marketers/reference/rest/v1/customers.userLists#UserList)`)` A list of user lists. |\n| `nextPageToken` | `string` A token that can be used to request the next results page. This field is empty if there are no additional results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`\n\nUserListView\n------------\n\nEnum to indicate which fields to include in each user list returned by the \\[userLists.list\\] API.\n\n| Enums ||\n|------------------------------|-------------------------------------------------------------------|\n| `USER_LIST_VIEW_UNSPECIFIED` | The default / unset value. The API will default to the FULL view. |\n| `BASIC` | Include fields except \\[recipientAdsDataLinks\\]. |\n| `FULL` | Include everything. |"]]