Essayez le serveur MCP pour Google Analytics. Installez-le depuis
GitHub et consultez l'
annonce pour en savoir plus.
REST Resource: properties.keyEvents
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: KeyEvent
Événement clé dans une propriété Google Analytics.
Représentation JSON |
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod ),
"defaultValue": {
object (DefaultValue )
}
} |
Champs |
name |
string
Uniquement en sortie. Nom de la ressource de cet événement clé. Format: properties/{property}/keyEvents/{keyEvent}
|
eventName |
string
Immuable. Nom de l'événement pour cet événement clé. Exemples: "clic", "achat"
|
createTime |
string (Timestamp format)
Uniquement en sortie. Heure à laquelle cet événement clé a été créé dans la propriété. Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30" .
|
deletable |
boolean
Uniquement en sortie. Si cette valeur est définie sur "true", cet événement peut être supprimé.
|
custom |
boolean
Uniquement en sortie. Si elle est définie sur "True", cet événement clé fait référence à un événement personnalisé. Si la valeur est définie sur "false", cet événement clé fait référence à un événement par défaut dans GA. Les événements par défaut ont généralement une signification particulière dans GA. Ils sont généralement créés par le système GA, mais peuvent parfois être créés par les administrateurs de la propriété. Les événements personnalisés sont comptabilisés dans le nombre maximal d'événements clés personnalisés pouvant être créés par propriété.
|
countingMethod |
enum (CountingMethod )
Obligatoire. Méthode de comptabilisation des événements clés pour plusieurs événements au cours d'une session.
|
defaultValue |
object (DefaultValue )
Facultatif. Définit une valeur/une devise par défaut pour un événement clé.
|
CountingMethod
Méthode de comptabilisation des événements clés pour plusieurs événements au cours d'une session.
Enums |
COUNTING_METHOD_UNSPECIFIED |
La méthode de comptabilisation n'est pas spécifiée. |
ONCE_PER_EVENT |
Chaque instance d'événement est considérée comme un événement clé. |
ONCE_PER_SESSION |
Une instance d'événement est considérée comme un événement clé au maximum une fois par session et par utilisateur. |
DefaultValue
Définit une valeur/une devise par défaut pour un événement clé.
Représentation JSON |
{
"numericValue": number,
"currencyCode": string
} |
Champs |
numericValue |
number
Obligatoire. Il sera utilisé pour renseigner le paramètre "value" pour toutes les occurrences de cet événement clé (spécifié par eventName) pour lequel ce paramètre n'est pas défini.
|
currencyCode |
string
Obligatoire. Lorsqu'une occurrence de cet événement clé (spécifiée par eventName) n'a pas de devise définie, cette devise est appliquée par défaut. Doit être au format de code de devise ISO 4217. Pour en savoir plus, consultez https://en.wikipedia.org/wiki/ISO_4217.
|
Méthodes |
|
Crée un événement clé. |
|
Supprime un événement clé. |
|
Récupérer un seul événement clé |
|
Renvoie une liste d'événements de touche dans la propriété parente spécifiée. |
|
Met à jour un événement clé. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\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. |"]]