auction

Получить информацию о срс-продвижении

Метод API позволяет получить сводку по CPC-продвижению для объявлений агентства: конкуренцию, признак примененного продвижения, остаток дневного лимита и статистику платных просмотров за текущие сутки.

Запрос выполняется в одном из двух режимов:

  • по списку announcementIds;
  • по объявлениям пользователя через userId с пагинацией page и pageSize, если список announcementIds не передан или пуст.

В ответе возвращаются массив announcements, общее число найденных объявлений totalCount и флаг nextPage. Для каждого объявления отдаются агрегированные поля конкуренции, isPromotionApplied, paidViewsCount и amountSpent.

Особенности для клиентов:

  • в режиме списка чужие и несуществующие announcementIds пропускаются;
  • isPromotionApplied учитывает только активную CPC-ставку;
  • в конкуренции учитываются объявления с активной ставкой и ставкой в статусе LimitExceeded;
  • paidViewsCount и amountSpent считаются только за текущий день;
  • поля текущей ставки и статуса ставки отдельно не возвращаются.
post/v1/get-cpc-promotion-competitions/

Request

  • Base URL: https://public-api.cian.ru
  • URL: https://public-api.cian.ru/v1/get-cpc-promotion-competitions/
  • Auth: none declared

Request body

announcementIdsinteger[]

Список конкретных объявлений; если передан, ручка работает в режиме "по списку".

pageinteger

Номер страницы; нужен если announcementIds не передан или пустой.

pageSizeinteger

Размер страницы в режиме пагинации.

Response

OK

operationIdstring uuid required

ID запроса

Changes

No recorded changes to this operation across all 1 revision of this API.