Teste o servidor MCP do Google Analytics. Instale no
GitHub e confira o
anúncio para mais detalhes.
REST Resource: properties.keyEvents
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: KeyEvent
Um evento principal em uma propriedade do Google Analytics.
Representação JSON |
{
"name": string,
"eventName": string,
"createTime": string,
"deletable": boolean,
"custom": boolean,
"countingMethod": enum (CountingMethod ),
"defaultValue": {
object (DefaultValue )
}
} |
Campos |
name |
string
Apenas saída. Nome do recurso desse evento principal. Formato: properties/{property}/keyEvents/{keyEvent}
|
eventName |
string
Imutável. O nome do evento principal. Exemplos: "click", "compra"
|
createTime |
string (Timestamp format)
Apenas saída. Horário em que esse evento principal foi criado na propriedade. Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30" .
|
deletable |
boolean
Apenas saída. Se definido como verdadeiro, esse evento pode ser excluído.
|
custom |
boolean
Apenas saída. Se definido como "true", esse evento principal se refere a um evento personalizado. Se definido como "false", esse evento principal se refere a um evento padrão no GA. Os eventos padrão geralmente têm um significado especial no GA. Eles são criados pelo sistema do GA, mas, em alguns casos, podem ser criados pelos administradores da propriedade. Os eventos personalizados contam para o número máximo de eventos principais personalizados que podem ser criados por propriedade.
|
countingMethod |
enum (CountingMethod )
Obrigatório. O método pelo qual os eventos principais são contados em vários eventos em uma sessão.
|
defaultValue |
object (DefaultValue )
Opcional. Define um valor/moeda padrão para um evento principal.
|
CountingMethod
O método pelo qual os eventos principais são contados em vários eventos em uma sessão.
Enums |
COUNTING_METHOD_UNSPECIFIED |
O método de contagem não foi especificado. |
ONCE_PER_EVENT |
Cada instância de evento é considerada um evento principal. |
ONCE_PER_SESSION |
Uma instância de evento é considerada um evento principal no máximo uma vez por sessão e por usuário. |
DefaultValue
Define um valor/moeda padrão para um evento principal.
Representação JSON |
{
"numericValue": number,
"currencyCode": string
} |
Campos |
numericValue |
number
Obrigatório. Ele será usado para preencher o parâmetro "value" em todas as ocorrências desse evento principal (especificado por eventName) em que esse parâmetro não estiver definido.
|
currencyCode |
string
Obrigatório. Quando uma ocorrência desse evento principal (especificado por eventName) não tiver uma moeda definida, essa moeda será aplicada como padrão. Precisa estar no formato de código de moeda ISO 4217. Consulte https://en.wikipedia.org/wiki/ISO_4217 para mais informações.
|
Métodos |
|
Cria um evento principal. |
|
Exclui um evento principal. |
|
Extrair um único evento de tecla. |
|
Retorna uma lista de eventos de chave na propriedade pai especificada. |
|
Atualiza um evento principal. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 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. |"]]