// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.ads.googleads.v17.resources;

import "google/ads/googleads/v17/enums/keyword_match_type.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";

option csharp_namespace = "Google.Ads.GoogleAds.V17.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v17/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "KeywordPlanAdGroupKeywordProto";
option java_package = "com.google.ads.googleads.v17.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V17\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V17::Resources";

// Proto file describing the keyword plan ad group keyword resource.

// A Keyword Plan ad group keyword.
// Max number of keyword plan keywords per plan: 10000.
message KeywordPlanAdGroupKeyword {
  option (google.api.resource) = {
    type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
    pattern: "customers/{customer_id}/keywordPlanAdGroupKeywords/{keyword_plan_ad_group_keyword_id}"
  };

  // Immutable. The resource name of the Keyword Plan ad group keyword.
  // KeywordPlanAdGroupKeyword resource names have the form:
  //
  // `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
  string resource_name = 1 [
    (google.api.field_behavior) = IMMUTABLE,
    (google.api.resource_reference) = {
      type: "googleads.googleapis.com/KeywordPlanAdGroupKeyword"
    }
  ];

  // The Keyword Plan ad group to which this keyword belongs.
  optional string keyword_plan_ad_group = 8 [(google.api.resource_reference) = {
    type: "googleads.googleapis.com/KeywordPlanAdGroup"
  }];

  // Output only. The ID of the Keyword Plan keyword.
  optional int64 id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];

  // The keyword text.
  optional string text = 10;

  // The keyword match type.
  google.ads.googleads.v17.enums.KeywordMatchTypeEnum.KeywordMatchType
      match_type = 5;

  // A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
  // is the same as the account currency code. This will override any CPC bid
  // set at the keyword plan ad group level. Not applicable for negative
  // keywords. (negative = true) This field is Optional.
  optional int64 cpc_bid_micros = 11;

  // Immutable. If true, the keyword is negative.
  optional bool negative = 12 [(google.api.field_behavior) = IMMUTABLE];
}
