1 // Copyright 2019 Google LLC.
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
7 // http://www.apache.org/licenses/LICENSE-2.0
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
18 package google.ads.googleads.v1.resources;
20 import "google/ads/googleads/v1/common/dates.proto";
21 import "google/ads/googleads/v1/enums/keyword_plan_forecast_interval.proto";
22 import "google/protobuf/wrappers.proto";
23 import "google/api/annotations.proto";
25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
27 option java_multiple_files = true;
28 option java_outer_classname = "KeywordPlanProto";
29 option java_package = "com.google.ads.googleads.v1.resources";
30 option objc_class_prefix = "GAA";
31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
32 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
33 // Proto file describing the keyword plan resource.
35 // A Keyword Planner plan.
36 // Max number of saved keyword plans: 10000.
37 // It's possible to remove plans if limit is reached.
39 // The resource name of the Keyword Planner plan.
40 // KeywordPlan resource names have the form:
42 // `customers/{customer_id}/keywordPlans/{kp_plan_id}`
43 string resource_name = 1;
45 // The ID of the keyword plan.
46 google.protobuf.Int64Value id = 2;
48 // The name of the keyword plan.
50 // This field is required and should not be empty when creating new keyword
52 google.protobuf.StringValue name = 3;
54 // The date period used for forecasting the plan.
55 KeywordPlanForecastPeriod forecast_period = 4;
58 // The forecasting period associated with the keyword plan.
59 message KeywordPlanForecastPeriod {
60 // Required. The date used for forecasting the Plan.
62 // A future date range relative to the current date used for forecasting.
63 google.ads.googleads.v1.enums.KeywordPlanForecastIntervalEnum.KeywordPlanForecastInterval date_interval = 1;
65 // The custom date range used for forecasting.
66 // The start and end dates must be in the future. Otherwise, an error will
67 // be returned when the forecasting action is performed.
68 google.ads.googleads.v1.common.DateRange date_range = 2;