Импорт аудитории

Метод позволяет импортировать список пользователей в CDP.

Производительность

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

Импорт обрабатывается в фоне. После запроса вы получите статус 200 OK. Результат импорта будет выведен в разделе системных логов после окончания обработки.

Параметры

Параметр	Тип	Обязателен?	Описание
shop_id	String	Да	API-ключ
shop_secret	String	Да	Секретный API-ключ
audience	Array	Да	Массив объектов пользователей
segment_id	Integer	Нет	Сегмент, в который нужно загрузить аудиторию. Если не указан, то аудитория загружается без привязки к сегменту

Структура объекта пользователя:

Важно

В записи о пользователе должен быть хотя бы один из идентификаторов: email, phone, loyalty_id, external_id. Записи без идентификаторов будут игнорироваться.

Параметр	Тип	Обязателен?	Описание
email*	String	Да	Email клиента
phone*	String	Да	Телефон клиента в формате 7XXXXXXXXXX
loyalty_id*	String	Да	Идентификатор участника внешней программы лояльности. Не используется для программы лояльности REES46
external_id*	String	Да	Идентификатор клиента в вашей базе данных
fb_id	String	Нет	Facebook ID клиента
vk_id	String	Нет	VK ID клиента
telegram_id	String	Нет	Telegram ID клиента
loyalty_card_location	String	Нет	Код локации (из товарного фида), в которой была выдана карта внешней программы лояльности
loyalty_status	String	Нет	Уровень участника внешней программы лояльности
loyalty_bonuses	Integer	Нет	Бонусный баланс участника внешней программы лояльности
loyalty_bonuses_to_next_level	Integer	Нет	Сколько бонусов осталось до следующего уровня во внешней программе лояльности
gender	String	Нет	Пол клиента m или f
location	String	Нет	Код локации (из товарного фида), в которой находится клиент
first_name	String	Нет	Имя
middle_name	String	Нет	Отчество
last_name	String	Нет	Фамилия
age	Integer	Нет	Возраст в годах
birthday	Date	Нет	Дата рождения в SQL формате: YYYY-MM-DD
bought_something	Bool	Нет	Флаг, что пользователь что-либо когда-либо покупал
kids	Array	Нет	Список объектов детей клиента
auto	Array	Нет	Список объектов автомобилей клиента
email_bulk	Boolean	Нет	Подписан на массовые email рассылки
email_chain	Boolean	Нет	Подписан на триггерные email рассылки
email_transactional	Boolean	Нет	Подписан на транзакционные email рассылки
sms_bulk	Boolean	Нет	Подписан на массовые SMS рассылки
sms_chain	Boolean	Нет	Подписан на триггерные SMS рассылки
sms_transactional	Boolean	Нет	Подписан на транзакционные SMS рассылки
mobile_token	String	Нет	Мобильный push-токен (ios, android). Нет смысла импортировать токены из других платформ, т.к. токены подписаны приватным сертификатом внешней платформы и отправка без этого сертификата работать не будет
mobile_token_platform	String	Нет	Тип платформы мобильного push токена ios для APN и android для Firebase

Идентификаторы

Параметры, отмеченные [*] - обязателен хотя бы один из них.

Кастомные свойства пользователей

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

Объект ребенка:

Параметр	Тип	Описание
gender	String	Пол ребенка: m или f
birthday	Date	Дата рождения ребенка в SQL формате: YYYY-MM-DD

Объект автомобиля:

Параметр	Тип	Описание
brand	String	Производитель автомобиля
model	String	Модель автомобиля
vds	String	VDS/VIN номер

Запрос

Пример запроса:

curl -i -X POST -H "Content-Type: application/json" --data-binary "@data.json" https://api.rees46.ru/import/audience

Тело запроса:

{
  "shop_id": "1234567890",
  "shop_secret": "0987654321",
  "segment_id": 123,
  "audience": [
    {
      "email": "test@example.com",
      "loyalty_id": "123454321",
      "phone": "19991005000",
      "external_id": "998877",
      "fb_id": "",
      "vk_id": "",
      "telegram_id": "",
      "loyalty_card_location": "",
      "loyalty_status": "VIP",
      "loyalty_bonuses": 3000,
      "loyalty_bonuses_to_next_level": 70000,
      "gender": "",
      "location": "",
      "first_name": "Jane",
      "last_name": "Smith",
      "age": "",
      "birthday": "",
      "bought_something": true,
      "email_bulk": true,
      "email_chain": true,
      "email_transactional": true,
      "sms_bulk": true,
      "sms_chain": true,
      "sms_transactional": true,
      "mobile_token": "TOKEN",
      "mobile_token_platform": "PLATFORM",
      "auto": [
        {
          "brand": "Mini",
          "model": "Countryman",
          "vds": "1234567"
        },
        {
          "brand": "Toyota",
          "model": "Corolla",
          "vds": "987655431"
        }
      ],
      "kids": [
        {
          "birthday": "2014-06-03",
          "gender": "f"
          },
        {
          "birthday": "2017-04-01",
          "gender": "m"
        }
      ]
    }
  ]
}

Ответ

Пример ответа сервера:

{
  "status": "success"
}

В случае ошибки ответ будет в формате:

{
  "status": "error",
  "payload": {
    "message": "Shop not found"
  }
}