CreateNewForecast (Live)

Запускает на сервере формирование прогноза показов, кликов и затрат.

Метод возвращает идентификатор будущего отчета. По идентификатору можно узнать о готовности отчета (метод GetForecastList) и скачать отчет (метод GetForecast (Live)). Среднее время формирования отчета — до одной минуты.

Ограничения

Для одного пользователя на сервере хранится не более пяти отчетов. При попытке сформировать шестой отчет возвращается сообщение об ошибке с кодом 31. Отчеты хранятся в течение пяти часов, а затем автоматически удаляются. С помощью метода DeleteForecastReport можно удалить отчет вручную.

Новое в версии Live 4

Входной параметр Currency стал обязательным.

Добавлен входной параметр Currency.

Добавлен входной параметр AuctionBids.

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

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

{
   "method": "CreateNewForecast",
   "param": {
      /* NewForecastInfo */
      "Phrases": [
         (string)
         ...
      ],
      "Categories": [
         (int)
         ...
      ],
      "GeoID": [
         (int)
         ...
      ],
      "Currency": (string),
      "AuctionBids": (string)
   }
}

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

Параметр Описание Требуется
Объект NewForecastInfo
Phrases

Массив ключевых фраз, для которых требуется получить прогноз (не более 100 фраз в кодировке UTF-8).

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

холодильник -морозильник -(морозильная камера) -ремонт.

Примечание. Если массив содержит пересекающиеся ключевые фразы, то есть соответствующие одному и тому же поисковому запросу, то прогнозируемый показ и клик может быть отнесен к любой из этих фраз случайным образом. Поэтому прогноз по таким фразам может отличаться от прогноза, полученного по каждой фразе отдельными вызовами метода. См. раздел Устранение пересечений.
 Да
Categories

Массив, содержащий идентификаторы рубрик Яндекс Каталога. Параметр не используется, переданное значение игнорируется.

 Нет
GeoID

Массив, содержащий идентификаторы регионов для составления прогноза. Если не задан, прогноз составляется по всем регионам.

Список регионов получают с помощью метода GetRegions (Live).

 Нет
Currency

Валюта, в которой должны быть выражены цены клика и суммарные затраты в отчете.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

 Да
AuctionBids Выводить ли в отчете результаты торгов (массив AuctionBids) — Yes/No. Если не задано, подразумевается No. Нет
Параметр Описание Требуется
Объект NewForecastInfo
Phrases

Массив ключевых фраз, для которых требуется получить прогноз (не более 100 фраз в кодировке UTF-8).

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

холодильник -морозильник -(морозильная камера) -ремонт.

Примечание. Если массив содержит пересекающиеся ключевые фразы, то есть соответствующие одному и тому же поисковому запросу, то прогнозируемый показ и клик может быть отнесен к любой из этих фраз случайным образом. Поэтому прогноз по таким фразам может отличаться от прогноза, полученного по каждой фразе отдельными вызовами метода. См. раздел Устранение пересечений.
 Да
Categories

Массив, содержащий идентификаторы рубрик Яндекс Каталога. Параметр не используется, переданное значение игнорируется.

 Нет
GeoID

Массив, содержащий идентификаторы регионов для составления прогноза. Если не задан, прогноз составляется по всем регионам.

Список регионов получают с помощью метода GetRegions (Live).

 Нет
Currency

Валюта, в которой должны быть выражены цены клика и суммарные затраты в отчете.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

 Да
AuctionBids Выводить ли в отчете результаты торгов (массив AuctionBids) — Yes/No. Если не задано, подразумевается No. Нет

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

Метод возвращает идентификатор будущего отчета, как показано в следующем примере.

{
   "data": 137456
}

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

Python

{
   'Phrases': [u'холодильник -камера', u'холодильная камера'],
   'GeoID': [213]
}

PHP

array(
   'Phrases' => array('nokia', 'phone', 'cars'),
   'GeoID' => array(213)
)

Perl

{
   'Phrases' => ['nokia', 'phone', 'cars'],
   'GeoID' => [213]
}