xref: /aosp_15_r20/external/googleapis/google/ads/admanager/v1/custom_field_enums.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.admanager.v1;
18
19option csharp_namespace = "Google.Ads.AdManager.V1";
20option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
21option java_multiple_files = true;
22option java_outer_classname = "CustomFieldEnumsProto";
23option java_package = "com.google.ads.admanager.v1";
24option objc_class_prefix = "GAA";
25option php_namespace = "Google\\Ads\\AdManager\\V1";
26
27// Wrapper message for
28// [CustomFieldDataType][google.ads.admanager.v1.CustomFieldDataTypeEnum.CustomFieldDataType]
29message CustomFieldDataTypeEnum {
30  // The data type for a CustomField.
31  enum CustomFieldDataType {
32    // No value specified
33    CUSTOM_FIELD_DATA_TYPE_UNSPECIFIED = 0;
34
35    // A string field
36    //
37    // The max length is 255 characters.
38    STRING = 1;
39
40    // A number field.
41    NUMBER = 2;
42
43    // A "Yes" or "No" toggle field.
44    TOGGLE = 3;
45
46    // A drop-down field.
47    DROP_DOWN = 4;
48  }
49}
50
51// Wrapper message for
52// [CustomFieldEntityType][google.ads.admanager.v1.CustomFieldEntityTypeEnum.CustomFieldEntityType]
53message CustomFieldEntityTypeEnum {
54  // The types of entities that a CustomField can be applied to.
55  enum CustomFieldEntityType {
56    // No value specified
57    CUSTOM_FIELD_ENTITY_TYPE_UNSPECIFIED = 0;
58
59    // The CustomField is applied to LineItems.
60    LINE_ITEM = 1;
61
62    // The CustomField is applied to Orders.
63    ORDER = 2;
64
65    // The CustomField is applied to Creatives.
66    CREATIVE = 3;
67
68    // The CustomField is applied to Proposals.
69    PROPOSAL = 4;
70
71    // The CustomField is applied to ProposalLineItems.
72    PROPOSAL_LINE_ITEM = 5;
73  }
74}
75
76// Wrapper message for
77// [CustomFieldStatus][google.ads.admanager.v1.CustomFieldStatusEnum.CustomFieldStatus]
78message CustomFieldStatusEnum {
79  // The status of the CustomField.
80  enum CustomFieldStatus {
81    // No value specified
82    CUSTOM_FIELD_STATUS_UNSPECIFIED = 0;
83
84    // The CustomField is active.
85    ACTIVE = 1;
86
87    // The CustomField is inactive.
88    INACTIVE = 2;
89  }
90}
91
92// Wrapper message for
93// [CustomFieldVisibility][google.ads.admanager.v1.CustomFieldVisibilityEnum.CustomFieldVisibility]
94message CustomFieldVisibilityEnum {
95  // The visibility level of a CustomField.
96  enum CustomFieldVisibility {
97    // No value specified
98    CUSTOM_FIELD_VISIBILITY_UNSPECIFIED = 0;
99
100    // The CustomField is not visible in the UI and only visible through the
101    // API.
102    HIDDEN = 1;
103
104    // The CustomField is visible in the UI and only editable through the API.
105    READ_ONLY = 2;
106
107    // The CustomField is visible and editable in both the API and UI.
108    EDITABLE = 3;
109  }
110}
111