Пагинация
Разделение ответа на несколько страниц. Доступно во всех версиях API Adfox. Пагинация используется во всех запросах.
Формат запроса
Пагинация настраивается с помощью 2 параметров:
https://adfox.yandex.ru/api/v1
? [offset=<integer>]
& [limit=<integer>]
|
Количество объектов в списке, которые необходимо пропустить. Значение по умолчанию: 0. |
|
Количество объектов на одной странице. Значение по умолчанию: 10. Максимальное значение: 1000. |
Внимание
Пагинация используется во всех запросах. Если в запросе не указано значение limit
, применится значение по умолчанию — 10.
Пример
Запрос списка всех кампаний, где на каждой странице будет выведено по 25 кампаний.
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=0&limit=25
Запрос для просмотра второй страницы с 25 кампаниями:
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=25&limit=25
Формат ответа
В ответе на запрос добавлен блок пагинации с информацией о том, сколько всего страниц, на какой странице сейчас находится ответ, общее количество объектов, сколько объектов выведено на данной странице и ссылки на первую, предыдущую, следующую и последнюю страницы.
Пример блока пагинации в ответе:
...
<links>
<first>
<![CDATA[
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=0&limit=5
]]>
</first>
<prev>
<![CDATA[
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=0&limit=5
]]>
</prev>
<next>
<![CDATA[
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=10&limit=5
]]>
</next>
<last>
<![CDATA[
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign&offset=80&limit=5
]]>
</last>
<limit>5</limit>
<offset>5</offset>
<total_pages>17</total_pages>
<page>2</page>
<total_rows>85</total_rows>
<rows>5</rows>
...
Параметры блока пагинации
|
Ссылка на первую страницу. |
|
Ссылка на предыдущую страницу. |
|
Ссылка на следующую страницу. |
|
Ссылка на последнюю страницу. |
|
Общее число страниц. |
|
Номер страницы, на которой сейчас находимся. |
|
Общее количество объектов. |
|
Сколько объектов выведено на странице. |
Количество объектов в списке, которые необходимо пропустить.
Значение по умолчанию: 0.
Количество объектов на одной странице.
Значение по умолчанию: 10. Максимальное значение: 1000.