Suspend

Останавливает показы по ключевым фразам. Фразы могут относиться к разным кампаниям или группам объявлений.

Внимание.

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

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

Ограничения

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

Для группы объявлений должна быть активна хотя бы одна фраза или условие ретаргетинга. При попытке остановить все активные фразы в группе (в отсутствие активных ретаргетингов) для каждой из этих фраз будет выдана ошибка с кодом 195 (эта ошибка не влечет отмену всей операции и не влияет на успешность остановки фраз, относящихся к другим группам).

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

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

{
   "method": "Keyword",
   "param": {
      /* KeywordRequest */
      "Action": (string),
      "Login": (string),
      "KeywordIDS": [
         (long)
         ...
      ]
   }
}

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

Параметр Описание Требуется
Объект KeywordRequest
Action Выполняемая операция: Suspend. Да
Login

Логин клиента, для которого нужно выполнить операцию.

Прямой рекламодатель может опционально указать логин своего главного представителя.

 Для агентств
KeywordIDS Массив идентификаторов фраз (не более 10 000). Да
Параметр Описание Требуется
Объект KeywordRequest
Action Выполняемая операция: Suspend. Да
Login

Логин клиента, для которого нужно выполнить операцию.

Прямой рекламодатель может опционально указать логин своего главного представителя.

 Для агентств
KeywordIDS Массив идентификаторов фраз (не более 10 000). Да

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

Примечание. Ошибки, возникшие при остановке отдельных фраз (54 — в случае отсутствия у пользователя прав на редактирование фразы, 194, 195), не влекут отмену всей операции и не влияют на успешность остановки остальных фраз.

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

{
   "data": {
      /* KeywordResponse */
      "ActionsResult": [
         {  /* KeywordActionResult */
            "Warnings": [
               {  /* Warning */
                  "WarningCode": (int),
                  "WarningString": (string),
                  "Description": (string)
               }
               ...
            ],
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ],
            "KeywordID": (long)
         }
         ...
      ]
   }
}

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

Параметр Описание
Объект KeywordResponse
ActionsResult
Массив объектов KeywordActionResult. Каждый объект соответствует элементу входного массива KeywordIDS и содержит:
  • идентификатор ключевой фразы;
  • массив ошибок Errors или массив предупреждений Warnings, в случае если они возникли при выполнении операции над данной фразой.
Объект KeywordActionResult
Warnings Массив объектов Warning — предупреждений, возникших при выполнении операции.
Errors Массив объектов Error — ошибок, возникших при выполнении операции.
KeywordID Идентификатор ключевой фразы.
Объект Warning
WarningCode Код предупреждения: 212.
WarningString Текст предупреждения.
Description Содержит пустую структуру.
Объект Error
FaultCode Код ошибки.
FaultString Текст сообщения об ошибке.
FaultDetail Подробное описание причины ошибки.
Параметр Описание
Объект KeywordResponse
ActionsResult
Массив объектов KeywordActionResult. Каждый объект соответствует элементу входного массива KeywordIDS и содержит:
  • идентификатор ключевой фразы;
  • массив ошибок Errors или массив предупреждений Warnings, в случае если они возникли при выполнении операции над данной фразой.
Объект KeywordActionResult
Warnings Массив объектов Warning — предупреждений, возникших при выполнении операции.
Errors Массив объектов Error — ошибок, возникших при выполнении операции.
KeywordID Идентификатор ключевой фразы.
Объект Warning
WarningCode Код предупреждения: 212.
WarningString Текст предупреждения.
Description Содержит пустую структуру.
Объект Error
FaultCode Код ошибки.
FaultString Текст сообщения об ошибке.
FaultDetail Подробное описание причины ошибки.

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

Python

{
   'Action': 'Suspend',
   'Login': 'agrom',
   'KeywordIDS': [199381759,199482870,200725193]
}

PHP

array(
   'Action' => 'Suspend',
   'Login' => 'agrom',
   'KeywordIDS' => array(199381759,199482870,200725193)
)

Perl

{
   'Action' => 'Suspend',
   'Login' => 'agrom',
   'KeywordIDS' => [199381759,199482870,200725193]
}