試用 Google Analytics 的 MCP 伺服器。從
GitHub 安裝,詳情請參閱
公告。
REST Resource: properties.keyEvents
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
資源:KeyEvent
Google Analytics 資源中的重點事件。
JSON 表示法 |
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod ),
"defaultValue": {
object (DefaultValue )
}
} |
欄位 |
name |
string
僅供輸出。這項重要事件的資源名稱。格式:properties/{property}/keyEvents/{keyEvent}
|
eventName |
string
不可變動。此重要事件的事件名稱。例如:「click」、「purchase」
|
createTime |
string (Timestamp format)
僅供輸出。在資源中建立此重要事件的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 規格化,並使用 0、3、6 或 9 小數位數。系統也接受「Z」以外的偏移值。例如:"2014-10-02T15:01:23Z" 、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30" 。
|
deletable |
boolean
僅供輸出。如果設為 True,則可刪除這項事件。
|
custom |
boolean
僅供輸出。如果設為 true,這個重要事件就會參照自訂事件。如果設為 false,這個重要事件就會參照 GA 中的預設事件。預設事件通常在 GA 中具有特殊意義。預設事件通常是由 GA 系統建立,但在某些情況下,資源管理員也可以建立。自訂事件的數量會計入每項資源可建立的自訂重要事件數量上限。
|
countingMethod |
enum (CountingMethod )
必要欄位。在工作階段內,重要事件的計算方法。
|
defaultValue |
object (DefaultValue )
選用設定。定義重要事件的預設值/貨幣。
|
CountingMethod
列舉 |
COUNTING_METHOD_UNSPECIFIED |
未指定計算方法。 |
ONCE_PER_EVENT |
每個事件例項都視為重要事件。 |
ONCE_PER_SESSION |
每位使用者在每個工作階段中,最多只會將一個事件例項視為重要事件。 |
DefaultValue
JSON 表示法 |
{
"numericValue": number,
"currencyCode": string
} |
欄位 |
numericValue |
number
必要欄位。系統會在這個重要事件 (由 eventName 指定) 的所有事件中,為未設定的「value」參數填入這個值。
|
currencyCode |
string
必要欄位。如果這個重要事件 (由 eventName 指定) 的發生次數未設定幣別,系統會將此幣別設為預設值。必須採用 ISO 4217 貨幣代碼格式。 詳情請參閱 https://en.wikipedia.org/wiki/ISO_4217。
|
方法 |
|
建立重要事件。 |
|
刪除重要事件。 |
|
擷取單一按鍵事件。 |
|
傳回指定父項資源中的重點事件清單。 |
|
更新重要事件。 |
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-26 (世界標準時間)。
[null,null,["上次更新時間:2025-07-26 (世界標準時間)。"],[[["\u003cp\u003eKey Events are actions or interactions within a Google Analytics property that can be tracked and analyzed, with options for how they are counted during a session.\u003c/p\u003e\n"],["\u003cp\u003eYou can define a default numeric value and currency for a Key Event to automatically populate these parameters for instances where they are not explicitly set.\u003c/p\u003e\n"],["\u003cp\u003eThere are methods available to create, retrieve, update, and delete Key Events within a property via the API.\u003c/p\u003e\n"],["\u003cp\u003eKey Events can be either custom, defined by property admins, or default, with pre-defined meanings within Google Analytics.\u003c/p\u003e\n"]]],["Key Events in Google Analytics are defined by an event name and can be associated with a counting method (once per event or session). Each Key Event includes attributes like its creation time, custom status, and deletable status. They have optional default values, consisting of a numeric value and currency code. Key Events can be created, deleted, retrieved, listed, and updated using provided methods. The resource includes JSON schema for the data structure.\n"],null,["# REST Resource: properties.keyEvents\n\n- [Resource: KeyEvent](#KeyEvent)\n - [JSON representation](#KeyEvent.SCHEMA_REPRESENTATION)\n- [CountingMethod](#CountingMethod)\n- [DefaultValue](#DefaultValue)\n - [JSON representation](#DefaultValue.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: KeyEvent\n------------------\n\nA key event in a Google Analytics property.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"eventName\": string, \"createTime\": string, \"deletable\": boolean, \"custom\": boolean, \"countingMethod\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#CountingMethod), \"defaultValue\": { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#DefaultValue) } } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{keyEvent} |\n| `eventName` | `string` Immutable. The event name for this key event. Examples: 'click', 'purchase' |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time when this key event was created in the property. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `deletable` | `boolean` Output only. If set to true, this event can be deleted. |\n| `custom` | `boolean` Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. |\n| `countingMethod` | `enum (`[CountingMethod](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#CountingMethod)`)` Required. The method by which Key Events will be counted across multiple events within a session. |\n| `defaultValue` | `object (`[DefaultValue](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents#DefaultValue)`)` Optional. Defines a default value/currency for a key event. |\n\nCountingMethod\n--------------\n\nThe method by which Key Events will be counted across multiple events within a session.\n\n| Enums ||\n|-------------------------------|--------------------------------------------------------------------------------|\n| `COUNTING_METHOD_UNSPECIFIED` | Counting method not specified. |\n| `ONCE_PER_EVENT` | Each Event instance is considered a Key Event. |\n| `ONCE_PER_SESSION` | An Event instance is considered a Key Event at most once per session per user. |\n\nDefaultValue\n------------\n\nDefines a default value/currency for a key event.\n\n| JSON representation |\n|------------------------------------------------------------|\n| ``` { \"numericValue\": number, \"currencyCode\": string } ``` |\n\n| Fields ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `numericValue` | `number` Required. This will be used to populate the \"value\" parameter for all occurrences of this Key Event (specified by eventName) where that parameter is unset. |\n| `currencyCode` | `string` Required. When an occurrence of this Key Event (specified by eventName) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See \u003chttps://en.wikipedia.org/wiki/ISO_4217\u003e for more information. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------------------|----------------------------------------------------------------|\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/create) | Creates a Key Event. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/delete) | Deletes a Key Event. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/get) | Retrieve a single Key Event. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/list) | Returns a list of Key Events in the specified parent property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/patch) | Updates a Key Event. |"]]