Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audiences.get
Stay organized with collections
Save and categorize content based on your preferences.
Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the Audience to get. Example format: properties/1234/audiences/5678
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Audience.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics.edit
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\u003eRetrieve a specific Audience resource using its unique name, formatted as properties/{propertyId}/audiences/{audienceId}.\u003c/p\u003e\n"],["\u003cp\u003eRequest requires authorization using either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eOnly audiences created after 2020 and non-default audiences can be successfully retrieved.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes the Audience object if found, otherwise an error.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a single Audience using a `GET` HTTP request to the Google Analytics Admin API. The request URL requires a path parameter, `name`, specifying the Audience's identifier (e.g., `properties/1234/audiences/5678`). The request body must be empty. Successful responses return an Audience instance. Authorization requires either the `analytics.readonly` or `analytics.edit` OAuth scope. The example uses the gRPC Transcoding syntax. Audiences created before 2020 might not be supported.\n"],null,["# Method: properties.audiences.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\nLookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}`\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 name of the Audience to get. Example format: properties/1234/audiences/5678 |\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 [Audience](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.audiences#Audience).\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.edit`"]]
