legacy-libs/google-proto-files/google/ads/googleads/v0/resources/keyword_plan.proto

   1 // Copyright 2018 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v0.resources;
  19
  20 import "google/ads/googleads/v0/common/dates.proto";
  21 import "google/ads/googleads/v0/enums/keyword_plan_forecast_interval.proto";
  22 import "google/protobuf/wrappers.proto";
  23
  24 option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
  25 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
  26 option java_multiple_files = true;
  27 option java_outer_classname = "KeywordPlanProto";
  28 option java_package = "com.google.ads.googleads.v0.resources";
  29 option objc_class_prefix = "GAA";
  30 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
  31 option ruby_package = "Google::Ads::GoogleAds::V0::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.
  38 message KeywordPlan {
  39   // The resource name of the Keyword Planner plan.
  40   // KeywordPlan resource names have the form:
  41   //
  42   // `customers/{customer_id}/keywordPlans/{kp_plan_id}`
  43   string resource_name = 1;
  44
  45   // The ID of the keyword plan.
  46   google.protobuf.Int64Value id = 2;
  47
  48   // The name of the keyword plan.
  49   //
  50   // This field is required and should not be empty when creating new keyword
  51   // plans.
  52   google.protobuf.StringValue name = 3;
  53
  54   // The date period used for forecasting the plan.
  55   KeywordPlanForecastPeriod forecast_period = 4;
  56 }
  57
  58 // The forecasting period associated with the keyword plan.
  59 message KeywordPlanForecastPeriod {
  60   // Required. The date used for forecasting the Plan.
  61   oneof interval {
  62     // A future date range relative to the current date used for forecasting.
  63     google.ads.googleads.v0.enums.KeywordPlanForecastIntervalEnum
  64         .KeywordPlanForecastInterval date_interval = 1;
  65
  66     // The custom date range used for forecasting.
  67     // The start and end dates must be in the future. Otherwise, an error will
  68     // be returned when the forecasting action is performed.
  69     google.ads.googleads.v0.common.DateRange date_range = 2;
  70   }
  71 }