Method: properties.customDimensions.list
列出媒体资源上的 CustomDimensions。
HTTP 请求
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/customDimensions
网址采用 gRPC 转码语法。
路径参数
参数 |
parent |
string
必需。示例格式:properties/1234
|
查询参数
参数 |
pageSize |
integer
要返回的资源的数量上限。如果未指定,则最多返回 50 个资源。最大值为 200(更高的值将强制转换为最大值)。
|
pageToken |
string
从之前的 customDimensions.list 调用接收的页面令牌。利用其进行后续页面检索。 进行分页时,提供给 customDimensions.list 的所有其他参数必须与提供页面令牌的调用匹配。
|
响应正文
customDimensions.list RPC 的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
{
"customDimensions": [
{
object (CustomDimension )
}
],
"nextPageToken": string
} |
字段 |
customDimensions[] |
object (CustomDimension )
CustomDimensions 列表。
|
nextPageToken |
string
可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。
|
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-01-14。
[null,null,["最后更新时间 (UTC):2025-01-14。"],[[["Lists all CustomDimensions on a specified Google Analytics 4 property."],["Allows filtering by page size and utilizes pagination for retrieving large datasets."],["Requires specific authorization scopes for data access."],["Provides details on the HTTP request structure, including path and query parameters."],["Returns a list of CustomDimensions and a token for accessing subsequent pages if available."]]],["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"]]