legacy-libs/google-proto-files/google/ads/googleads/v1/resources/google_ads_field.proto

   1 // Copyright 2019 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v1.resources;
  19
  20 import "google/ads/googleads/v1/enums/google_ads_field_category.proto";
  21 import "google/ads/googleads/v1/enums/google_ads_field_data_type.proto";
  22 import "google/protobuf/wrappers.proto";
  23 import "google/api/annotations.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "GoogleAdsFieldProto";
  29 option java_package = "com.google.ads.googleads.v1.resources";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  32 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  33 // Proto file describing the Google Ads Field resource.
  34
  35 // A field or resource (artifact) used by GoogleAdsService.
  36 message GoogleAdsField {
  37   // The resource name of the artifact.
  38   // Artifact resource names have the form:
  39   //
  40   // `googleAdsFields/{name}`
  41   string resource_name = 1;
  42
  43   // The name of the artifact.
  44   google.protobuf.StringValue name = 2;
  45
  46   // The category of the artifact.
  47   google.ads.googleads.v1.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3;
  48
  49   // Whether the artifact can be used in a SELECT clause in search
  50   // queries.
  51   google.protobuf.BoolValue selectable = 4;
  52
  53   // Whether the artifact can be used in a WHERE clause in search
  54   // queries.
  55   google.protobuf.BoolValue filterable = 5;
  56
  57   // Whether the artifact can be used in a ORDER BY clause in search
  58   // queries.
  59   google.protobuf.BoolValue sortable = 6;
  60
  61   // The names of all resources, segments, and metrics that are selectable with
  62   // the described artifact.
  63   repeated google.protobuf.StringValue selectable_with = 7;
  64
  65   // The names of all resources that are selectable with the described
  66   // artifact. Fields from these resources do not segment metrics when included
  67   // in search queries.
  68   //
  69   // This field is only set for artifacts whose category is RESOURCE.
  70   repeated google.protobuf.StringValue attribute_resources = 8;
  71
  72   // At and beyond version V1 this field lists the names of all metrics that are
  73   // selectable with the described artifact when it is used in the FROM clause.
  74   // It is only set for artifacts whose category is RESOURCE.
  75   //
  76   // Before version V1 this field lists the names of all metrics that are
  77   // selectable with the described artifact. It is only set for artifacts whose
  78   // category is either RESOURCE or SEGMENT
  79   repeated google.protobuf.StringValue metrics = 9;
  80
  81   // At and beyond version V1 this field lists the names of all artifacts,
  82   // whether a segment or another resource, that segment metrics when included
  83   // in search queries and when the described artifact is used in the FROM
  84   // clause. It is only set for artifacts whose category is RESOURCE.
  85   //
  86   // Before version V1 this field lists the names of all artifacts, whether a
  87   // segment or another resource, that segment metrics when included in search
  88   // queries. It is only set for artifacts of category RESOURCE, SEGMENT or
  89   // METRIC.
  90   repeated google.protobuf.StringValue segments = 10;
  91
  92   // Values the artifact can assume if it is a field of type ENUM.
  93   //
  94   // This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
  95   repeated google.protobuf.StringValue enum_values = 11;
  96
  97   // This field determines the operators that can be used with the artifact
  98   // in WHERE clauses.
  99   google.ads.googleads.v1.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12;
 100
 101   // The URL of proto describing the artifact's data type.
 102   google.protobuf.StringValue type_url = 13;
 103
 104   // Whether the field artifact is repeated.
 105   google.protobuf.BoolValue is_repeated = 14;
 106 }