Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customDimensions.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists CustomDimensions on a property.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customDimensions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. 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 customDimensions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to customDimensions.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for customDimensions.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"customDimensions": [
{
object (CustomDimension)
}
],
"nextPageToken": string
} |
| Fields |
customDimensions[] |
object (CustomDimension)
List of CustomDimensions.
|
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 CustomDimensions on a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by page size and utilizes pagination for retrieving large datasets.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for data access.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the HTTP request structure, including path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of CustomDimensions and a token for accessing subsequent pages if available.\u003c/p\u003e\n"]]],["This document details how to list custom dimensions associated with a Google Analytics property. The core action is sending a `GET` request to `https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customDimensions`. The `parent` path parameter, representing the property ID, is required. Optional query parameters `pageSize` (up to 200) and `pageToken` are available for pagination. The request body must be empty. The response contains a list of `customDimensions` and a `nextPageToken` for further pagination. Access requires either `analytics.readonly` or `analytics.edit` authorization scopes.\n"],null,["# Method: properties.customDimensions.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.ListCustomDimensionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists CustomDimensions on a property.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customDimensions`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. 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 `customDimensions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `customDimensions.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 customDimensions.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customDimensions\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions#CustomDimension) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customDimensions[]` | `object (`[CustomDimension](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions#CustomDimension)`)` List of CustomDimensions. |\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`"]]
