#
Получение рекламных кампаний
Для получения рекламных кампаний для определенного плейсмента необходимо отправить запрос /choose
. В запросе должен быть указан идентификатор плейсмента.
Подробнее ознакомиться с процессом создания кампаний можно в следующей статье: Рекламные кампании
#
choose: запрос кампаний
API reference
#
Пояснения к параметрам запроса
Implicit Pageview (options.isImplicitPageview): Добавьте этот параметр, чтобы передать информацию о просмотре страницы вместе с запросом.
Если вы будете использовать динамические фильтры, предварительно укажите их в Dynamic filter fields (Поля для использования в динамических фильтрах) в настройках фида.
curl --request POST
--url 'https://srv.gravityads.ai/choose'
--header 'content-type: application/json'
--header 'Authorization: Bearer your-api-key'
--data '
{{
"sec": "646689c3404f91f26103faa6",
"user": {
"uid": "6655ad2d98276864840da6e3"
},
"session": {
"ses": "b368b83f-0cc6-4bc3-aa98-31c1047099fa"
},
"ctx": {
"type": "CATEGORY",
"data": [
"Parent category",
"Sub category"
],
"lng": "msk",
"url": "http://site.ru/cat/1"
},
"device": {
"user_time": "2019-08-24T14:15:22Z",
"ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
"ip": "127.0.0.1"
},
"data": [
{
"placementId": "646689c3404f91f26103faa6",
"options": {
"isImplicitImpression": true,
"rtRule": []
}
}
]
}'
#
Обработка ответа
- В ответе на
choose
запрос товарной кампании возвращаются только те параметры товаров, которые указаны в Product Fields (Поля товара) в настройках фида. Для изменения списка указанных параметров обратитесь к вашему персональному менеджеру.
{
"choices": [
{
"id": "646689c3404f91f26103faa6",
"adsets": [
{
"adset_id": "67051a995eadbaa5390785f5",
"test_id": "67051a995eadbaa5390785f8",
"creative_id": "67051a995eadbaa5390785f6",
"campaign_id": "67051a995eadbaa5390785f4",
"ad_sec": "67051a995eadbaa5390785f4",
"ad_account": "67051a995eadbaa5390785f2",
"erid": "2a41b9a9-0e98-44ac-88ce-3744d1c226e4",
"strategy_id": "67051a995eadbaa5390785f9",
"feed_id": "67051a995eadbaa5390785f7",
"fallback": true,
"pid": 10,
"data": {
"custom": {}
},
"payload": {
"data": {
"slots": [
{
"sku": "123",
"productData": {
"categories": [
"Category A"
],
"price": "1000",
"url": "http://site.ru/product/123"
},
"strId": 1,
"slotId": "670519f27352da07900f3654:67051a995eadbaa5390785f5:67051a995eadbaa5390785f6:65c4cdc8d9123b0196017bf6:65c4dcc14738a9b1c60ef703:0:309310:0:3:0",
"fallback": false
},
{
"sku": "124",
"productData": {
"categories": [
"Category B"
],
"price": "1005",
"url": "http://site.ru/product/123"
},
"strId": 2,
"slotId": "670519f27352da07900f3654:67051a995eadbaa5390785f5:67051a995eadbaa5390785f6:65c4cdc8d9123b0196017bf6:65c4dcc14738a9b1c60ef703:0:309310:0:3:0",
"fallback": true
}
]
}
}
}
]
}
]
}
В Postman содержится больше примеров использования параметров
#
Обработка ошибок
- Установите таймаут для ожидания ответа от сервера.
- Если полученный ответ имеет статус, отличный от
200
, выполните одно из следующих действий:- Не отображайте ничего.
- Отобразите заглушку, например, стандартный баннер или предустановленный набор продуктов в виджете.
#
Лимиты по количеству запросов