GetCampaignsListFilter

Возвращает список кампаний, соответствующих условиям отбора, с краткими сведениями о кампаниях.

Внимание.

Метод отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях 4 и 5 см. в Руководстве по переходу.

Для метода существует версия GetCampaignsListFilter (Live).

Ограничения

Внимание. Метод возвращает только кампании с типом «Текстово-графические объявления». Для работы с кампаниями всех типов используйте сервис Campaigns API версии 5. Подробнее о типах кампаний...

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "GetCampaignsListFilter",
   "param": {
      /* GetCampaignsInfo */
      "Logins": [
         (string)
         ...
      ],
      "Filter": {
         /* CampaignsFilterInfo */
         "StatusModerate": [
            (string)
            ...
         ],
         "IsActive": [
            (string)
            ...
         ],
         "StatusArchive": [
            (string)
            ...
         ],
         "StatusActivating": [
            (string)
            ...
         ],
         "StatusShow": [
            (string)
            ...
         ]
      }
   }
}

Ниже приведено описание параметров.

Параметр Описание Требуется
Объект GetCampaignsInfo
Logins Массив, содержащий логины клиентов (не более 100), для которых требуется получить список кампаний. Заполняется только рекламными агентствами. Другие пользователи могут не указывать этот параметр. Да для рекламных агентств
Filter Объект CampaignsFilterInfo, содержащий условия отбора кампаний. Если не задан, возвращаются сведения о всех кампаниях, как в методе GetCampaignsList. Нет
Объект CampaignsFilterInfo
StatusModerate

Отбирать кампании по состоянию модерации:

  • Yes — прошедшие модерацию;
  • No — не прошедшие модерацию;
  • New — не отправленные на модерацию (статус «Черновик»);
  • Pending — находящиеся на модерации.
Нет
IsActive

Отбирать кампании по состоянию активности:

  • Yes — активные;
  • No — не активные.

Под активностью понимается состояние кампании, при котором показ объявлений включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивность кампании означает, что показ объявлений заблокирован клиентом или менеджером Яндекса и не может быть включен автоматически.

Нет
StatusArchive

Отбирать кампании по признаку помещения в архив:

  • Yes — в архиве;
  • No — не в архиве.
Нет
StatusActivating

Отбирать кампании по состоянию активизации:

  • Yes — активированные;
  • Pending — выполняется активизация.
Нет
StatusShow

Отбирать кампании по состоянию показа объявлений:

  • Yes — показ включен;
  • No — показ выключен.
Нет

Результирующие данные

Метод возвращает массив объектов ShortCampaignInfo, содержащих краткие сведения о кампаниях. Ниже показана структура результирующих данных в формате JSON.

{
   "data": [
      {  /* ShortCampaignInfo */
         "CampaignID": (int),
         "Login": (string),
         "Name": (string),
         "StartDate": (date),
         "Sum": (float),
         "Rest": (float),
         "SumAvailableForTransfer": (float),
         "Shows": (int),
         "Clicks": (int),
         "Status": (string),
         "StatusShow": (string),
         "StatusArchive": (string),
         "StatusActivating": (string),
         "StatusModerate": (string),
         "IsActive": (string),
         "ManagerName": (string),
         "AgencyName": (string)
      }
      ...
   ]
}

Ниже приведено описание параметров.

Параметр Описание
Объект ShortCampaignInfo
CampaignID

Идентификатор кампании.

Для создания кампании задают 0, для изменения параметров существующей кампании указывают ее идентификатор.

Login

Логин владельца кампании (логин пользователя Яндекса, в пользу которого ведется рекламная кампания).

При создании кампании прямые рекламодатели указывают собственный логин в Яндексе, рекламные агентства — логин своего клиента. При получении параметров кампании возвращается логин главного представителя рекламодателя.

Name

Название кампании.

StartDate

Начало показа объявлений, YYYY-MM-DD. Если не задана, используется дата создания кампании.

Дата может находиться в будущем. В этом случае показ объявлений начинается при наступлении указанной даты, если модератор одобрил объявления и внесены средства на баланс кампании.

Sum

Если у рекламодателя подключен общий счет — сумма израсходованных средств за все время существования кампании.

Если общий счет не подключен — сумма средств, зачисленных на баланс кампании за время ее существования.

Rest

Текущий баланс общего счета + сумма возврата на кампанию (если у рекламодателя подключен общий счет) или текущий баланс кампании (если общий счет не подключен).

Примечание. Сумма возврата средств за клики, признанные системой недобросовестными или ошибочными, может быть израсходована только в рамках этой же кампании.
SumAvailableForTransfer

Сумма, доступная для перевода с помощью метода TransferMoney. Может быть меньше баланса кампании.

Возвращается только в случае, если общий счет у рекламодателя не подключен.

Shows

Количество показов за время существования кампании.

Clicks

Количество кликов за время существования кампании.

Status Статус кампании, например: «Идут показы», «Ожидает оплаты», «На модерации», «Остановлена», «Идут показы. Идет активизация», «Кампания заархивирована» и другие.
StatusShow

Показ объявлений кампании включен — Yes/No. Включение и выключение выполняется методами StopCampaign и ResumeCampaign.

Разрешение показа на уровне кампании не означает, что объявления фактически показываются. Для этого необходимо выполнение и других условий: достаточный баланс средств, кампания и объявления проверены модератором, разрешен показ на уровне объявлений (метод ResumeBanners). Фактическому показу соответствует значение Yes в параметре IsActive.

StatusArchive

Состояние архивации кампании:

  • Yes — кампания помещена в архив;
  • No — кампания не в архиве;
  • Pending — происходит перенос кампании в архив либо возврат из архива.

Перенос в архив выполняют с помощью метода ArchiveCampaign. Для возврата из архива служит метод UnArchiveCampaign.

StatusActivating

Состояние активизации кампании:

  • Yes — активизирована;
  • Pending — ожидается активизация.
StatusModerate

Результат проверки модератором:

  • Yes — модератор одобрил хотя бы одно объявление;
  • No — модератор отклонил все объявления;
  • New — объявления не отправлялись на проверку (статус кампании «Черновик»);
  • Pending — проводится проверка.

Для отправки на проверку служит метод ModerateBanners.

IsActive

Кампания активна, объявления показываются — Yes/No.

Под активностью понимается состояние кампании, при котором показ объявлений включается и выключается автоматически — в соответствии с настройками временного таргетинга или в зависимости от баланса кампании. Неактивность кампании означает, что показ объявлений заблокирован и не может быть включен автоматически.

ManagerName

Имя персонального менеджера в Яндексе. Заполняется автоматически для кампаний, обслуживаемых персональным менеджером.

AgencyName

Название рекламного агентства. Заполняется автоматически, если создателем кампании является агентство.

Примеры входных данных

Python

{
   'Logins': ['agrom'],
   'Filter': {
      'IsActive': ['Yes'],
      'StatusShow': ['Yes']
   }
}

PHP

array(
   'Logins' => array('agrom'),
   'Filter' => array(
      'IsActive' => array('Yes'),
      'StatusShow' => array('Yes')
   )
)

Perl

{
   'Logins' => ['agrom'],
   'Filter' => {
      'IsActive' => ['Yes'],
      'StatusShow' => ['Yes']
   }
}