Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audienceExports.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the audienceExports.query method.
See Creating an Audience Export for an introduction to Audience Exports with examples.
An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports 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 exports contain the users in each audience.
Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.
HTTP request
POST https://analyticsdata.googleapis.com/v1beta/{parent=properties/*}/audienceExports
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource where this audience export will be created. Format: properties/{property}
|
Request body
The request body contains an instance of AudienceExport.
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 export for later retrieval that contains a snapshot of users in an audience at the time of creation.\u003c/p\u003e\n"],["\u003cp\u003eThe API initiates a long-running asynchronous request to form an audience export, and the audience export's resource name is returned quickly.\u003c/p\u003e\n"],["\u003cp\u003eTo export users in an audience export, first create the audience export and then use the \u003ccode\u003eaudienceExports.query\u003c/code\u003e method with the audience resource name.\u003c/p\u003e\n"],["\u003cp\u003eAudience exports may vary day-to-day as users join or leave the audience being exported.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either the \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This outlines the process of creating an audience export through an API. It involves sending a POST request to a specified URL, including the parent property ID in the path parameters. The request body uses an `AudienceExport` instance. Upon success, it returns an `Operation` instance, signifying a long-running process. The audience export captures a user snapshot at creation, and different creations yield varied user lists. The API requires specific OAuth scopes for authorization.\n"],null,["# Method: properties.audienceExports.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 export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `audienceExports.query` method.\n\nSee [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples.\n\nAn audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports 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 exports contain the users in each audience.\n\nAudience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. 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/v1beta/{parent=properties/*}/audienceExports`\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 export will be created. Format: `properties/{property}` |\n\n### Request body\n\nThe request body contains an instance of [AudienceExport](/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports#AudienceExport).\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`"]]
