Валидация параметров события
События, которые отправляются в eSputnik, должны соответствовать определенным требованиям. В противном случае сценарии могут не срабатывать, важные данные — теряться, и т. д.
eSputnik позволяет устанавливать необходимые параметры события, предупреждает об ошибках и показывает, что именно и как нужно исправить.
Установка необходимых параметров события
Задайте необходимые параметры, без которых система не будет принимать события.
Шаги по настройке валидации структуры события:
- Создайте новое событие или зайдите в настройки уже созданного (инструкция по созданию событий).
- Активируйте свитчер “Валидировать параметры”.
- Кликните “+ Добавить параметр”.
- Введите название параметра в соответствующее поле и при необходимости установите флажок “Обязательный параметр”.
- При необходимости добавьте другие параметры, затем нажмите “Редактировать“.
Валидация параметров событий
Валидируйте параметры и структуру события с помощью API-метода Generate event. Укажите параметры в массиве params.
В ответ на невалидное событие отправляется сообщение об ошибке 400 bad request и требования к событию.
Пример ответа:
The event should have the following params: [ { "name": "EmailAddress", "required": true }, { "name": "Phone Number", "required": false }, { "name": "Name", "required": false } ]
JSON
Типы событий с включенной валидацией параметров обозначаются иконкой проверки.
Требования к событиям
eventTypeKey
Параметр | Тип | Обязательный/Опциональный | Описание | Требования |
eventTypeKey | String | Обязательный | Уникальный идентификатор типа события, например, PageViewed. После первого запроса он появится в вашем аккаунте, и вы сможете увидеть его в разделе “Триггеры” → “Типы событий”. | 1. Можно использовать любые символы, кроме < ; ’ \ / | " ` ' ^ ? ! , > 2. Макс. длина: 100 символов. |
eventParams
eventParams содержат два типа информации:
- Идентификаторы контактов (обязательно). Пример:
{ "name": "externalCustomerId", "value": "a7c9f9b8-d3a2-401c-8b93-7f3d4f91bfa2" }
JSON
- Дополнительные параметры события (опционально). Пример:
{ "name": "cartId", "value": "CART12345" }
JSON
Параметр | Тип | Обязательный/Опциональный | Описание | Требования |
Идентификаторы контактов | String | Обязательный | eventParams должны содержать идентификатор контакта для определения уникальности события. Приоритет параметров следующий: Событие должно содержать хотя бы один из этих параметров. Рекомендуемый параметр: externalCustomerId. | 1. Можно использовать любые символы, кроме < ; ’ \ / | " ` ' ^ ? ! , > 2. Макс. длина: 300 символов. |
Дополнительные параметры события | Массив объектов | Опциональный | Массив объектов — списков с парами “ключ-значение”, содержащих параметры события. | 1. Массив параметров может быть пустым: [] Но если массив не пуст, поля name и value должны передаваться в объекте массива. 2. Значение параметра name должно быть уникальным. 3. Макс. длина значения параметра name: 100 символов. |