Метод используется для получения списка баннеров в зависимости от запрашивающего приложения (текст или аудио) и/или хоста.

ID функции

r_banners

Кто может вызывать

Любой пользователь.
Авторизованное приложение.

Принимаемые параметры

size – параметр, указывающий формат устройства, на которое установлено приложение. Возможные значения:

  • phn – приложение установлено на телефон;
  • tblt – приложение установлено на планшет;

priority – параметр, указывающий приоритет выдачи баннеров. Если этот параметр не передан, то в ответе будут только баннеры по хосту. Возможные значения:

  • host – показывать только баннеры с настройкой указанного хоста, если они есть. Если таких нет, выбираем баннеры для указанного приложения;
  • app – показывать только баннеры с настройкой для приложения, если они есть. Если таких нет, выбираем баннеры с запрошенного хоста;
  • all – показывать все баннеры: и для хоста, и для приложения.

Возвращаемые значения

banners* – массив, содержащий список баннеров для данного приложения. Содержит следующие параметры:

  • id – ID баннера;
  • type – тип контента, на который ссылается баннер. Возможные значения:
    • author – баннер на книги автора;
    • book – баннер на книгу;
    • collection – баннер на коллекцию;
    • sequence – баннер на серию;
    • application – баннер на другое приложение;
    • ad – рекламный баннер;
  • content_id – ID контента, на который ссылается баннер;
  • image – URL картинки для баннера;
  • priority – параметр, указывающий приоритет выдачи баннеров (число). Чем выше значение этого атрибута, тем выше приоритет выдачи;
  • host – хост, на котором будет показан баннер. Соответствует переданному значению в запросе.

Если для приложения не было найдено ни одного баннера, то массив banners будет пустым.

Возможные ошибки

error_code

error_message

Описание

101133

Указан некорректный размер

Недопустимое значение параметра size

Пример запроса на сервер

{
  "app": "1",
  "time": "2017-07-24T15:46:41+03:00",
  "sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c",
  "sid": "7bad5f2fb752ee957a4ab74aaac7711g",
  "requests": [
    {
      "func": "r_banners",
      "id": "banners",
      "param": {
        "size": "phn",
        "priority": "all"
      }
    }
  ]
}

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

{
  "time": "2017-07-24T15:46:41+03:00",
  "banners": {
    "banners": [
      {
        "priority": "2",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/6196_phone.jpg",
        "content_id": "24431425",
        "type": "book",
        "id": "6196"
      },
      {
        "content_id": "24426353",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/6172_phone.jpg",
        "priority": "1",
        "id": "6172",
        "type": "book"
      },
      {
        "priority": "0",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5426_phone.png",
        "content_id": "15968",
        "host": "3494",
        "type": "collection",
        "id": "5426"
      },
      {
        "priority": "0",
        "content_id": "16262",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5447_phone.jpg",
        "type": "collection",
        "id": "5447"
      },
      {
        "host": "3494",
        "type": "collection",
        "id": "5653",
        "priority": "0",
        "content_id": "16488",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5653_phone.png"
      },
      {
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5695_phone.png",
        "content_id": "16495",
        "priority": "0",
        "id": "5695",
        "host": "3494",
        "type": "collection"
      },
      {
        "priority": "0",
        "content_id": "16510",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5737_phone.png",
        "type": "collection",
        "host": "3494",
        "id": "5737"
      },
      {
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5822_phone.png",
        "content_id": "24149382",
        "priority": "0",
        "id": "5822",
        "type": "book"
      },
      {
        "priority": "0",
        "content_id": "16872",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5826_phone.png",
        "type": "collection",
        "id": "5826"
      },
      {
        "id": "5857",
        "host": "3494",
        "type": "book",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5857_phone.png",
        "content_id": "24149430",
        "priority": "0"
      },
      {
        "content_id": "16891",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/5894_phone.png",
        "priority": "0",
        "id": "5894",
        "type": "collection",
        "host": "3494"
      },
      {
        "priority": "0",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/6153_phone.jpg",
        "content_id": "24462286",
        "type": "book",
        "id": "6153"
      },
      {
        "image": "http://whub.litres.ru/static/pr/banners_mobile/6160_phone.jpg",
        "content_id": "24434433",
        "priority": "0",
        "id": "6160",
        "type": "book"
      },
      {
        "id": "6278",
        "type": "collection",
        "content_id": "18145",
        "image": "http://whub.litres.ru/static/pr/banners_mobile/6278_phone.jpg",
        "priority": "0"
      }
    ],
    "success": true
  },
  "success": true
}