Позволяет получить список активных предложений (офферов) для данного пользователя, в том числе информацию по всем активным «раздачам слонов», которые были получены при активации купонов.
ID функции
r_user_offers
Кто может вызывать
Авторизованный пользователь.
Авторизованное приложение.
Принимаемые параметры
campaign – необязательный параметр. Номер кампании, офферы которой нужно выдать. Если передан только номер кампании, то выдаются все записи офферов этой кампании для данного пользователя, вне зависимости от значения added в записях кампании;
added – необязательный параметр. Время добавления оффера в формате «ГГГГ-ММ-ДД ЧЧ:ММ:СС». Офферы запрошенной кампании, добавленные ранее этого времени – игнорируются;
slonogifts – необязательный параметр, который определяет нужно ли выводить данные об активных «раздачах слонов» для текущего пользователя;
currency – идентично одноименному параметру из запроса r_search_arts. Необязательный параметр.
Возвращаемые значения
user_offers – массив из объектов-офферов. Каждый оффер содержит следующие элементы:
- added – дата получения пользователем оффера в формате «ГГГГ-ММ-ДД ЧЧ:ММ:СС»;
- valid_till_timestamp – время, до которого действителен оффер (в формате POSIX-времени);
- last_view_timestamp – для Абонемента (campaign=11), время, ближайшего действия: уведомления, продления и т.п. (в формате POSIX-времени);
- grace_period – время начала грейс-периода для офферов Абонемента (опционально) (Число в формате POSIX-времени);
- campaign – номер кампании. Строка. Расшифровку номера уточняйте у менеджера проекта;
- xml – XML-код, связанный с данным оффером. Если при запросе в параметре currency была передана валюта отличная от рублей, то в xml вернется текущая цена present_price в запрошенной валюте. Если параметр currency не был передан, present_price вернется в рублях;
- id – уникальный номер оффера. Строка, может содержать специальные символы;
- class – номер класса оффера. Строка;
- views_count – количество зарегистрированных просмотров (актуально для офферов, которые показываются ограниченное число раз);
user_slonogifts – массив с информацией о доступных пользователю «раздачах слонов». Возвращается только в случае, если в запросе был передан параметр slonogifts=1. Каждая «раздача слонов» содержит следующие элементы:
- id – идентификатор подборки;
- items_left – количество книг, которое осталось доступным пользователю для выбора.
Возможные ошибки
error_code | error_message | Описание |
|---|---|---|
101001 | invalid values in request | В запросе передан некорректный параметр или передано недопустимое значение параметра |
Пример запроса на сервер
{
"app": "1",
"time": "2019-12-12T18:56:39+03:00",
"sha": "b79d8e9993d20da6abe78838d3c7fbf640a4c52956569bef3c685d3453316b5c",
"sid": "7bad5f2fb752ee957a4ab74aaac7711g",
"requests": [
{
"func": "r_user_offers",
"id": "user_offers"
{
"slonogifts": "1",
}
}
]
}
Пример ответа сервера
{
"success" : true,
"time" : "2019-12-12T18:56:39+03:00",
"user_offers" : {
"success" : true,
"user_offers" : [
{
"added" : "2019-03-20 18:46:22",
"campaign" : "999",
"class" : "999",
"id" : "999_4658",
"valid_till_timestamp" : 1560872782,
"views_count" : 0,
"xml" : "<slonogift collection=\"4658\" items_left=\"2\" />"
},
{
"added" : "2017-08-18 13:34:16",
"campaign" : "999",
"class" : "999",
"id" : "999_18689",
"valid_till_timestamp" : 1510828456,
"views_count" : 0,
"xml" : "<slonogift collection=\"18689\" items_left=\"1\" />"
},
{
"added" : "2017-08-08 17:07:56",
"campaign" : "999",
"class" : "999",
"id" : "999_18646",
"valid_till_timestamp" : 1509977276,
"views_count" : 0,
"xml" : "<slonogift collection=\"18646\" items_left=\"1\" />"
},
{
"added" : "2017-07-19 13:04:05",
"campaign" : "999",
"class" : "999",
"id" : "999_17777",
"valid_till_timestamp" : 1508234645,
"views_count" : 0,
"xml" : "<slonogift collection=\"17777\" items_left=\"1\" />"
},
],
"user_slonogifts" : [
{
"id" : "4658",
"items_left" : "2",
},
{
"id" : "18689",
"items_left" : "1",
},
{
"id" : "18646",
"items_left" : "1",
},
{
"id" : "17777",
"items_left" : "1",
},
]
}
}
Пример ответа сервера с ошибкой
{
"success" : true,
"time" : "2019-12-12T20:16:13+03:00",
"user_offers" : {
"error_code" : 101001,
"error_message" : "invalid values in request",
"success" : false
}
}