--- metadata: - name: generator content: Diplodoc Platform v5.50.1 alternate: - https://yandex.com/dev/adfox/doc/en/v.1/pagination.md - https://yandex.com/dev/adfox/doc/ru/v.1/pagination.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/adfox/doc/ru/llms.txt # Пагинация Разделение ответа на несколько страниц. Доступно во всех версиях API Adfox. Пагинация используется во всех запросах. ## Формат запроса {#section_kjl_g1p_qjb} Пагинация настраивается с помощью двух параметров: ``` https://adfox.yandex.ru/api/v1 ? [[offset](*offset)=] & [[limit](*limit)=] ``` #| || `offset` | Количество объектов в списке, которые необходимо пропустить. {% include notitle [Значение по умолчанию](../_includes/shorts.md#defaultzero) %} || || `limit` | Количество объектов на одной странице. Значение по умолчанию: `10`. Максимальное значение: `1000`. || |# {% note alert %} Пагинация используется во всех запросах. Если в запросе не указано значение `limit`, применится значение по умолчанию — `10`. {% endnote %} > **Пример** > > Запрос списка всех кампаний, где на каждой странице будет выведено по 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 > ``` > ## Формат ответа В ответе на запрос добавлен блок пагинации с информацией о том, сколько всего страниц, на какой странице сейчас находится ответ, общее количество объектов, сколько объектов выведено на данной странице и ссылки на первую, предыдущую, следующую и последнюю страницы. Пример блока пагинации в ответе: ```xml ... 5 5 17 2 85 5 ... ``` ## Параметры блока пагинации #| || `first` | Ссылка на первую страницу. || || `prev` | Ссылка на предыдущую страницу. || || `next` | Ссылка на следующую страницу. || || `last` | Ссылка на последнюю страницу. || || `total_pages` | Общее число страниц. || || `page` | Номер страницы, на которой сейчас находимся. || || `total_rows` | Общее количество объектов. || || `rows` | Сколько объектов выведено на странице. || |# [*offset]: Количество объектов в списке, которые необходимо пропустить. Значение по умолчанию: `0`. [*limit]: Количество объектов на одной странице. Значение по умолчанию: `10`. Максимальное значение: `1000`. {% included (../_includes/shorts.md) %} ### {#account} Учетная запись пользователя. ### {#actionType} Описание действий посредника-представителя. Допустимые значения: - `0` — Иное. - `1` — Действия в целях распространения рекламы. - `2` — Заключение договоров. - `3` — Коммерческое представительство. ### {#actionObjectID-get} Чтобы получить данные только по одному объекту, укажите его ID. ### {#advertiserID} ID рекламодателя. ### {#advertiserID-read} Читайте также: - [Cоздать рекламодателя](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-add-advertiser.md) - [Получить список рекламодателей](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-list-advertiser.md) ### {#assistantID} ID [ассистента](https://yandex.ru/support/adfox-sites/users/assistant-api.html?lang=ru), которому будет разрешен доступ к объекту в соответствии с его правами доступа. ### {#assistantID-read} Читайте также: - [Создать ассистента](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-add-assistant.md) - [Получить список ассистентов](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-list-assistant.md) ### {#bannerID} ID баннера. ### {#bannername} Название баннера. ### {#bannerTypeID} ID типа баннера. ### {#categoryID} ID категории. ### {#contractID} ID прямого или первичного договора. ### {#criteriaID} ID пользовательской характеристики. ### {#criteriaName} Название пользовательской характеристики. ### {#criteriaTargetingName} Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера. ### {#criteriaReportName} Название отчета по таргетированию по пользовательской характеристике. ### {#format-datetime} Формат передачи даты и времени: `YYYY-MM-DD HH:mm`. ### {#format-date} Формат передачи даты: `YYYY-MM-DD`. ### {#format-time} Формат передачи времени: `HH:mm`. ### {#format-sec} Формат передачи времени с секундами: `HH:mm:ss`. ### {#dateStart} Дата начала открутки. ### {#dateEnd} Дата окончания открутки. ### {#defaultzero} Значение по умолчанию: `0`. ### {#defaultone} Значение по умолчанию: `1`. ### {#defaulthundred} Значение по умолчанию: `100`. ### {#defaultminusone} Значение по умолчанию: `-1`. ### {#defaultCode} Код баннера по умолчанию. ### {#delete} ID объекта, который нужно удалить. ### {#impressionsSmoothTypeID} - `4` — максимальная в начале открутки кампании. Показы распределяются неравномерно: система планирует больше показов на первые дни размещения, а к завершению кампании уменьшает количество показов. Это снижает риск недовыполнения кампании из-за неожиданного ограничения доступного инвентаря в конце срока. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании. ### {#isRegReport} На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы. ### {#markingSelectedRegions} ID региона показа рекламы. ### {#markingCommonDescription} Общее описание объекта рекламирования. ### {#markingSendRegionsType} Регион показа рекламы. ### {#maxImpressionsPerDay} Максимальное количество показов в сутки. ### {#maxImpressionsPerHour} Максимальное количество показов в час. ### {#minUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Минимальное количество показов баннеров одному пользователю. Допустимые значения: целое число от `1` до `2147483647`. Должен быть не больше `maxUniqueImpressions`. ### {#avgUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Целевое среднее количество показов. Средняя частота приоритезирует показы до целевого значения и ограничивает их после — поэтому задается отдельно от минимальной и максимальной. Может быть задан только при отсутствии `minUniqueImpressions` и `maxUniqueImpressions`. ### {#minImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Минимальное количество показов за заданный период. ### {#avgImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Целевое среднее количество показов за заданный период. ### {#maxClicks} Максимальное количество кликов всего. ### {#maxClicksPerDay} Максимальное количество кликов в сутки. ### {#maxClicksPerHour} Максимальное количество кликов в час. ### {#mediaData} Массив с медиаданными креативов. Поле обязательно для заполнения, если не были указаны параметры `textData` и `sendToErir`. URL-ссылка проверяется на доступность перед сохранением. Поле `description` необязательно для заполнения. {% cut "Пример" %} ``` mediaData[]={"url": "https://avatars.mds.yandex.net/get-adfox-content/2462621/221121_adfox_2033661_5594482.379ba05374bcd6b6339273f47b5a1b64.jpeg/optimize.webp", "description": "Text_string"} ``` {% endcut %} ### {#objectID-user} ID значения характеристики. ### {#campaignID} ID кампании. ### {#placeID} ID площадки. ### {#platformType} Допустимые значения: - `0` — приложение; - `1` — сайт; - `2` — информационная система (не используется, deprecated); - `3` — Smart TV; - `4` — HbbTV. ### {#publisherContractID} ID конечного договора. ### {#roles} Роли, в которых может выступать контрагент при заключении договора. Допустимые значения: - `0` — исполнитель; - `1` — заказчик. ### {#sample} {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} ### {#separator-comma} Для передачи списка ID объектов используйте разделитель — запятую. ### {#separator-line} Для передачи нескольких значений используйте разделитель — вертикальную черту `|` без пробелов. ### {#separator-words} Формат записи: - разделитель фраз — запятая; - разделитель слов — пробел или запятая. ### {#subjectType} Сведения о предмете договора. Допустимые значения: - `0` — Иное. - `1` — Договор на распространение рекламы. - `2` — Договор на организацию распространения рекламы. - `3` — Посредничество. - `4` — Представительство. ### {#templateID} ID шаблона баннера. ### {#targetingProfileID} ID [профиля таргетирования](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). ### {#textData} Массив с текстовыми данными креативов. Поле обязательно для заполнения, если не были указаны параметры `mediaData` и `sendToErir`. ### {#values} Допустимые значения: целое число от `1` до `2147483647`. ### {#values-on-off} Допустимые значения: - `on` — включить размещение; - `off` — выключить размещение. ### {#values-0-1} Допустимые значения: - `0` — выключено; - `1` — включено. ### {#values-no-yes} Допустимые значения: - `0` — нет; - `1` — да. ### {#values-code} Допустимые значения: - `0` — HTML; - `1` — JavaScript. ### {#frequencyType} Допустимые значения: - `0` — не задано; - `1` — 1 час; - `2` — 4 часа; - `3` — 6 часов; - `4` — 12 часов; - `5` — сутки; - `6` — неделя; - `7` — месяц; - `8` — другой период; - `9` — 14 дней. ### {#values-all-required} Может содержать русские и латинские буквы, цифры и любые символы. ### {#values-users} Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. ### {#video-duration} Длительность видео в секундах. ### {#uniquePeriodImpressions} Если период частоты показов выбран как `другой период` (`frequencyTypeImpressions`=`8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах. ### {#url} Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы. {% endincluded %}