Данные о событии после установки (Post-Install Event, PIE)

Julia Randall

10/11/2022 22:31

Введение

Эта конечная точка позволяет рекламодателям отправлять Vungle данные о каждом происходящем событии пользовательского уровня. API данных о событиях нацелены на то, чтобы помочь Vungle определить, какие пользователи для вас наиболее ценны. Когда вы отправляете нам информацию о событиях в вашем приложении, Vungle получает возможность оптимизировать ваши кампании, привлекая пользователей, которые наиболее важны для вас.

HTTP-запрос

http://ingest.vungle.com/eventData

POST

Мы поддерживаем POST-запросы со следующими типами содержимого:

application/x-www-form-urlencoded
application/json

Примечание. Vungle рекомендует использовать метод POST с содержимым JSON.

curl -H "Content-Type: application/json" -d '{"data": "myData"}' "http://ingest.vungle.com/eventData"

GET

Мы также поддерживаем GET-запросы с использованием параметров запроса.

curl "http://ingest.vungle.com/eventData?data=myData"

Обязательные параметры

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

Идентификатор устройства

Нам требуется по крайней мере ОДИН идентификатор устройства для каждого события, так что вам не нужно передавать их все.

Параметр	Описание
`device_idfa`	Рекламный идентификатор Apple (IDFA) или сервисов Google Play
`device_mac`	Mac-адрес в каноническом формате (разделитель — дефис или двоеточие)
`device_other_id`	Другой уникальный идентификатор, например идентификатор Android, хэшированные идентификаторы и т. д.

Примечание. Vungle рекомендует использовать device_idfa, где это возможно.

Другие обязательные параметры

Чтобы мы могли принять событие, вам необходимо передать все остальные обязательные параметры.

Параметр	Описание
`vungle_app_id`	Идентификатор приложения, указанный на панели управления Vungle
`trk`	Источник входящего события. При прямой интеграции типа сервер-сервер следует использовать самоидентификатор. В ином случае нужно указать поставщика услуг отслеживания, например tune, kochava, adjust, appsflyer и т. д.
`event_trk_id`	Это должен быть уникальный для события идентификатор. Используется для дедупликации.
`event_id`	Идентификатор события Vungle. Если это событие было выполнено пользователем, подключившимся к вашему приложению в рамках кампании Vungle, идентификатор события был передан вам в трекере просмотров или кликов
`event_name`	Это должна быть строка, которая определяет единое для всех пользователей событие, например tutorial-complete (завершение учебного пособия), level-3 (уровень 3), purchase (покупка) и т. д.

Примеры

Пример тела POST-запроса:

{
  "device_idfa"   : "236A005B-700F-4889-B9CE-99",
  "vungle_app_id" : "myVungleApp",
  "trk"           : "tune",
  "event_trk_id"  : "uniqueID1234",
  "event_name"    : "tutorial-complete"
}

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

curl "http://ingest.vungle.com/eventData?device_idfa=236A005B-700F-4889-B9CE-999EAB2B605D&vungle_app_id=myVungleApp&trk=tune&event_trk_id=uniqueID1234&event_name=tutorial-complete"

Приведенные выше данные будут возвращать ответ «200 OK» и могут служить примерами минимального запроса, который можно отправить Vungle.

Необязательные параметры

Эти параметры не являются обязательными, но позволяют Vungle определить, какие пользователи ценны, так что вам лучше передавать их столько, сколько возможно.

Параметр	По умолчанию	Описание
event_value	Нет	Числовое значение, связанное с событием. Должно соотноситься с другими событиями, которые вы отправляете Vungle. Например, для $4.99 IAP нужно указать 4.99.
`event_currency`	`'usd'`	Если параметр `event_value` определяет явное денежное значение, этот параметр определяет валюту.
`event_iap_event`	`false`	Установите здесь флаг, показывающий, было ли событие покупкой в приложении.
`device_limit_track`	`false`	Логическое значение, показывающее, установлен ли на устройстве параметр limit ad tracking.
`event_datetime`	Отметка времени получения события	Отметка времени, когда произошло событие. Если не указан часовой пояс, предполагается UTC. Отметка времени должны быть в формате ISO 8601.
`device_ip`	Нет	IP-адрес устройства.
`device_make`	Нет	Производитель устройства.
`device_model`	Нет	Модель устройства.
`device_carrier`	Нет	Несущий элемент устройства.
`device_language`	Нет	Код языка устройства в формате ISO 639-1 (2 цифры).
`device_country`	Нет	Код страны исходного IP в формате ISO 3166 (2 цифры).
`device_user_agent`	Нет	Пользовательский агент браузера устройства.
`device_os`	Нет	Номер версии операционной системы.

Примечание. Обратите внимание на параметр event_value и взгляните на значения каждого события. Для Vungle не принципиальны фактические используемые цифры, но значения событий должны соотноситься друг с другом. Vungle постарается максимизировать общую ценность отправляемых вам типов пользователей.

Пример необязательных параметров

{
  "event_currency"      : "usd",
  "event_iap_event"     : true,
  "device_limit_track"  : false,
  "event_datetime"      : "2015-03-15T13:27:36Z",
  "device_ip"           : "201.15.25.11",
  "device_make"         : "samsung",
  "device_model"        : "sm-g900v",
  "device_carrier"      : "verizon",
  "device_language"     : "es",
  "device_country"      : "us",
  "device_user_agent"   : "Mozilla/5.0 (Linux; U; Android 2.2.1; fr-fr; HTC_DesireZ_A7272 Build/FRG83D) AppleWebKit/533.1 (KHTML, like Gecko), Version/4.0 Mobile Safari/533.1",
  "device_os"           : "4.3.2",
  "event_value"         : 1.99
}

Коды ошибок

Мы возвращаем следующие коды:

Код ошибки	Описание
`200`	ОК. Спасибо!
`400`	Плохой запрос. С вашим запросом что-то не так. Скорее всего, вы не указали один из обязательных параметров. Поищите подсказки в содержимом ответа.
`500`	Внутренняя ошибка сервера. У нас проблема с сервером. Повторите попытку позже.
`503`	Служба недоступна. Мы временно отключились для технического обслуживания. Повторите попытку позже.

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

curl "http://ingest.vungle.com/eventData?trk=tune&event_trk_id=uniqueID1234"

вернется ответ следующего вида:

{
  "missing_fields":
  [
    "vungle_app_id",
    "trk",
    "event_trk_id",
    "event_name",
    "device_idfa | device_mac | device_other_id"
  ]
}