xref: /aosp_15_r20/external/googleapis/google/ads/googleads/v14/resources/customizer_attribute.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/enums/customizer_attribute_status.proto";
20import "google/ads/googleads/v14/enums/customizer_attribute_type.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 = "CustomizerAttributeProto";
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 customizer attribute.
34// Use CustomerCustomizer, CampaignCustomizer, AdGroupCustomizer, or
35// AdGroupCriterionCustomizer to associate a customizer attribute and
36// set its value at the customer, campaign, ad group, or ad group criterion
37// level, respectively.
38message CustomizerAttribute {
39  option (google.api.resource) = {
40    type: "googleads.googleapis.com/CustomizerAttribute"
41    pattern: "customers/{customer_id}/customizerAttributes/{customizer_attribute_id}"
42  };
43
44  // Immutable. The resource name of the customizer attribute.
45  // Customizer Attribute resource names have the form:
46  //
47  // `customers/{customer_id}/customizerAttributes/{customizer_attribute_id}`
48  string resource_name = 1 [
49    (google.api.field_behavior) = IMMUTABLE,
50    (google.api.resource_reference) = {
51      type: "googleads.googleapis.com/CustomizerAttribute"
52    }
53  ];
54
55  // Output only. The ID of the customizer attribute.
56  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
57
58  // Required. Immutable. Name of the customizer attribute. Required. It must
59  // have a minimum length of 1 and maximum length of 40. Name of an enabled
60  // customizer attribute must be unique (case insensitive).
61  string name = 3 [
62    (google.api.field_behavior) = REQUIRED,
63    (google.api.field_behavior) = IMMUTABLE
64  ];
65
66  // Immutable. The type of the customizer attribute.
67  google.ads.googleads.v14.enums.CustomizerAttributeTypeEnum
68      .CustomizerAttributeType type = 4
69      [(google.api.field_behavior) = IMMUTABLE];
70
71  // Output only. The status of the customizer attribute.
72  google.ads.googleads.v14.enums.CustomizerAttributeStatusEnum
73      .CustomizerAttributeStatus status = 5
74      [(google.api.field_behavior) = OUTPUT_ONLY];
75}
76