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

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

eventName

string

Неизменяемый. Имя события для этого ключевого события. Примеры: «кликнуть», «купить».

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, это ключевое событие относится к событию по умолчанию в GA. События по умолчанию обычно имеют особое значение в Google Analytics. События по умолчанию обычно создаются для вас системой GA, но в некоторых случаях их могут создавать администраторы объектов. Пользовательские события учитываются при расчете максимального количества пользовательских событий клавиш, которые можно создать для каждого свойства.

countingMethod

enum ( CountingMethod )

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

defaultValue

object ( DefaultValue )

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

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

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

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

Значение по умолчанию

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

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

number

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

currencyCode

string

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

См . https://en.wikipedia.org/wiki/ISO_4217 для получения дополнительной информации.

Методы

create

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

delete

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

get

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

list

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

patch

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