Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audienceLists.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the audienceLists.query method.
See Creating an Audience List for an introduction to Audience Lists with examples.
An audience list is a snapshot of the users currently in the audience at the time of audience list creation. Creating audience lists for one audience on different days will return different results as users enter and exit the audience.
Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience lists contain the users in each audience.
This method is available at beta stability at audienceExports.create. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.
HTTP request
POST https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource where this audience list will be created. Format: properties/{property}
|
Request body
The request body contains an instance of AudienceList.
Response body
If successful, the response body contains a newly created instance of Operation.
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-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eCreates an audience list containing a snapshot of users in an audience at the time of creation, allowing for later retrieval and querying.\u003c/p\u003e\n"],["\u003cp\u003eThe method utilizes an asynchronous request, returning the audience list resource name immediately while the list formation process occurs in the background.\u003c/p\u003e\n"],["\u003cp\u003eAudience lists are dynamic and reflect the current state of an audience; creating lists on different days for the same audience may yield varied results due to user fluctuations.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eaudienceExports.create\u003c/code\u003e method at beta stability, requiring specific authorization scopes for access.\u003c/p\u003e\n"]]],["This API method facilitates the creation of audience lists in Google Analytics 4. It initiates an asynchronous process to generate a list of users matching a defined audience. Key actions include sending a POST request to `audienceLists` with a defined `parent` path parameter, representing the property. The request body defines the audience list, and the successful response includes the audience list's resource name and an Operation instance. Authorization requires specific OAuth scopes. The newly created list can then be used for user segmentation.\n"],null,["# Method: properties.audienceLists.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the `audienceLists.query` method.\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\nAn audience list is a snapshot of the users currently in the audience at the time of audience list creation. Creating audience lists for one audience on different days will return different results as users enter and exit the audience.\n\nAudiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see \u003chttps://support.google.com/analytics/answer/9267572\u003e. Audience lists contain the users in each audience.\n\nThis method is available at beta stability at [audienceExports.create](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/create). 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`POST 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. The parent resource where this audience list will be created. Format: `properties/{property}` |\n\n### Request body\n\nThe request body contains an instance of [AudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/analytics/devguides/reporting/data/v1/rest/Shared.Types/Operation).\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`"]]
