REST Resource: properties.keyEvents

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 deste evento principal. Formato: Properties/{property}/keyEvents/{keyEvent}

eventName

string

Imutável. O nome deste evento principal. Exemplos: "click", "purchase"

createTime

string (Timestamp format)

Apenas saída. Hora em que esse evento principal foi criado na propriedade.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

deletable

boolean

Apenas saída. Se definido como verdadeiro, o evento poderá ser excluído.

custom

boolean

Apenas saída. Se definido como verdadeiro, esse evento principal se refere a um evento personalizado. Se definido como "falso", esse evento principal se refere a um evento padrão no GA. Os eventos padrão normalmente têm um significado especial no GA. Os eventos padrão geralmente são criados pelo sistema do GA, mas, em alguns casos, podem ser criados pelos administradores da propriedade. Os eventos personalizados são contabilizados no 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 serão contados em vários eventos de 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 serão contados em vários eventos de uma sessão.

Enums
COUNTING_METHOD_UNSPECIFIED Método de contagem não 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 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 o parâmetro não está definido.

currencyCode

string

Obrigatório. Quando uma ocorrência deste evento principal (especificado por eventName) não tiver uma moeda definida, esta 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

create

Cria um evento principal.

delete

Exclui um evento principal.

get

Recuperar um único evento principal.

list

Retorna uma lista de eventos principais na propriedade pai especificada.

patch

Atualiza um evento principal.