Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audienceExports.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.
See Creating an Audience Export for an introduction to Audience Exports with examples.
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
GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The audience export resource name. Format: properties/{property}/audienceExports/{audienceExport}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of AudienceExport
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonly
https://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\u003eThis API endpoint retrieves configuration metadata for a specific audience export, allowing users to understand its details after creation.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003ename\u003c/code\u003e path parameter specifying the audience export resource in the format \u003ccode\u003eproperties/{property}/audienceExports/{audienceExport}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses provide an \u003ccode\u003eAudienceExport\u003c/code\u003e object containing the export's metadata.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires either the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.readonly\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/analytics\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the "Creating an Audience Export" guide for introductory information and examples related to Audience Exports.\u003c/p\u003e\n"]]],["This document outlines the process of retrieving configuration metadata for a specific audience export via the Google Analytics Audience Export API. Key actions include sending a `GET` request to a specific URL, structured using gRPC Transcoding syntax. The request requires a `name` parameter specifying the audience export resource. The request body must be empty. A successful response contains an instance of `AudienceExport`. Authorization requires either `analytics.readonly` or `analytics` OAuth scopes. The user can give feedback using the provided form.\n"],null,["# Method: properties.audienceExports.get\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\nGets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created.\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\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`GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audienceExport}` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [AudienceExport](/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports#AudienceExport).\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`"]]