|
|
ForecastService
ForecastService provides operations that enable you to perform forecasts
for ad groups, keywords, or sets of keywords. The forecast returns results on a daily basis. Note that the forecast results are estimates only and are not
guaranteed.
Operations
- getForecastByAdGroup (changed in Version 5.2.0)
- getForecastForKeyword (changed in Version 5.2.0)
- getForecastForKeywordBatch (changed in Version 5.2.0)
- getForecastForKeywords (changed in Version 5.2.0)
- getHistoricalDataForKeywords (changed in Version 5.2.0)
getForecastByAdGroup
Return a forecast for an ad group.
The adGroupID is mandatory. 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.
Changed in: Version 5.2.0
Capability required: Research
License command group: Research
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| adGroupID | long | The ID of the ad group used for forecasting. |
| forecastRequestData | AdGroupForecastRequestData | The data used in the forecast. |
Response
ForecastResponse - The forecast response for the ad group.
getForecastForKeyword
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.
Changed in: Version 5.2.0
Capability required: Research
License command group: Research
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| keyword | string | The keyword used for forecasting. |
| adGroupID | long | The ID of the ad group used for forecasting. This is an optional parameter and you may pass in the null value. |
| forecastRequestData | KeywordForecastRequestData | The data used in the forecast. |
Response
ForecastResponse - The forecast response for the keyword.
getForecastForKeywordBatch
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 100.
Changed in: Version 5.2.0
Capability required: Research
License command group: Research
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| batchKeywords | ForecastKeywordBatch[] | A list of keywords used for forecasting (optionally, adGroupID and overrides for individual keywords). |
| forecastRequestData | KeywordForecastRequestData | The data used in the forecast (including default bids and values that apply to all keywords in the forecast). |
Response
ForecastKeywordBatchResponse - The forecast response for each keyword.
getForecastForKeywords
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:
- Use forecastRequestData to set default bids and other values that are applied to all keywords in the forecast. The results are returned in the defaultResponseByAdGroup element of the response.
- Use forecastKeywords to specify your keywords and to optionally set customized bids for individual keywords. These customized bids will override the default bids set with forecastRequestData. The results are returned in the customizedResponsebyAdGroup element of the response.
Changed in: Version 5.2.0
Capability required: Research
License command group: Research
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| forecastKeywords | ForecastKeyword[] | A list of keywords used for forecasting (and optionally, override bids for individual keywords). The maximum number of keywords allowed in a given request is 250. |
| adGroupID | long | The ID of the ad group used for forecasting. This is an optional parameter and you may pass in the null value. |
| forecastRequestData | AdGroupForecastRequestData | The data used in the forecast (including default bids and values that apply to all keywords in the forecast). |
Response
ForecastKeywordResponse - The forecast response for the set of keywords.
getHistoricalDataForKeywords
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.
You can retrieve historical data based on targeting info. The targeting info will be considered only for the last calendar month, if the date range includes it.
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.
Changed in: Version 5.2.0
Capability required: Research
License command group: Research
Supported accounts: Web, Mobile
Parameters
| Parameter | Data Type | Description |
|---|---|---|
| historicalKeywords | HistoricalKeyword[] | A list of keywords used for getting historical data. |
| historicalRequestData | HistoricalRequestData | The data for which historical request is made. |
Response
HistoricalKeywordResponse - The historical data for each keyword.