Get

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

Ограничения

Внимание

Метод поддерживает только кампании с типом “Текстово-графические объявления”“Text & Image Ads”. Для управления фразами в кампаниях всех типов используйте сервис Keywords API версии 5.

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

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

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

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

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

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

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

{
   "data": {
      /* KeywordResponse */
      "ActionsResult": [
         {  /* KeywordActionResult */
            "KeywordID": (long),
            "QualityIndex": {
               /* QualityIndex */
               "Value": (decimal),
               "References": [
                  (int)
                  ...
               ]
            },
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ]
   }
}

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

Параметр	Описание
Объект KeywordResponse
`ActionsResult`	Массив объектов `KeywordActionResult`. Каждый объект соответствует элементу входного массива `KeywordIDS` и содержит: идентификатор ключевой фразы; значение продуктивности фразы; массив ошибок `Errors`, в случае если получить данные для фразы не удалось.
Объект KeywordActionResult
`KeywordID`	Идентификатор ключевой фразы.
`QualityIndex`	Объект, содержащий значение продуктивности фразы и рекомендации по его повышению.
`Errors`	Массив объектов `Error` — ошибок, возникших при выполнении операции.
Объект QualityIndex
`Value`	Значение продуктивности фразы (до 1 знака после запятой).
`References`	Массив номеров рекомендаций для данной фразы. Справочник рекомендаций можно получить с помощью метода Dictionaries.get API версии 5.
Объект Error
`FaultCode`	Код ошибки.
`FaultString`	Текст сообщения об ошибке.
`FaultDetail`	Подробное описание причины ошибки.

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

Python

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

PHP

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

Perl

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

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

Resume

SetAutoPrice