Данные объявления

Вариант без передачи текста ответа LLM: возвращает только объект объявления. Подходит, если ответ бота содержит пользовательские данные, которые вы не хотите передавать Sidekick.

Несколько форматов доступны через необязательное поле accept_formats в теле запроса. Передайте ["text", "image"] , чтобы получать рекламу с изображениями. Поле ответа ad.format показывает полученный формат. Клиенты, которые не передают accept_formats , продолжают получать только текст. Структура ответа сохраняется с добавлением поля format: "text" .

Авторизация

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Тот же Bearer-токен, что и для /api/v1/ad. Создайте ключи в настройках паблишера.

Тело запроса

* Обязательные поля.

Пример запроса — несколько форматов

{
  "user_id": 12345,
  "platform_id": "plt_abc",
  "language_code": "en",
  "accept_formats": [
    "text",
    "image"
  ],
  "parse_mode": "HTML"
}

Ответ — текстовая реклама

{
  "has_ad": true,
  "impression_id": "imp_a8f3d2c1e9b7",
  "ad": {
    "format": "text",
    "ad_text": "💡 Try Cursor — AI editor for developers",
    "ad_url": "https://sidekick-ads.com/api/v1/click/imp_a8f3d2c1e9b7",
    "button_text": "Try Cursor →",
    "button_url": "https://sidekick-ads.com/api/v1/click/imp_a8f3d2c1e9b7",
    "ad_text_formatted": "<a href=\"https://sidekick-ads.com/api/v1/click/imp_a8f3d2c1e9b7\">💡 Try Cursor — AI editor for developers</a>"
  }
}

ad_text — исходный текст кампании. ad_text_formatted присутствует, только если parse_mode задан в запросе, и содержит экранированный текст с гиперссылкой для выбранного режима разметки. ad_url и button_url сейчас совпадают, но сохранены отдельно для совместимости с будущими изменениями.

Ответ — реклама с изображением

{
  "has_ad": true,
  "impression_id": "imp_xxx",
  "ad": {
    "format": "image",
    "ad_text": "Try Sidekick",
    "ad_text_formatted": "<a href=\"https://sidekick-ads.com/api/v1/click/imp_xxx\">Try Sidekick</a>",
    "ad_url": "https://sidekick-ads.com/api/v1/click/imp_xxx",
    "button_text": "Try",
    "button_url": "https://sidekick-ads.com/api/v1/click/imp_xxx",
    "media_type": "photo",
    "image_url": "https://cdn.example.com/sidekick/ad.jpg",
    "image_mime": "image/jpeg"
  }
}

У рекламы с изображением те же основные поля, что и у текстовой: ad_text, ad_text_formatted, ad_url, button_text, button_url. Проверяйте format === "image" , когда нужно отправить медиа: прочитайте image_url и media_type, затем используйте sendPhoto (для "photo") или sendAnimation (для "animation", применяется для GIF и MP4 без звука). Используйте ad_text_formatted как подпись Telegram, чтобы добавить кликабельную ссылку рядом с inline-кнопкой.

Ответ — рекламы нет

{ "has_ad": false, "impression_id": null, "ad": null }

Если подходящей кампании нет или ещё не достигнута нужная частота показа, оба поля равны null. Отправьте исходный ответ LLM без изменений.

Ответы с ошибкой