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 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 normalmente 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

create

Cria um evento principal.

delete

Exclui um evento principal.

get

Extrair um único evento de tecla.

list

Retorna uma lista de eventos de chave na propriedade pai especificada.

patch

Atualiza um evento principal.