Learn more about migrating to the Google Ads API by watching our latest webinar

KeywordPlanService

Service to manage keyword plans.

GenerateForecastCurve

rpc GenerateForecastCurve(GenerateForecastCurveRequest) returns (GenerateForecastCurveResponse)

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

GenerateForecastMetrics

rpc GenerateForecastMetrics(GenerateForecastMetricsRequest) returns (GenerateForecastMetricsResponse)

Returns the requested Keyword Plan forecasts.

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

GenerateForecastTimeSeries

rpc GenerateForecastTimeSeries(GenerateForecastTimeSeriesRequest) returns (GenerateForecastTimeSeriesResponse)

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

GenerateHistoricalMetrics

rpc GenerateHistoricalMetrics(GenerateHistoricalMetricsRequest) returns (GenerateHistoricalMetricsResponse)

Returns the requested Keyword Plan historical metrics.

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

GetKeywordPlan

rpc GetKeywordPlan(GetKeywordPlanRequest) returns (KeywordPlan)

Returns the requested plan in full detail.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

MutateKeywordPlans

rpc MutateKeywordPlans(MutateKeywordPlansRequest) returns (MutateKeywordPlansResponse)

Creates, updates, or removes keyword plans. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError DatabaseError FieldError HeaderError InternalError KeywordPlanError MutateError NewResourceCreationError QuotaError RequestError ResourceCountLimitExceededError StringLengthError

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.