Получить информацию о кампаниях

Возвращает информацию о кампаниях.

Параметры необходимо указывать в формате Query-параметров. Данные передаются в кодировке UTF-8.

Каждый метод API имеет общее ограничение на количество запросов в секунду. Если этот лимит будет превышен, вам придет ответ с HTTP-кодом 429. В этом случае надо отправить повторный запрос через несколько минут.

Формат запроса

GET https://promopages.yandex.ru/api/promo/v1/campaigns?publisherId={string}&pageLimit={int}&pageLastId={string}

Параметры запроса

{
  "publisherId": {string},
  "pageLimit": {int},
  "pageLastId": {string},
  "campaignIds": {string},
  "startFrom": {string},
  "campaignTypes": {string},
  "campaignStrategies": {string}
}

Параметр	Тип	Описание	Обязательный
`publisherId`	string	Идентификатор канала.	Да
`pageLimit`	int	Количество кампаний в ответе. Не более 200 кампаний.	Да, если отсутствует campaignIds в запросе
`pageLastId`	string	Идентификатор страницы из предыдущего запроса.	Только если указан pageLimit. Не используется при наличии campaignIds
`campaignIds`	string	Список идентификаторов кампаний, указывается через запятую. Не более 200 кампаний.	Да, если отсутствует pageLimit в запросе
`startFrom`	string	Время запуска кампаний (без миллисекунд).	Нет
`campaignTypes`	string	Тип кампании, можно перечислить через запятую: `article` — статьи; `video` — видео; `post` — посты; `gallery` — галереи.	Нет
`campaignStrategies`	string	Тип стратегии, можно перечислить через запятую: `cpm` — цена за показ (охватная); `full_read` — оплата за дочитывание; `full_view` — оплата за досмотры; `clickout` — оплата за переходы; `clickout` — оплата за переходы; `daily_budget` — дневной бюджет.	Нет

Формат ответа

{
  "campaigns": [
    {
      "id": (string),
      "title": (string),
      "type": ("article" | "video" | "post" | "gallery"),
      "start": (string),
      "end": (string),
      "isArchived": (boolean),
      "strategy": {
        "name": ("cpm" | "full_read" | "full_view" | "clickout" | "daily_budget"),
        "maxDailyMoney": (double),
        "maxMoney": (double),
        "fullReadCost": (double),
        "fullViewCost": (double),
        "impressionCost": (double),
        "cpm": (double),
        "reachFrequency": (double)
    },
        "targeting": {
          "geo": [
            {
              "id": int,
              "name": (string)
            }
          ],
          "os": Array<String>[],
          "gender": Array<String>[],
          "age": Array<String>[]
        },
        "publications": [
          {
            "id": (string),
            "title": (string),
            "isDisabled": (boolean),
            "isDeleted": (boolean), 
            "previews": [
              {
                "id": (string),
                "type": (string),
                "imageId": (string),
                "imageUrl": (string)
                "isDisabled": (boolean),
                "isDeleted": (boolean)
              }
            ]
          }
        ]
      }
    ],
  "hasNextPage": (bolean),
  "pageLastId": (string)
}

Структура campaigns

Параметр	Тип	Описание
`id`	string	Идентификатор кампании.
`title`	string	Название кампании.
`start`	string	Дата и время старта кампании в формате YYYY-MM-DDThh:mm:ssZ.
`end`	string	Дата и время окончания кампании в формате YYYY-MM-DDThh:mm:ssZ.
`isArchived`	boolean	Возвращает `true`, если кампания в архиве.
`type`	typeEnum	Тип кампании: `article` — статьи; `video` — видео; `post` — посты; `gallery` — галереи.

Структура strategy

Параметр	Тип	Описание
`name`	nameEnum	Тип стратегии: `cpm` — цена за показ (охватная); `full_read` — оплата за дочитывание; `full_view` — оплата за досмотры; `clickout` — оплата за переходы; `daily_budget` — дневной бюджет.
`maxDailyMoney`	double	Дневной лимит. Доступен в стратегиях: `full_view` — оплата за досмотры; `full_read` — оплата за дочитывание; `daily_budget` — дневной бюджет; `clickout` — оплата за переходы.
`maxMoney`	double	Общий лимит на кампанию. Доступен в стратегиях: `full_view` — оплата за досмотры; `full_read` — оплата за дочитывание; `daily_budget` — дневной бюджет; `clickout` — оплата за переходы.
`fullReadCost`	double	Цена дочитывания. Только для стратегии `full_read`.
`fullViewCost`	double	Цена досмотра. Только для стратегии `full_view`.
`impressionCost`	double	Цена за один показ. Только для стратегии `cpm`.
`cpm`	double	Цена за тысячу показов. Только для стратегии `cpm`.
`clickoutCost`	double	Цена внешнего перехода. Только для стратегии `clickout`.
`reachFrequency`	double	Частота показов. Только для стратегии `cpm`.

