REST Resource: properties.keyEvents

Источник: KeyEvent

Ключевое событие в сервисе Google Analytics.

JSON-представление 
{
  "name": string,
  "eventName": string,
  "createTime": string,
  "deletable": boolean,
  "custom": boolean,
  "countingMethod": enum (CountingMethod),
  "defaultValue": {
    object (DefaultValue)
  }
}
Поля
name

string

Только вывод. Имя ресурса этого ключевого события. Формат: properties/{property}/keyEvents/{keyEvent}

eventName

string

Неизменяемый параметр. Название события для данного ключевого события. Примеры: 'click', 'purchase'.

createTime

string ( Timestamp format)

Только вывод. Время создания этого ключевого события в свойстве.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

deletable

boolean

Только для вывода. Если установлено значение true, это событие можно удалить.

custom

boolean

Только для вывода. Если установлено значение true, это ключевое событие относится к пользовательскому событию. Если установлено значение false, это ключевое событие относится к событию по умолчанию в Google Analytics. События по умолчанию обычно имеют особое значение в Google Analytics. События по умолчанию обычно создаются для вас системой Google Analytics, но в некоторых случаях могут быть созданы администраторами объектов недвижимости. Пользовательские события учитываются в максимальном количестве пользовательских ключевых событий, которые могут быть созданы для одного объекта недвижимости.

countingMethod

enum ( CountingMethod )

Обязательно. Метод, с помощью которого будут подсчитываться ключевые события по нескольким событиям в рамках одной сессии.

defaultValue

object ( DefaultValue )

Необязательный параметр. Определяет значение/валюту по умолчанию для ключевого события.

Метод подсчета

Метод, с помощью которого будут подсчитываться ключевые события по нескольким событиям в рамках одной сессии.

Перечисления
COUNTING_METHOD_UNSPECIFIED Метод подсчета не указан.
ONCE_PER_EVENT Каждый экземпляр события считается ключевым событием.
ONCE_PER_SESSION Экземпляр события считается ключевым событием не более одного раза за сессию для каждого пользователя.

DefaultValue

Определяет значение/валюту по умолчанию для ключевого события.

JSON-представление 
{
  "numericValue": number,
  "currencyCode": string
}
Поля
numericValue

number

Обязательно. Этот параметр будет использоваться для заполнения значения параметра "value" для всех случаев возникновения данного ключевого события (указанного eventName), где этот параметр не задан.

currencyCode

string

Обязательно. Если для данного ключевого события (указанного в eventName) не задана валюта, по умолчанию будет использоваться данная валюта. Должен быть указан код валюты в формате ISO 4217.

Дополнительную информацию см. на странице https://en.wikipedia.org/wiki/ISO_4217 .

Методы

create

 Создает ключевое событие.

delete

 Удаляет ключевое событие.

get

 Получить отдельное ключевое событие.

list

 Возвращает список ключевых событий в указанном родительском свойстве.

patch

 Обновляет ключевое событие.