archive

Архивирует кампании.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Не более 1000 кампаний в одном вызове метода.

Нельзя заархивировать кампанию, на которой есть средства.

Кампания должна быть предварительно остановлена.

Запрос

Структура запроса в формате JSON:

{
  "method": "archive",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    } /* required */
  } 
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / ArchiveRequest (для SOAP)
SelectionCriteria IdsCriteria Критерий отбора кампаний, которые требуется архивировать. Да
Структура IdsCriteria
Ids array of long Идентификаторы кампаний, которые требуется архивировать (не более 1000). Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "ArchiveResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ] 
    }, ... ] /* required */
  }
}
Параметр Тип Описание
Структура result (для JSON) / ArchiveResponse (для SOAP)
ArchiveResults array of ActionResult Результаты архивации кампаний.
Структура ActionResult
Id long Идентификатор кампании. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.