hasSearchVolume

Для заданных ключевых фраз и регионов формирует предварительный прогноз наличия показов по этим фразам в разбивке по типам устройств. Используется при подборе ключевых фраз.

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

Ограничения

В течение 60-секундного интервала можно отправить не более 20 запросов для одного рекламодателя.

Запрос

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

{
  "method": "hasSearchVolume",
  "params": { /* params */
    "SelectionCriteria": {  /* HasSearchVolumeSelectionCriteria */
      "Keywords": [(string), ... ], /* required */
      "RegionIds": [(long), ... ] /* required */
    }, /* required */
    "FieldNames": [( "Keyword" | "RegionIds" | "AllDevices" | "MobilePhones" | "Tablets" | "Desktops" ), ... ] /* required */
  } 
}

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

Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / HasSearchVolumeRequest (для SOAP)
SelectionCriteria HasSearchVolumeSelectionCriteria

Ключевые фразы и регионы, для которых требуется получить прогноз.

Да
FieldNames array of HasSearchVolumeFieldEnum

Имена параметров, которые требуется получить.

Да
Структура HasSearchVolumeSelectionCriteria
Keywords array of string

Ключевые фразы. От 1 до 10 000 элементов в массиве. Совпадающие строки не допускаются.

Ключевая фраза может содержать операторы.

Длина ключевой фразы — не более 4096 символов. Оператор «!» перед минус-словом не учитывается в длине фразы (последовательность «-!» считается как один символ).

Не более 7 слов в ключевой фразе, без учета стоп-слов и минус-слов. Каждое слово — не более 35 символов, без учета минуса перед минус-словом.

Да
RegionIds array of long

Идентификаторы регионов, для которых показы включены или выключены.

Идентификатор 0 — показывать во всех регионах.

Минус перед идентификатором региона — выключить показы в данном регионе. Например [1,-219] — показывать для Москвы и Московской области, кроме Черноголовки. Минус-регионы нельзя использовать, если указан 0. Массив не должен состоять только из минус-регионов.

Справочник регионов можно получить с помощью метода Dictionaries.get.
Да

Ответ

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

{
  "result": { /* result */
    "HasSearchVolumeResults": [{  /* HasSearchVolumeItem */
      "Keyword": (string),
      "RegionIds": [(long), ... ],
      "AllDevices": ( YES | NO ),
      "MobilePhones": ( YES | NO ),
      "Tablets": ( YES | NO ),
      "Desktops": ( YES | NO )
    }, ... ],
  }
}

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

Параметр Тип Описание
Структура result (для JSON) / HasSearchVolumeResponse (для SOAP)
HasSearchVolumeResults array of HasSearchVolumeItem Прогноз наличия показов.
Структура HasSearchVolumeItem
Keyword string Ключевая фраза из запроса.
RegionIds array of long Идентификаторы регионов из запроса.
AllDevices YesNoEnum Наличие показов.
MobilePhones YesNoEnum Наличие показов на мобильных.
Tablets YesNoEnum Наличие показов на планшетах.
Desktops YesNoEnum Наличие показов на десктопах.