MCP-Server für Google Analytics ausprobieren Installieren Sie das Tool über
GitHub. Weitere Informationen finden Sie in der
Ankündigung.
REST Resource: properties.keyEvents
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ressource: KeyEvent
Ein Schlüsselereignis in einer Google Analytics-Property.
JSON-Darstellung |
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod ),
"defaultValue": {
object (DefaultValue )
}
} |
Felder |
name |
string
Nur Ausgabe. Ressourcenname dieses Schlüsselereignisses. Format: properties/{property}/keyEvents/{keyEvent}
|
eventName |
string
Nicht veränderbar. Der Ereignisname für dieses Schlüsselereignis. Beispiele: „click“ (Klick) und „purchase“ (Kauf)
|
createTime |
string (Timestamp format)
Nur Ausgabe. Zeitpunkt, zu dem dieses Schlüsselereignis in der Property erstellt wurde. Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30" .
|
deletable |
boolean
Nur Ausgabe. Wenn „true“ festgelegt ist, kann dieses Ereignis gelöscht werden.
|
custom |
boolean
Nur Ausgabe. Wenn diese Option auf „wahr“ gesetzt ist, bezieht sich dieses Schlüsselereignis auf ein benutzerdefiniertes Ereignis. Wenn „false“ festgelegt ist, bezieht sich dieses Schlüsselereignis auf ein Standardereignis in Google Analytics. Standardereignisse haben in Google Analytics in der Regel eine besondere Bedeutung. Sie werden in der Regel vom Google Analytics-System für Sie erstellt, können aber in einigen Fällen auch von Property-Administratoren erstellt werden. Benutzerdefinierte Ereignisse werden auf die maximale Anzahl von benutzerdefinierten Schlüsselereignissen angerechnet, die pro Property erstellt werden können.
|
countingMethod |
enum (CountingMethod )
Erforderlich. Die Methode, mit der Schlüsselereignisse über mehrere Ereignisse innerhalb einer Sitzung gezählt werden.
|
defaultValue |
object (DefaultValue )
Optional. Hiermit wird ein Standardwert/eine Standardwährung für ein Schlüsselereignis definiert.
|
CountingMethod
Die Methode, mit der Schlüsselereignisse über mehrere Ereignisse innerhalb einer Sitzung gezählt werden.
Enums |
COUNTING_METHOD_UNSPECIFIED |
Zählmethode nicht angegeben. |
ONCE_PER_EVENT |
Jede Ereignisinstanz wird als Schlüsselereignis betrachtet. |
ONCE_PER_SESSION |
Eine Ereignisinstanz wird höchstens einmal pro Sitzung und pro Nutzer als Schlüsselereignis betrachtet. |
DefaultValue
Hiermit wird ein Standardwert/eine Standardwährung für ein Schlüsselereignis definiert.
JSON-Darstellung |
{
"numericValue": number,
"currencyCode": string
} |
Felder |
numericValue |
number
Erforderlich. Dieser Wert wird verwendet, um den Parameter „value“ für alle Vorkommnisse dieses Schlüsselereignisses (angegeben durch „eventName“) auszufüllen, bei denen dieser Parameter nicht festgelegt ist.
|
currencyCode |
string
Erforderlich. Wenn für ein Auftreten dieses Schlüsselereignisses (angegeben durch „eventName“) keine Währung festgelegt ist, wird diese Währung als Standard angewendet. Muss im Format des ISO 4217-Währungscodes angegeben werden. Weitere Informationen finden Sie unter https://en.wikipedia.org/wiki/ISO_4217.
|
Methoden |
|
Erstellt ein Schlüsselereignis. |
|
Löscht ein Schlüsselereignis. |
|
Ein einzelnes Schlüsselereignis abrufen |
|
Gibt eine Liste der wichtigen Ereignisse in der angegebenen übergeordneten Property zurück. |
|
Aktualisiert ein Schlüsselereignis. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eKeyEvent resources represent significant events within a Google Analytics property, such as clicks or purchases, and can be custom or default.\u003c/p\u003e\n"],["\u003cp\u003eKey Events have a counting method that determines how they are tallied across multiple events in a session (e.g., once per event or once per session).\u003c/p\u003e\n"],["\u003cp\u003eIt is possible to define a default numeric value and currency for a Key Event, which will be used if these parameters are not set in the event data.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Analytics provides API methods to manage Key Events, including creating, deleting, retrieving, listing, and updating them.\u003c/p\u003e\n"]]],["Key Events in Google Analytics track specific actions within a property, identified by an `eventName`. Each Key Event can have a `countingMethod` (`ONCE_PER_EVENT` or `ONCE_PER_SESSION`). They may have a `defaultValue` with a `numericValue` and `currencyCode`. Key Events are created, retrieved, listed, updated, and deleted via dedicated methods. Key events can be default or custom and store information such as if they are deletable, their creation time and their resource name.\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/v1beta/properties.keyEvents#CountingMethod), \"defaultValue\": { object (/analytics/devguides/config/admin/v1/rest/v1beta/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/v1beta/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/v1beta/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/v1beta/properties.keyEvents/create) | Creates a Key Event. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/delete) | Deletes a Key Event. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/get) | Retrieve a single Key Event. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/list) | Returns a list of Key Events in the specified parent property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents/patch) | Updates a Key Event. |"]]