GetForecast

Возвращает сформированный прогноз показов, кликов и затрат по его идентификатору.

Внимание.

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

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

Для метода существует версия GetForecast (Live).

Об использовании отчета см. раздел Подбор ставок.

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

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

{
   "method": "GetForecast",
   "param": (int)
}

В параметре param указывают идентификатор, полученный в ответе метода CreateNewForecast. Идентификатор можно также узнать с помощью метода GetForecastList.

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

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

{
   "data": {
      /* GetForecastInfo */
      "Phrases": [
         {  /* BannerPhraseInfo */
            "Phrase": (string),
            "IsRubric": (string),
            "Min": (float),
            "Max": (float),
            "PremiumMin": (float),
            "PremiumMax": (float),
            "Shows": (int),
            "Clicks": (int),
            "FirstPlaceClicks": (int),
            "PremiumClicks": (int),
            "CTR": (float),
            "FirstPlaceCTR": (float),
            "PremiumCTR": (float)
         }
         ...
      ],
      "Common": {
         /* ForecastCommonInfo */
         "Geo": (string),
         "Min": (float),
         "Max": (float),
         "PremiumMin": (float)
         "Shows": (int),
         "Clicks": (int),
         "FirstPlaceClicks": (int),
         "PremiumClicks": (int),
      }
   }
}

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


_{Объект GetForecastInfo}
^{Параметр}	^{Описание}
`Phrases`	Массив объектов BannerPhraseInfo. Каждый объект содержит прогноз по одной фразе, указанной при формировании отчета (метод CreateNewForecast).
`Common`	Объект ForecastCommonInfo с суммарным прогнозом по всем фразам.
_{Объект BannerPhraseInfo}
`Phrase`	Ключевая фраза, для которых составлен прогноз.
`IsRubric`	Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No.
`Min`	Средневзвешенная цена клика в нижнем блоке на момент составления прогноза, у. е.
`Max`	Средневзвешенная цена клика на первом месте в нижнем блоке на момент составления прогноза, у. е.
`PremiumMin`	Средневзвешенная цена клика в спецразмещении на момент составления прогноза, у. е.
`PremiumMax`	Средневзвешенная цена клика на первом месте в спецразмещении на момент составления прогноза, у. е.
`Shows`	Возможное количество показов объявления по данной фразе за прошедший месяц.
`Clicks`	Возможное количество кликов по объявлению в нижнем блоке (кроме первого места) за прошедший месяц.
`FirstPlaceClicks`	Возможное количество кликов по объявлению на первом месте в нижнем блоке, за прошедший месяц.
`PremiumClicks`	Возможное количество кликов по объявлению в спецразмещении за прошедший месяц.
`CTR`	CTR при показе в нижнем блоке, в процентах. Рассчитывается по формуле: `Clicks/Shows * 100`
`FirstPlaceCTR`	CTR при показе на первом месте в нижнем блоке. Рассчитывается по формуле: `FirstPlaceClicks/Shows * 100`
`PremiumCTR`	CTR при показе в спецразмещении. Рассчитывается по формуле: `PremiumClicks/Shows * 100`
_{Объект ForecastCommonInfo}
`Geo`	Список регионов, которые указаны при формировании отчета (метод CreateNewForecast).
`Min`	Стоимость кликов при показе в нижнем блоке (кроме первого места) суммарно по всем указанным фразам, у. е.
`Max`	Стоимость кликов при показе на первом месте в нижнем блоке суммарно по всем указанным фразам, у. е.
`PremiumMin`	Стоимость кликов при показе в спецразмещении суммарно по всем указанным фразам, у. е.
`Shows`	Возможное количество показов объявления суммарно по всем фразам.
`Clicks`	Возможное количество кликов в нижнем блоке (кроме первого места) суммарно по всем указанным фразам.
`FirstPlaceClicks`	Возможное количество кликов на первом месте в нижнем блоке суммарно по всем указанным фразам.
`PremiumClicks`	Возможное количество кликов в спецразмещении суммарно по всем указанным фразам.


_{Объект GetForecastInfo}
^{Параметр}	^{Описание}
`Phrases`	Массив объектов BannerPhraseInfo. Каждый объект содержит прогноз по одной фразе, указанной при формировании отчета (метод CreateNewForecast).
`Common`	Объект ForecastCommonInfo с суммарным прогнозом по всем фразам.
_{Объект BannerPhraseInfo}
`Phrase`	Ключевая фраза, для которых составлен прогноз.
`IsRubric`	Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No.
`Min`	Средневзвешенная цена клика в нижнем блоке на момент составления прогноза, у. е.
`Max`	Средневзвешенная цена клика на первом месте в нижнем блоке на момент составления прогноза, у. е.
`PremiumMin`	Средневзвешенная цена клика в спецразмещении на момент составления прогноза, у. е.
`PremiumMax`	Средневзвешенная цена клика на первом месте в спецразмещении на момент составления прогноза, у. е.
`Shows`	Возможное количество показов объявления по данной фразе за прошедший месяц.
`Clicks`	Возможное количество кликов по объявлению в нижнем блоке (кроме первого места) за прошедший месяц.
`FirstPlaceClicks`	Возможное количество кликов по объявлению на первом месте в нижнем блоке, за прошедший месяц.
`PremiumClicks`	Возможное количество кликов по объявлению в спецразмещении за прошедший месяц.
`CTR`	CTR при показе в нижнем блоке, в процентах. Рассчитывается по формуле: `Clicks/Shows * 100`
`FirstPlaceCTR`	CTR при показе на первом месте в нижнем блоке. Рассчитывается по формуле: `FirstPlaceClicks/Shows * 100`
`PremiumCTR`	CTR при показе в спецразмещении. Рассчитывается по формуле: `PremiumClicks/Shows * 100`
_{Объект ForecastCommonInfo}
`Geo`	Список регионов, которые указаны при формировании отчета (метод CreateNewForecast).
`Min`	Стоимость кликов при показе в нижнем блоке (кроме первого места) суммарно по всем указанным фразам, у. е.
`Max`	Стоимость кликов при показе на первом месте в нижнем блоке суммарно по всем указанным фразам, у. е.
`PremiumMin`	Стоимость кликов при показе в спецразмещении суммарно по всем указанным фразам, у. е.
`Shows`	Возможное количество показов объявления суммарно по всем фразам.
`Clicks`	Возможное количество кликов в нижнем блоке (кроме первого места) суммарно по всем указанным фразам.
`FirstPlaceClicks`	Возможное количество кликов на первом месте в нижнем блоке суммарно по всем указанным фразам.
`PremiumClicks`	Возможное количество кликов в спецразмещении суммарно по всем указанным фразам.

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

Расскажите, что вам не понравилось в статье: