Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audienceLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days.
See Creating an Audience List for an introduction to Audience Lists with examples.
This method is available at beta stability at audienceExports.list. 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/*}/audienceLists
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. All audience lists for this property will be listed in the response. Format: properties/{property}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 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 audienceLists.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to audienceLists.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
A list of all audience lists for a property.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"audienceLists": [
{
object (AudienceList)
}
],
"nextPageToken": string
} |
| Fields |
audienceLists[] |
object (AudienceList)
Each 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 audience lists for a given Google Analytics property, allowing for reuse of existing lists.\u003c/p\u003e\n"],["\u003cp\u003eProvides pagination to handle large numbers of audience lists, with customizable page size.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, either read-only or full Analytics access.\u003c/p\u003e\n"],["\u003cp\u003eUses a standard HTTP GET request with path and query parameters to specify the property and retrieval options.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response containing an array of audience lists and a token for retrieving subsequent pages.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of audience lists for a specific property using the Google Analytics Data API. It utilizes a `GET` HTTP request to the `audienceLists` endpoint, specifying the property in the `parent` path parameter. Optional query parameters include `pageSize` to limit results and `pageToken` for pagination. The request body must be empty. Successful responses include an array of `audienceLists` and a `nextPageToken` for subsequent pages. This operation requires `analytics.readonly` or `analytics` authorization scopes.\n"],null,["# Method: properties.audienceLists.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.ListAudienceListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days.\n\nSee [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples.\n\nThis method is available at beta stability at [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list). 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/*}/audienceLists`\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 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 audience lists to return. The service may return fewer than this value. If unspecified, at most 200 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 `audienceLists.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `audienceLists.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 audience lists for a property.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"audienceLists\": [ { object (/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `audience``Lists[]` | `object (`[AudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList)`)` Each 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`"]]
