Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.recurringAudienceLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all recurring audience lists for a property. This method can be used for you to find and reuse existing recurring audience lists rather than creating unnecessary new recurring audience lists. The same audience can have multiple recurring audience lists that represent different dimension combinations; for example, just the dimension deviceId or both the dimensions deviceId and userId.
This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.
HTTP request
GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/recurringAudienceLists
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. All recurring audience lists for this property will be listed in the response. Format: properties/{property}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of recurring audience lists to return. The service may return fewer than this value. If unspecified, at most 200 recurring audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum).
|
pageToken |
string
Optional. A page token, received from a previous recurringAudienceLists.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to recurringAudienceLists.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
A list of all recurring audience lists for a property.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"recurringAudienceLists": [
{
object (RecurringAudienceList)
}
],
"nextPageToken": string
} |
| Fields |
recurringAudienceLists[] |
object (RecurringAudienceList)
Each recurring audience list for a property.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["\u003cp\u003eLists all recurring audience lists for a given Google Analytics property, allowing for reuse of existing lists.\u003c/p\u003e\n"],["\u003cp\u003eEnables finding audience lists with different dimension combinations (e.g., deviceId, userId).\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large numbers of recurring audience lists.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access.\u003c/p\u003e\n"],["\u003cp\u003eCurrently in alpha, with a feedback form available for user input.\u003c/p\u003e\n"]]],["This document details how to list recurring audience lists for a property using the Google Analytics Audience Export API. The API uses a `GET` request to a specified URL with the property ID as a path parameter. Optional query parameters (`pageSize`, `pageToken`) manage pagination. The request body is empty. The response is a JSON object containing an array of recurring audience lists and a `nextPageToken` for further pagination, if required. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.recurringAudienceLists.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.ListRecurringAudienceListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all recurring audience lists for a property. This method can be used for you to find and reuse existing recurring audience lists rather than creating unnecessary new recurring audience lists. The same audience can have multiple recurring audience lists that represent different dimension combinations; for example, just the dimension `deviceId` or both the dimensions `deviceId` and `userId`.\n\nThis method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.\n\n### HTTP request\n\n`GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/recurringAudienceLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. All recurring audience lists for this property will be listed in the response. Format: `properties/{property}` |\n\n### Query parameters\n\n| Parameters ||\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Size` | `integer` Optional. The maximum number of recurring audience lists to return. The service may return fewer than this value. If unspecified, at most 200 recurring audience lists will be returned. The maximum value is 1000 (higher values will be coerced to the maximum). |\n| `page``Token` | `string` Optional. A page token, received from a previous `recurringAudienceLists.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `recurringAudienceLists.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of all recurring audience lists for a property.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"recurringAudienceLists\": [ { object (/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.recurringAudienceLists#RecurringAudienceList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `recurring``Audience``Lists[]` | `object (`[RecurringAudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.recurringAudienceLists#RecurringAudienceList)`)` Each recurring audience list for a property. |\n| `next``Page``Token` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics`"]]
