GetForecast (Live)
Возвращает сформированный прогноз показов, кликов и затрат по его идентификатору.
Об использовании отчета см. раздел Подбор ставок.
Новое в версии Live 4
Добавлен результирующий параметр Currency.
Добавлен результирующий параметр AuctionBids.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "GetForecast",
"param": (int)
}
В параметре param указывают идентификатор, полученный в ответе метода CreateNewForecast (Live). Идентификатор можно также узнать с помощью метода 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),
"Currency": (string),
"AuctionBids": [
{ /* PhraseAuctionBids */
"Position": (string),
"Bid": (float),
"Price": (float)
}
...
]
}
...
],
"Common": {
/* ForecastCommonInfo */
"Geo": (string),
"Min": (float),
"Max": (float),
"PremiumMin": (float)
"Shows": (int),
"Clicks": (int),
"FirstPlaceClicks": (int),
"PremiumClicks": (int),
}
}
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект GetForecastInfo | |
---|---|
Phrases | Массив объектов BannerPhraseInfo. Каждый объект содержит прогноз по одной фразе, указанной при формировании отчета (метод CreateNewForecast (Live)). |
Common | Объект ForecastCommonInfo с суммарным прогнозом по всем фразам. |
Объект BannerPhraseInfo | |
Phrase | Ключевая фраза, для которой составлен прогноз. |
IsRubric | Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No. |
Min | Средневзвешенная цена клика в нижнем блоке на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Max | Средневзвешенная цена клика на первом месте в нижнем блоке на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMin | Средневзвешенная цена клика в спецразмещении на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMax | Средневзвешенная цена клика на первом месте в спецразмещении на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Shows | Возможное количество показов объявления по данной фразе за прошедший месяц. |
Clicks | Возможное количество кликов по объявлению в нижнем блоке (кроме первого места) за прошедший месяц. |
FirstPlaceClicks | Возможное количество кликов по объявлению на первом месте в нижнем блоке, за прошедший месяц. |
PremiumClicks | Возможное количество кликов по объявлению в спецразмещении за прошедший месяц. |
CTR | CTR при показе в нижнем блоке, в процентах. Рассчитывается по формуле:
|
FirstPlaceCTR | CTR при показе на первом месте в нижнем блоке. Рассчитывается по формуле:
|
PremiumCTR | CTR при показе в спецразмещении. Рассчитывается по формуле:
|
Currency | Валюта, в которой выражены цены клика и суммарные затраты в отчете. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
AuctionBids | Массив объектов PhraseAuctionBids, содержащий результаты торгов по фразе: ставку за каждую позицию в спецразмещении и в нижнем блоке, а также списываемую цену для каждой позиции. |
Объект PhraseAuctionBids | |
Position | Позиция показа: Pmn, где
Например, P12 — второе место в спецразмещении, P21 — первое место в блоке гарантированных показов. |
Bid | Минимальная ставка за указанную позицию (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Price | Списываемая цена для указанной позиции (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Объект ForecastCommonInfo | |
Geo | Список регионов, которые указаны при формировании отчета (метод CreateNewForecast (Live)). |
Min | Стоимость кликов при показе в нижнем блоке (кроме первого места) суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Max | Стоимость кликов при показе на первом месте в нижнем блоке суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMin | Стоимость кликов при показе в спецразмещении суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Shows | Возможное количество показов объявления суммарно по всем фразам. |
Clicks | Возможное количество кликов в нижнем блоке (кроме первого места) суммарно по всем указанным фразам. |
FirstPlaceClicks | Возможное количество кликов на первом месте в нижнем блоке суммарно по всем указанным фразам. |
PremiumClicks | Возможное количество кликов в спецразмещении суммарно по всем указанным фразам. |
Параметр | Описание |
Объект GetForecastInfo | |
---|---|
Phrases | Массив объектов BannerPhraseInfo. Каждый объект содержит прогноз по одной фразе, указанной при формировании отчета (метод CreateNewForecast (Live)). |
Common | Объект ForecastCommonInfo с суммарным прогнозом по всем фразам. |
Объект BannerPhraseInfo | |
Phrase | Ключевая фраза, для которой составлен прогноз. |
IsRubric | Признак того, что фраза является рубрикой Яндекс Каталога. Всегда содержит значение No. |
Min | Средневзвешенная цена клика в нижнем блоке на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Max | Средневзвешенная цена клика на первом месте в нижнем блоке на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMin | Средневзвешенная цена клика в спецразмещении на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMax | Средневзвешенная цена клика на первом месте в спецразмещении на момент составления прогноза. Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Shows | Возможное количество показов объявления по данной фразе за прошедший месяц. |
Clicks | Возможное количество кликов по объявлению в нижнем блоке (кроме первого места) за прошедший месяц. |
FirstPlaceClicks | Возможное количество кликов по объявлению на первом месте в нижнем блоке, за прошедший месяц. |
PremiumClicks | Возможное количество кликов по объявлению в спецразмещении за прошедший месяц. |
CTR | CTR при показе в нижнем блоке, в процентах. Рассчитывается по формуле:
|
FirstPlaceCTR | CTR при показе на первом месте в нижнем блоке. Рассчитывается по формуле:
|
PremiumCTR | CTR при показе в спецразмещении. Рассчитывается по формуле:
|
Currency | Валюта, в которой выражены цены клика и суммарные затраты в отчете. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
AuctionBids | Массив объектов PhraseAuctionBids, содержащий результаты торгов по фразе: ставку за каждую позицию в спецразмещении и в нижнем блоке, а также списываемую цену для каждой позиции. |
Объект PhraseAuctionBids | |
Position | Позиция показа: Pmn, где
Например, P12 — второе место в спецразмещении, P21 — первое место в блоке гарантированных показов. |
Bid | Минимальная ставка за указанную позицию (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Price | Списываемая цена для указанной позиции (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Объект ForecastCommonInfo | |
Geo | Список регионов, которые указаны при формировании отчета (метод CreateNewForecast (Live)). |
Min | Стоимость кликов при показе в нижнем блоке (кроме первого места) суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Max | Стоимость кликов при показе на первом месте в нижнем блоке суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
PremiumMin | Стоимость кликов при показе в спецразмещении суммарно по всем указанным фразам (в валюте, указанной в параметре Currency). Значение конвертируется в валюту, указанную в параметре Currency, и округляется вверх с точностью до шага торгов в этой валюте. |
Shows | Возможное количество показов объявления суммарно по всем фразам. |
Clicks | Возможное количество кликов в нижнем блоке (кроме первого места) суммарно по всем указанным фразам. |
FirstPlaceClicks | Возможное количество кликов на первом месте в нижнем блоке суммарно по всем указанным фразам. |
PremiumClicks | Возможное количество кликов в спецразмещении суммарно по всем указанным фразам. |