xref: /aosp_15_r20/external/googleapis/google/ads/searchads360/v0/resources/custom_column.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.searchads360.v0.resources;
18
19import "google/ads/searchads360/v0/enums/custom_column_value_type.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "CustomColumnProto";
27option java_package = "com.google.ads.searchads360.v0.resources";
28option objc_class_prefix = "GASA360";
29option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
30option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
31
32// Proto file describing the Custom Column resource.
33
34// A custom column.
35// See Search Ads 360 custom column at
36// https://support.google.com/sa360/answer/9633916
37message CustomColumn {
38  option (google.api.resource) = {
39    type: "searchads360.googleapis.com/CustomColumn"
40    pattern: "customers/{customer_id}/customColumns/{custom_column_id}"
41  };
42
43  // Immutable. The resource name of the custom column.
44  // Custom column resource names have the form:
45  //
46  // `customers/{customer_id}/customColumns/{custom_column_id}`
47  string resource_name = 1 [
48    (google.api.field_behavior) = IMMUTABLE,
49    (google.api.resource_reference) = {
50      type: "searchads360.googleapis.com/CustomColumn"
51    }
52  ];
53
54  // Output only. ID of the custom column.
55  int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
56
57  // Output only. User-defined name of the custom column.
58  string name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
59
60  // Output only. User-defined description of the custom column.
61  string description = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
62
63  // Output only. The type of the result value of the custom column.
64  google.ads.searchads360.v0.enums.CustomColumnValueTypeEnum
65      .CustomColumnValueType value_type = 5
66      [(google.api.field_behavior) = OUTPUT_ONLY];
67
68  // Output only. True when the custom column is referring to one or more
69  // attributes.
70  bool references_attributes = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
71
72  // Output only. True when the custom column is referring to one or more
73  // metrics.
74  bool references_metrics = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
75
76  // Output only. True when the custom column is available to be used in the
77  // query of SearchAds360Service.Search and SearchAds360Service.SearchStream.
78  bool queryable = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
79
80  // Output only. The list of the referenced system columns of this custom
81  // column. For example, A custom column "sum of impressions and clicks" has
82  // referenced system columns of {"metrics.clicks", "metrics.impressions"}.
83  repeated string referenced_system_columns = 9
84      [(google.api.field_behavior) = OUTPUT_ONLY];
85}
86