Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.recurringAudienceLists.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets configuration metadata about a specific recurring audience list. This method can be used to understand a recurring audience list's state after it has been created. For example, a recurring audience list resource will generate audience list instances for each day, and this method can be used to get the resource name of the most recent audience list instance.
This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.
HTTP request
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/recurringAudienceLists/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The recurring audience list resource name. Format: properties/{property}/recurringAudienceLists/{recurringAudienceList}
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of RecurringAudienceList
.
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\u003eRetrieves configuration metadata for a specific recurring audience list, providing insight into its state and recent activity.\u003c/p\u003e\n"],["\u003cp\u003eEnables users to understand the recurring audience list's state and access information about generated audience list instances.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the specified URL with the recurring audience list's resource name as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eRecurringAudienceList\u003c/code\u003e object containing the requested metadata if the request is successful.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics\u003c/code\u003e OAuth scopes.\u003c/p\u003e\n"]]],["This document outlines the process of retrieving metadata for a specific recurring audience list using a `GET` request. The core action is to use the provided `name` path parameter, formatted as `properties/*/recurringAudienceLists/*`, within the URL. The request body must be empty. A successful request returns a `RecurringAudienceList` resource. The method requires authorization via either `analytics.readonly` or `analytics` OAuth scopes. It aims to provide insights into an audience list's state, including recent instances.\n"],null,["# Method: properties.recurringAudienceLists.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 recurring audience list. This method can be used to understand a recurring audience list's state after it has been created. For example, a recurring audience list resource will generate audience list instances for each day, and this method can be used to get the resource name of the most recent audience list instance.\n\nThis method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. 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/*/recurringAudienceLists/*}`\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 recurring audience list resource name. Format: `properties/{property}/recurringAudienceLists/{recurringAudienceList}` |\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 [RecurringAudienceList](/analytics/devguides/reporting/data/v1/rest/v1alpha/properties.recurringAudienceLists#RecurringAudienceList).\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`"]]