Структура targeting

Параметр	Тип	Описание
`geo`	Array[int, string]	Список регионов для таргетирования. Приходит в формате массива объектов.
`os`	Array[]	Список устройств для таргетирования: `desktop`, `ios`, `android`.
`gender`	Array[]	Пол для таргетирования: `m`, `f`.
`age`	Array[]	Возраст для таргетирования: 0_17, 18_24, 25_34, 35_44, 45_54, 55_99.

Структура geo

Параметр	Тип	Описание
`id`	int	Идентификатор региона.
`name`	string	Название региона.

Структура publications

Параметр	Тип	Описание
`id`	string	Идентификатор публикации.
`type`	string	Тип публикации: `article` — статьи; `video` — видео; `post` — посты; `gallery` — галереи.
`isDisabled`	boolean	Возвращает `true`, если публикация была удалена из кампании.
`isDeleted`	boolean	Возвращает `true`, если публикация была удалена из канала.
`previews`	Array[]	Массив с данными по обложкам публикации.

Структура previews

Параметр	Тип	Описание
`id`	string	Идентификатор заголовка.
`title`	string	Заголовок обложки.
`imageId`	string	Идентификатор изображения для обложки.
`imageUrl`	string	Ссылка на изображение обложки.
`isDisabled`	boolean	Возвращает `true`, если обложка была отключена пользователем.
`isDeleted`	boolean	Возвращает `true`, если обложка была удалена пользователем.

Прочие параметры

Параметр	Тип	Описание
`hasNextPage`	boolean	Возвращает `true`, если в результатах больше одной кампании.
`pageLastId`	string	Идентификатор страницы из предыдущего запроса.

Пример

Запрос:

https://promopages.yandex.ru/api/promo/v1/campaigns?publisherId=5d6015092f1e4409e4e3ee84&pageLastId=true.c3RvcHBlZA.1583850430514.5e67a3c420e81f743c624ee2&pageLimit=1

Ответ:

{
    "campaigns": [
        {
            "id": "5e67a3c5bf998668491f9079",
            "title": "ola amigo",
            "type": "article",
            "strategy": {
                "name": "full_read",
                "maxDailyMoney": 10000.0,
                "fullReadCost": 2.0
            },
            "targeting": {
                "geo": [
                    {
                      "id": 225,
                      "name": "Россия"
                    }
                ],
                "os": [
                    "desktop",
                    "ios",
                    "android"
                ],
                "gender": [
                    "m",
                    "f"
                ],
                "age": [
                    "0_17",
                    "18_24",
                    "25_34",
                    "35_44",
                    "45_54",
                    "55_99"
                ]
            },
            "start": "2020-03-10T14:27:10Z",
            "isArchived": true,
            "publications": [
                {
                    "id": "5d67c6491ee34f00ad33c655",
                    "type": "article",
                    "isDisabled": true,
                    "previews": [
                        {
                          "id": "5d67c6491ee34f00ad33c655",
                          "title": "Как написать лаконичную рекламную статью (и как получить бонус от Дзена)"
                        }
                    ]
                },
                {
                    "id": "5ec81e1344070e5cfc48f96a",
                    "type": "article",
                    "isDisabled": true,
                    "previews": [
                        {
                          "id": "5ec81e1344070e5cfc48f96a",
                          "title": "1221"
                        }
                    ]
                },
                {
                    "id": "5ed8faeb2c71d31a7e746d40",
                    "type": "article",
                    "previews": [
                        {
                          "id": "5ed8faeb2c71d31a7e746d40",
                          "title": "Комплект из планшета Pioneer SDA-80TAB и головного устройства SPH-T20BT: доступный Android со звуком Pioneer",
                          "imageId": "5cad0d2bbd3a3000b073995d",
                          "imageUrl": "https://avatars.mds.yandex.net/get-zen_doc/119173/pub_5cb052e1f2975d00b367d9ba_5cad0d2bbd3a3000b073995d/orig"
                        }
                    ]
                }
            ]
        }
    ],
    "hasNextPage": true,
    "pageLastId": "true.c3RvcHBlZA.1583850430514.5e67a3c5bf998668491f9079"
}

Была ли статья полезна?

Коды ответа API ПромоСтраниц

Создать отчет