Method: properties.keyEvents.list
指定された親プロパティ内の Key Event のリストを返します。キーイベントが見つからない場合、空のリストが返されます。
HTTP リクエスト
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/keyEvents
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ |
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 Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-01-14 UTC。
[null,null,["最終更新日 2025-01-14 UTC。"],[[["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"]]