xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/label.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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.v14.resources;
18
19import "google/ads/googleads/v14/common/text_label.proto";
20import "google/ads/googleads/v14/enums/label_status.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.GoogleAds.V14.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v14/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "LabelProto";
28option java_package = "com.google.ads.googleads.v14.resources";
29option objc_class_prefix = "GAA";
30option php_namespace = "Google\\Ads\\GoogleAds\\V14\\Resources";
31option ruby_package = "Google::Ads::GoogleAds::V14::Resources";
32
33// A label.
34message Label {
35  option (google.api.resource) = {
36    type: "googleads.googleapis.com/Label"
37    pattern: "customers/{customer_id}/labels/{label_id}"
38  };
39
40  // Immutable. Name of the resource.
41  // Label resource names have the form:
42  // `customers/{customer_id}/labels/{label_id}`
43  string resource_name = 1 [
44    (google.api.field_behavior) = IMMUTABLE,
45    (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
46  ];
47
48  // Output only. ID of the label. Read only.
49  optional int64 id = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
50
51  // The name of the label.
52  //
53  // This field is required and should not be empty when creating a new label.
54  //
55  // The length of this string should be between 1 and 80, inclusive.
56  optional string name = 7;
57
58  // Output only. Status of the label. Read only.
59  google.ads.googleads.v14.enums.LabelStatusEnum.LabelStatus status = 4
60      [(google.api.field_behavior) = OUTPUT_ONLY];
61
62  // A type of label displaying text on a colored background.
63  google.ads.googleads.v14.common.TextLabel text_label = 5;
64}
65