ForecastService provides operations that enable you to perform forecasts
for ad groups, keywords, or sets of keywords. Keep in mind that the results
returned by a forecast are estimates only and are not guaranteed.
Return a forecast for an ad group.
The forecast is an aggregation based on the active keywords in the ad group and is performed within the context of the ad group, using the ad group's quality score and other data.
Capability required: Research
License command group: Research
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ID of the ad group used for forecasting. |
| forecastRequestData | ForecastRequestData | The data used in the forecast. |
ForecastResponse - The forecast response for the ad group.
Return a forecast for a keyword.
The adGroupID is optional. If specified, the forecast is performed within the context of the ad group, using the ad group's quality score and other data.
Please note that, unlike Sponsored Search, the forecast results for Content Match® are not directly related to the specified keywords. The specified keywords only help our system determine which web pages your Content Match ads are likely to be displayed on.
Capability required: Research
License command group: Research
| Parameter | Data Type | Description |
|---|---|---|
| keyword | string | The keyword used for forecasting. |
| adGroupID | long | The ID of the ad group used for forecasting. (For this parameter, you may pass in the null value.) |
| forecastRequestData | ForecastRequestData | The data used in the forecast. |
ForecastResponse - The forecast response for the keyword.
Returns forecast for the given set of keywords.
The adGroupID within ForecastKeywordBatch is optional. If specified, the forecast for that keyword is performed within the context of the ad group, using the ad group's quality score and other data.
The maximum number of keywords allowed in a given request is 250.
Added in: Version 4.2.0
Capability required: Research
License command group: Research
| Parameter | Data Type | Description |
|---|---|---|
| keywords | ForecastKeywordBatch[] | A list of keywords used for forecasting (optionally adGroupID and overrides for individual keywords) |
| forecastRequestData | ForecastRequestData | The data used in the forecast (default bids and values that apply to all keywords in the forecast) |
ForecastKeywordBatchResponse[] - The forecast response for each keyword
Return a forecast for a set of keywords.
The adGroupID is optional. If specified, the forecast is performed within the context of the ad group, using the ad group's quality score and other data.
Please note that, unlike Sponsored Search, the forecast results for Content Match® are not directly related to the specified keywords. The specified keywords only help our system determine which web pages your Content Match ads are likely to be displayed on.
Also, note the following:
Capability required: Research
License command group: Research
| Parameter | Data Type | Description |
|---|---|---|
| forecastKeywords | ForecastKeyword[] | A list of keywords used for forecasting (and optionally, override bids for individual keywords). |
| adGroupID | long | The ID of the ad group used for forecasting. (For this parameter, you may pass in the null value.) |
| forecastRequestData | ForecastRequestData | The data used in the forecast (default bids and values that apply to all keywords in the forecast). |
ForecastKeywordResponse - The forecast response for the set of keywords.
Returns historical data for the given set of keywords and date range.
The historical data represents the past performance for the given set of keywords. For example, get historical data for the keyword "holiday gifts" in September, October, and November of last year.
Please note that only the month and year components are considered, for the start and end dates specified in the date range.
The maximum number of keywords allowed in a given request is 250. The number of months between the start date and end date should not exceed 12 months.
Added in: Version 4.2.0
Capability required: Research
License command group: Research
| Parameter | Data Type | Description |
|---|---|---|
| keywords | HistoricalKeyword[] | A list of keywords used for getting historical data |
| historicalRequestData | HistoricalRequestData | The data for which historical request is made |
HistoricalKeywordResponse[] - The historical data for each keyword