Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audienceLists.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The audience list resource name. Format: properties/{property}/audienceLists/{audienceList}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of AudienceList.
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\u003eRetrieves configuration metadata for a specific audience list, allowing users to understand its details after creation.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eaudienceExports.get\u003c/code\u003e method to access audience list information, offering beta stability and a feedback form for API improvements.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ename\u003c/code\u003e path parameter, specifying the audience list resource name in the format \u003ccode\u003eproperties/{property}/audienceLists/{audienceList}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eEmploys an empty request body and returns an \u003ccode\u003eAudienceList\u003c/code\u003e instance in the response upon successful execution.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.readonly\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/analytics\u003c/code\u003e OAuth scopes.\u003c/p\u003e\n"]]],["This document outlines the process of retrieving configuration metadata for a specific audience list via the `audienceExports.get` method, available in beta. The HTTP request uses a GET method with a URL structure including path parameters, specifically the `name` of the audience list. The request body must be empty, and a successful response returns an `AudienceList` instance. Access requires either `analytics.readonly` or `analytics` OAuth scopes. This function is for understanding audience lists after their creation.\n"],null,["# Method: properties.audienceLists.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 list. This method can be used to understand an audience list after it has been created.\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.get](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/get). 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/{name=properties/*/audienceLists/*}`\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 list resource name. Format: `properties/{property}/audienceLists/{audienceList}` |\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 [AudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.audienceLists#AudienceList).\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`"]]
