1// Copyright 2023 Google LLC 2// 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 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 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. 14 15syntax = "proto3"; 16 17package google.ads.googleads.v16.resources; 18 19import "google/ads/googleads/v16/common/dates.proto"; 20import "google/ads/googleads/v16/enums/keyword_plan_forecast_interval.proto"; 21import "google/api/field_behavior.proto"; 22import "google/api/resource.proto"; 23 24option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 26option java_multiple_files = true; 27option java_outer_classname = "KeywordPlanProto"; 28option java_package = "com.google.ads.googleads.v16.resources"; 29option objc_class_prefix = "GAA"; 30option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 31option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 32 33// Proto file describing the keyword plan resource. 34 35// A Keyword Planner plan. 36// Max number of saved keyword plans: 10000. 37// It's possible to remove plans if limit is reached. 38message KeywordPlan { 39 option (google.api.resource) = { 40 type: "googleads.googleapis.com/KeywordPlan" 41 pattern: "customers/{customer_id}/keywordPlans/{keyword_plan_id}" 42 }; 43 44 // Immutable. The resource name of the Keyword Planner plan. 45 // KeywordPlan resource names have the form: 46 // 47 // `customers/{customer_id}/keywordPlans/{kp_plan_id}` 48 string resource_name = 1 [ 49 (google.api.field_behavior) = IMMUTABLE, 50 (google.api.resource_reference) = { 51 type: "googleads.googleapis.com/KeywordPlan" 52 } 53 ]; 54 55 // Output only. The ID of the keyword plan. 56 optional int64 id = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 57 58 // The name of the keyword plan. 59 // 60 // This field is required and should not be empty when creating new keyword 61 // plans. 62 optional string name = 6; 63 64 // The date period used for forecasting the plan. 65 KeywordPlanForecastPeriod forecast_period = 4; 66} 67 68// The forecasting period associated with the keyword plan. 69message KeywordPlanForecastPeriod { 70 // Required. The date used for forecasting the Plan. 71 oneof interval { 72 // A future date range relative to the current date used for forecasting. 73 google.ads.googleads.v16.enums.KeywordPlanForecastIntervalEnum 74 .KeywordPlanForecastInterval date_interval = 1; 75 76 // The custom date range used for forecasting. It cannot be greater than 77 // a year. 78 // The start and end dates must be in the future. Otherwise, an error will 79 // be returned when the forecasting action is performed. 80 // The start and end dates are inclusive. 81 google.ads.googleads.v16.common.DateRange date_range = 2; 82 } 83} 84