Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.channelGroups.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists ChannelGroups on a property.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/channelGroups
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The property for which to list ChannelGroups. Example format: properties/1234
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
|
pageToken |
string
A page token, received from a previous channelGroups.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to channelGroups.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for channelGroups.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"channelGroups": [
{
object (ChannelGroup)
}
],
"nextPageToken": string
} |
| Fields |
channelGroups[] |
object (ChannelGroup)
List of ChannelGroup. These will be ordered stably, but in an arbitrary order.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eLists all ChannelGroups associated with a specific Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size and navigating through results with pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of ChannelGroups and a token for accessing subsequent pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires appropriate authorization with either read-only or edit access to Google Analytics.\u003c/p\u003e\n"]]],["This document details how to list ChannelGroups within a property using the Google Analytics Admin API. The core action is performing a `GET` request to a specific URL, structured with a required `parent` path parameter indicating the property ID. Optional query parameters include `pageSize` and `pageToken` for pagination. The request body must be empty. Successful responses contain a list of `channelGroups` and a `nextPageToken` for further pagination. Authorization requires specific OAuth scopes: `analytics.readonly` or `analytics.edit`.\n"],null,["# Method: properties.channelGroups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListChannelGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ChannelGroups on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/channelGroups`\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 property for which to list ChannelGroups. Example format: properties/1234 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |\n| `pageToken` | `string` A page token, received from a previous `channelGroups.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `channelGroups.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for channelGroups.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"channelGroups\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.channelGroups#ChannelGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `channelGroups[]` | `object (`[ChannelGroup](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.channelGroups#ChannelGroup)`)` List of ChannelGroup. These will be ordered stably, but in an arbitrary order. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\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`"]]
