Method: properties.keyEvents.list
返回指定父级媒体资源中的按键事件列表。如果未找到任何按键事件,则返回空列表。
HTTP 请求
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/keyEvents
网址采用 gRPC 转码语法。
路径参数
参数 |
parent |
string
必需。父媒体资源的资源名称。示例:“properties/123”
|
查询参数
参数 |
pageSize |
integer
要返回的资源的数量上限。如果未指定,则最多返回 50 个资源。最大值为 200;(更高的值将被强制转换为最大值)
|
pageToken |
string
从之前的 keyEvents.list 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时,提供给 keyEvents.list 的所有其他参数必须与提供页面令牌的调用匹配。
|
响应正文
keyEvents.list RPC 的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
{
"keyEvents": [
{
object (KeyEvent )
}
],
"nextPageToken": string
} |
字段 |
keyEvents[] |
object (KeyEvent )
请求的按键事件
|
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。"],[[["Retrieves a list of Key Events, which are significant changes or occurrences within a Google Analytics property."],["Allows for filtering by parent property and pagination to manage large result sets."],["Requires specific authorization scopes for access, including read-only or edit permissions for Google Analytics data."],["Provides details about the HTTP request structure, including path and query parameters, for interacting with the API."],["The response includes a list of Key Events and a token for retrieving subsequent pages if available."]]],["This document details how to retrieve a list of Key Events associated with a specific property. A `GET` request to the provided URL, including the property's ID in the `parent` path parameter, is used. Optional `pageSize` and `pageToken` query parameters facilitate pagination. The request body must be empty. The response, formatted as JSON, contains an array of `keyEvents` and an optional `nextPageToken` for subsequent pages. It requires specific OAuth authorization scopes.\n"]]