Method: properties.keyEvents.list
傳回指定父項資源中的 Key Events 清單。如果找不到任何按鍵事件,則會傳回空白清單。
HTTP 要求
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/keyEvents
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
parent |
string
必要欄位。父項資源的資源名稱。例如:'properties/123'
|
查詢參數
參數 |
pageSize |
integer
要傳回的資源數量上限。如未指定,系統會傳回最多 50 項資源。許可的最大值為 200;超出的數值將一律指定為 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
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-01-14 (世界標準時間)。
[null,null,["上次更新時間: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"]]