Wypróbuj serwer MCP w Google Analytics. Zainstaluj go z
GitHub. Więcej informacji znajdziesz w
ogłoszeniu.
REST Resource: properties.keyEvents
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: KeyEvent
Kluczowe zdarzenie w usłudze w Google Analytics.
Zapis JSON |
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod ),
"defaultValue": {
object (DefaultValue )
}
} |
Pola |
name |
string
Tylko dane wyjściowe. Nazwa zasobu tego kluczowego zdarzenia. Format: usługi/{usługa}/zdarzenia kluczowe/{zdarzenie_kluczowe}
|
eventName |
string
Niezmienna. Nazwa tego kluczowego zdarzenia. Przykłady: „kliknięcie”, „zakup”.
|
createTime |
string (Timestamp format)
Tylko dane wyjściowe. Czas utworzenia tego kluczowego zdarzenia w usłudze. Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30" .
|
deletable |
boolean
Tylko dane wyjściowe. Jeśli ma wartość Prawda, to zdarzenie można usunąć.
|
custom |
boolean
Tylko dane wyjściowe. Jeśli wartość to Prawda, to kluczowe zdarzenie odnosi się do zdarzenia niestandardowego. Jeśli wartość to „false”, to kluczowe zdarzenie odnosi się do zdarzenia domyślnego w GA. Zdarzenia domyślne mają w GA zwykle specjalne znaczenie. Zdarzenia domyślne są zwykle tworzone przez system GA, ale w niektórych przypadkach mogą być tworzone przez administratorów usług. Zdarzenia niestandardowe wliczają się do maksymalnej liczby niestandardowych kluczowych zdarzeń, które można utworzyć w poszczególnych usługach.
|
countingMethod |
enum (CountingMethod )
Wymagane. Metoda zliczania kluczowych zdarzeń w przypadku wielu zdarzeń w ramach sesji.
|
defaultValue |
object (DefaultValue )
Opcjonalnie: Określa domyślną wartość lub walutę kluczowego zdarzenia.
|
CountingMethod
Metoda zliczania kluczowych zdarzeń w przypadku wielu zdarzeń w ramach sesji.
Wartości w polu enum |
COUNTING_METHOD_UNSPECIFIED |
Metoda zliczania nie została określona. |
ONCE_PER_EVENT |
Każda instancja zdarzenia jest uznawana za kluczowe zdarzenie. |
ONCE_PER_SESSION |
Wystąpienie zdarzenia jest uznawane za kluczowe zdarzenie maksymalnie raz na sesję na użytkownika. |
DefaultValue
Określa domyślną wartość lub walutę kluczowego zdarzenia.
Zapis JSON |
{
"numericValue": number,
"currencyCode": string
} |
Pola |
numericValue |
number
Wymagane. Parametr ten służy do wypełniania parametru „value” we wszystkich wystąpieniach tego kluczowego zdarzenia (określonego przez eventName), w których parametr ten nie ma określonej wartości.
|
currencyCode |
string
Wymagane. Jeśli wystąpienie tego kluczowego zdarzenia (określone przez parametr eventName) nie ma określonej waluty, zostanie zastosowana ta waluta jako domyślna. Musi być w formacie kodu waluty ISO 4217. Więcej informacji znajdziesz na stronie https://en.wikipedia.org/wiki/ISO_4217.
|
Metody |
|
Tworzy kluczowe zdarzenie. |
|
Usuwa kluczowe zdarzenie. |
|
Pobieranie pojedynczego kluczowego zdarzenia. |
|
Zwraca listę kluczowych zdarzeń w określonej usłudze nadrzędnej. |
|
Aktualizuje kluczowe zdarzenie. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-26 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]