• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
23option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
24option java_multiple_files = true;
25option java_outer_classname = "CustomerLabelProto";
26option java_package = "com.google.ads.googleads.v16.resources";
27option objc_class_prefix = "GAA";
28option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
29option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
30
31// Proto file describing the customer label resource.
32
33// Represents a relationship between a customer and a label. This customer may
34// not have access to all the labels attached to it. Additional CustomerLabels
35// may be returned by increasing permissions with login-customer-id.
36message CustomerLabel {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/CustomerLabel"
39    pattern: "customers/{customer_id}/customerLabels/{label_id}"
40  };
41
42  // Immutable. Name of the resource.
43  // Customer label resource names have the form:
44  // `customers/{customer_id}/customerLabels/{label_id}`
45  string resource_name = 1 [
46    (google.api.field_behavior) = IMMUTABLE,
47    (google.api.resource_reference) = {
48      type: "googleads.googleapis.com/CustomerLabel"
49    }
50  ];
51
52  // Output only. The resource name of the customer to which the label is
53  // attached. Read only.
54  optional string customer = 4 [
55    (google.api.field_behavior) = OUTPUT_ONLY,
56    (google.api.resource_reference) = {
57      type: "googleads.googleapis.com/Customer"
58    }
59  ];
60
61  // Output only. The resource name of the label assigned to the customer.
62  //
63  // Note: the Customer ID portion of the label resource name is not
64  // validated when creating a new CustomerLabel.
65  optional string label = 5 [
66    (google.api.field_behavior) = OUTPUT_ONLY,
67    (google.api.resource_reference) = { type: "googleads.googleapis.com/Label" }
68  ];
69}
70