Yahoo! Search Marketing

ForecastService

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.

Operations

getForecastByAdGroup

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

Parameters

Parameter Data Type Description
adGroupID long The ID of the ad group used for forecasting.
forecastRequestData ForecastRequestData 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.

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

Parameters

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.

Response

ForecastResponse - The forecast response for the 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.

Capability required: Research
License command group: Research

Parameters

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).

Response

ForecastKeywordResponse - The forecast response for the set of keywords.