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

Returns a forecast in the form of a time series for the Keyword Plan over the next 52 weeks. (1) Forecasts closer to the current date are generally more accurate than further out.

(2) The forecast reflects seasonal trends using current and prior traffic patterns. The forecast period of the plan is ignored.

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

HTTP request

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

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

JSON representation
{
  "weeklyTimeSeriesForecasts": [
    {
      object (KeywordPlanWeeklyTimeSeriesForecast)
    }
  ]
}
Fields
weeklyTimeSeriesForecasts[]

object (KeywordPlanWeeklyTimeSeriesForecast)

List of weekly time series forecasts 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.

KeywordPlanWeeklyTimeSeriesForecast

The weekly time series forecast for the keyword plan campaign.

JSON representation
{
  "weeklyForecasts": [
    {
      object (KeywordPlanWeeklyForecast)
    }
  ],
  "keywordPlanCampaign": string
}
Fields
weeklyForecasts[]

object (KeywordPlanWeeklyForecast)

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

keywordPlanCampaign

string

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

customers/{customerId}/keywordPlanCampaigns/{keyword_plan_campaign_id}

KeywordPlanWeeklyForecast

The forecast of the campaign for the week starting startDate.

JSON representation
{
  "forecast": {
    object (ForecastMetrics)
  },
  "startDate": string
}
Fields
forecast

object (ForecastMetrics)

The forecast for the Keyword Plan campaign for the week.

startDate

string

The start date, in yyyy-mm-dd format. This date is inclusive.