Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.keywordPlans.generateForecastCurve

Returns the requested Keyword Plan forecast curve. Only the bidding strategy is considered for generating forecast curve. The bidding strategy value specified in the plan is ignored.

To generate a forecast at a value specified in the plan, use KeywordPlanService.GenerateForecastMetrics.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError KeywordPlanError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v8/{keywordPlan=customers/*/keywordPlans/*}:generateForecastCurve

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
keywordPlan

string

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

JSON representation
{
  "campaignForecastCurves": [
    {
      object (KeywordPlanCampaignForecastCurve)
    }
  ]
}
Fields
campaignForecastCurves[]

object (KeywordPlanCampaignForecastCurve)

List of forecast curves for the keyword plan campaign. One maximum.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

KeywordPlanCampaignForecastCurve

The forecast curve for the campaign.

JSON representation
{
  "maxCpcBidForecastCurve": {
    object (KeywordPlanMaxCpcBidForecastCurve)
  },
  "keywordPlanCampaign": string
}
Fields
maxCpcBidForecastCurve

object (KeywordPlanMaxCpcBidForecastCurve)

The max cpc bid forecast curve for the campaign.

keywordPlanCampaign

string

The resource name of the Keyword Plan campaign related to the forecast.

customers/{customerId}/keywordPlanCampaigns/{keyword_plan_campaign_id}

KeywordPlanMaxCpcBidForecastCurve

The max cpc bid forecast curve.

JSON representation
{
  "maxCpcBidForecasts": [
    {
      object (KeywordPlanMaxCpcBidForecast)
    }
  ]
}
Fields
maxCpcBidForecasts[]

object (KeywordPlanMaxCpcBidForecast)

The forecasts for the Keyword Plan campaign at different max CPC bids.

KeywordPlanMaxCpcBidForecast

The forecast of the campaign at a specific bid.

JSON representation
{
  "maxCpcBidForecast": {
    object (ForecastMetrics)
  },
  "maxCpcBidMicros": string
}
Fields
maxCpcBidForecast

object (ForecastMetrics)

The forecast for the Keyword Plan campaign at the specific bid.

maxCpcBidMicros

string (int64 format)

The max cpc bid in micros.