- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- KeywordPlanCampaignForecast
- KeywordPlanAdGroupForecast
- KeywordPlanKeywordForecast
- Try it!
Returns the requested Keyword Plan forecasts.
List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError KeywordPlanError QuotaError RequestError
HTTP request
POST https://googleads.googleapis.com/v13/{keywordPlan=customers/*/keywordPlans/*}:generateForecastMetrics
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
keywordPlan |
Required. The resource name of the keyword plan to be forecasted. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response message for KeywordPlanService.GenerateForecastMetrics
.
JSON representation |
---|
{ "campaignForecasts": [ { object ( |
Fields | |
---|---|
campaignForecasts[] |
List of campaign forecasts. One maximum. |
adGroupForecasts[] |
List of ad group forecasts. |
keywordForecasts[] |
List of keyword forecasts. |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adwords
For more information, see the OAuth 2.0 Overview.
KeywordPlanCampaignForecast
A campaign forecast.
JSON representation |
---|
{
"campaignForecast": {
object ( |
Fields | |
---|---|
campaignForecast |
The forecast for the Keyword Plan campaign. |
keywordPlanCampaign |
The resource name of the Keyword Plan campaign related to the forecast.
|
KeywordPlanAdGroupForecast
An ad group forecast.
JSON representation |
---|
{
"adGroupForecast": {
object ( |
Fields | |
---|---|
adGroupForecast |
The forecast for the Keyword Plan ad group. |
keywordPlanAdGroup |
The resource name of the Keyword Plan ad group related to the forecast.
|
KeywordPlanKeywordForecast
A keyword forecast.
JSON representation |
---|
{
"keywordForecast": {
object ( |
Fields | |
---|---|
keywordForecast |
The forecast for the Keyword Plan keyword. |
keywordPlanAdGroupKeyword |
The resource name of the Keyword Plan keyword related to the forecast.
|