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 do evento principal. Exemplos: "click", "purchase"

createTime

string (Timestamp format)

Apenas saída. O horário em que esse evento principal foi criado na propriedade.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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 "true", esse evento poderá ser excluído.

custom

boolean

Apenas saída. Se for definido como "true", esse evento principal vai se referir a um evento personalizado. Se for definido como "false", esse evento principal vai se referir a um evento padrão no GA. Os eventos padrão geralmente têm um significado especial no GA e são criados automaticamente pelo sistema do GA, mas, em alguns casos, podem ser criados por 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 de contagem de eventos principais 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 de contagem de eventos principais em vários eventos em uma sessão.

Tipos enumerados
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 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. Isso 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 tem uma moeda definida, ela é 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

Recupera um único evento principal.

list

Retorna uma lista de eventos principais na propriedade mãe especificada.

patch

Atualiza um evento principal.