The ForecastKeywordBatchResponse object returns the forecasted results for a given set of keyword and (optional) ad group combination.
The forecasted results include two elements, the forecastResponseDetail element (the forecast),
and the forecastLandscape element (the forecast landscape).
Use both of these elements to determine how an ad group or keyword
might perform.
For example, suppose you'd like to know how the keyword
"red wagon" might perform at a bid price of 50 cents. The
forecastResponseDetail element will return a set of performance metrics
(the forecast) using the bid price of 50 cents. The forecastLandscape
element will return sets of performance metrics (the forecast landscape)
using data points above and below 50 cents (for example, perhaps 20 cents,
40 cents, and 70 cents) which you can use for comparison.
| Element | Data Type | Description |
|---|---|---|
| canonKeyword | string | The canonical form of the keyword |
| errors | Error[] | A list of errors (if the operation failed) or an empty list |
| forecastLandscape | ForecastResponse Data[] |
A list of forecasts for the ad group or keyword, using data points above and below the bid (or bids) specified in the request. |
| forecastResponse Detail |
ForecastResponse Data |
The forecast for the ad group or keyword, using the bid (or bids) specified in the request. |
| keyword | string | The keyword provided in the request |
| matchTypes | ForecastMatch Type[] |
The match types provided in the request |
| operationSucceeded | boolean | Whether the operation succeeded |
| warnings | Warning[] | A list of warnings (returned if the operation has any) or the empty list. |