Загрузка офлайн событий в систему Target Ads
Шаг 1. Авторизация
Для взаимодействия с API системы используется метод авторизации через токен типа Bearer. Чтобы авторизовать запрос, нужно включить в заголовок Authorization токен в следующем формате: Bearer <авторизационный токен>.
Чтобы получить авторизационный токен, выполните следующие шаги:
Для взаимодействия с API системы используется метод авторизации через токен типа Bearer. Чтобы авторизовать запрос, нужно включить в заголовок Authorization токен в следующем формате: Bearer <авторизационный токен>.
Чтобы получить авторизационный токен, выполните следующие шаги:
- Войдите в личный кабинет на сайте.
- Перейдите в раздел "Настройки".
- Найдите вкладку "API", где и сможете сгенерировать новый токен для авторизации.
Шаг 2. Событийная загрузка
Если желаете отправить отдельное событие, следует использовать метод событийной загрузки. Для этого отправьте POST-запрос на следующий URL:
https://eye.targetads.io/api/project/event/upload?pid=<id проекта>
В теле запроса необходимо передать данные в формате JSON с информацией о событии.
Если желаете отправить отдельное событие, следует использовать метод событийной загрузки. Для этого отправьте POST-запрос на следующий URL:
https://eye.targetads.io/api/project/event/upload?pid=<id проекта>
В теле запроса необходимо передать данные в формате JSON с информацией о событии.
[{
"uid": String,
"edttm": timestamp,
"event_type": String,
"event_category": String,
"event_name": String,
"event_value": Float32,
"cp": {String, String}
},
{
"uid": String,
"edttm": timestamp,
"event_type": String,
"event_category": String,
"event_name": String,
"event_value": Float32,
"cp": {String, String}
}]Если загрузка события прошла успешно, сервер вернёт код ответа HTTP 200.
В случае возникновения ошибки при обработке запроса сервер вернёт код ответа HTTP 400. Также в теле ответа будет представлен JSON-объект, содержащий текст ошибки в поле "error".
Шаг 3. Пакетная загрузка
Для пакетной загрузки оффлайн событий следует отправить POST-запрос на следующий URL: https://eye.targetads.io/api/project/event/upload/batch?pid=<id проекта>
Тело запроса должно содержать JSON, в котором указывается массив объектов, соответствующих формату, используемому для событийной загрузки.
В случае возникновения ошибки при обработке запроса сервер вернёт код ответа HTTP 400. Также в теле ответа будет представлен JSON-объект, содержащий текст ошибки в поле "error".
Шаг 3. Пакетная загрузка
Для пакетной загрузки оффлайн событий следует отправить POST-запрос на следующий URL: https://eye.targetads.io/api/project/event/upload/batch?pid=<id проекта>
Тело запроса должно содержать JSON, в котором указывается массив объектов, соответствующих формату, используемому для событийной загрузки.
Кол-во объектов не должно превышать 1000 шт.
В случае успешной загрузки всех событий система возвращает код ответа HTTP 200 и JSON-объект, где количество успешно загруженных событий указывается в поле items_upload.
Если не удалось загрузить ни одного события, сервер вернёт код ответа HTTP 400, а также JSON-объект с описанием ошибки в поле "error".
Когда загрузилась только часть из отправленных событий, ответ сервера будет с кодом HTTP 200. В теле ответа будет JSON-объект, содержащий детали по каждому из событий, включая информацию о тех, которые не были загружены.
В случае успешной загрузки всех событий система возвращает код ответа HTTP 200 и JSON-объект, где количество успешно загруженных событий указывается в поле items_upload.
Если не удалось загрузить ни одного события, сервер вернёт код ответа HTTP 400, а также JSON-объект с описанием ошибки в поле "error".
Когда загрузилась только часть из отправленных событий, ответ сервера будет с кодом HTTP 200. В теле ответа будет JSON-объект, содержащий детали по каждому из событий, включая информацию о тех, которые не были загружены.
Шаг 4. Ecommerce-данные
Если требуется отправить ecommerce-параметры по события, следует использовать метод событийной загрузки. Для этого отправьте POST-запрос на следующий URL:
https://eye.targetads.io/api/project/event/upload?pid=<id проекта>
В теле запроса необходимо передать данные в формате JSON с ecommerce-параметрами о событии.
Если требуется отправить ecommerce-параметры по события, следует использовать метод событийной загрузки. Для этого отправьте POST-запрос на следующий URL:
https://eye.targetads.io/api/project/event/upload?pid=<id проекта>
В теле запроса необходимо передать данные в формате JSON с ecommerce-параметрами о событии.
[{
"uid": String,
"edttm": Timestamp,
"event_type": String,
"event_category": String,
"event_name": String,
"event_value": Float32,
"ecommerce": {
"type": String,
"id": String,
"quantity": Int,
"amount": Float32
},
"ecommerce_items": {
"id": [
String,
String
],
"title": [
String,
String
],
"category1": [
String,
String
],
"category2": [
String,
String
],
"brand": [
String,
String"
],
"variant": [
String,
String
],
"quantity": [
Int,
Int
],
"price": [
Float32,
Float32
]
}
}]Кол-во объектов не должно превышать 1000 шт.
В случае успешной загрузки всех событий система возвращает код ответа HTTP 200 и JSON-объект, где количество успешно загруженных событий указывается в поле items_upload.
Если не удалось загрузить ни одного события, сервер вернёт код ответа HTTP 400, а также JSON-объект с описанием ошибки в поле "error".
Когда загрузилась только часть из отправленных событий, ответ сервера будет с кодом HTTP 200. В теле ответа будет JSON-объект, содержащий детали по каждому из событий, включая информацию о тех, которые не были загружены.
В случае успешной загрузки всех событий система возвращает код ответа HTTP 200 и JSON-объект, где количество успешно загруженных событий указывается в поле items_upload.
Если не удалось загрузить ни одного события, сервер вернёт код ответа HTTP 400, а также JSON-объект с описанием ошибки в поле "error".
Когда загрузилась только часть из отправленных событий, ответ сервера будет с кодом HTTP 200. В теле ответа будет JSON-объект, содержащий детали по каждому из событий, включая информацию о тех, которые не были загружены.