Package com.google.ads.googleads.v18.resources

Interface GoogleAdsFieldOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GoogleAdsField, GoogleAdsField.Builder
public interface GoogleAdsFieldOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      String getResourceName()
       Output only. The resource name of the artifact.
 Artifact resource names have the form:

 `googleAdsFields/{name}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the artifact.
 Artifact resource names have the form:

 `googleAdsFields/{name}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.

    • hasName

      boolean hasName()
       Output only. The name of the artifact.
      optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Output only. The name of the artifact.
      optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The name of the artifact.
      optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getCategoryValue

      int getCategoryValue()
       Output only. The category of the artifact.
      .google.ads.googleads.v18.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for category.

    • getCategory

      GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory getCategory()
       Output only. The category of the artifact.
      .google.ads.googleads.v18.enums.GoogleAdsFieldCategoryEnum.GoogleAdsFieldCategory category = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The category.

    • hasSelectable

      boolean hasSelectable()
       Output only. Whether the artifact can be used in a SELECT clause in search
 queries.
      optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the selectable field is set.

    • getSelectable

      boolean getSelectable()
       Output only. Whether the artifact can be used in a SELECT clause in search
 queries.
      optional bool selectable = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The selectable.

    • hasFilterable

      boolean hasFilterable()
       Output only. Whether the artifact can be used in a WHERE clause in search
 queries.
      optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the filterable field is set.

    • getFilterable

      boolean getFilterable()
       Output only. Whether the artifact can be used in a WHERE clause in search
 queries.
      optional bool filterable = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The filterable.

    • hasSortable

      boolean hasSortable()
       Output only. Whether the artifact can be used in a ORDER BY clause in
 search queries.
      optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the sortable field is set.

    • getSortable

      boolean getSortable()
       Output only. Whether the artifact can be used in a ORDER BY clause in
 search queries.
      optional bool sortable = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The sortable.

    • getSelectableWithList

      List<String> getSelectableWithList()
       Output only. The names of all resources, segments, and metrics that are
 selectable with the described artifact.
      repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the selectableWith.

    • getSelectableWithCount

      int getSelectableWithCount()
       Output only. The names of all resources, segments, and metrics that are
 selectable with the described artifact.
      repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of selectableWith.

    • getSelectableWith

      String getSelectableWith(int index)
       Output only. The names of all resources, segments, and metrics that are
 selectable with the described artifact.
      repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectableWith at the given index.

    • getSelectableWithBytes

      com.google.protobuf.ByteString getSelectableWithBytes(int index)
       Output only. The names of all resources, segments, and metrics that are
 selectable with the described artifact.
      repeated string selectable_with = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectableWith at the given index.

    • getAttributeResourcesList

      List<String> getAttributeResourcesList()
       Output only. The names of all resources that are selectable with the
 described artifact. Fields from these resources do not segment metrics when
 included in search queries.

 This field is only set for artifacts whose category is RESOURCE.
      repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the attributeResources.

    • getAttributeResourcesCount

      int getAttributeResourcesCount()
       Output only. The names of all resources that are selectable with the
 described artifact. Fields from these resources do not segment metrics when
 included in search queries.

 This field is only set for artifacts whose category is RESOURCE.
      repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of attributeResources.

    • getAttributeResources

      String getAttributeResources(int index)
       Output only. The names of all resources that are selectable with the
 described artifact. Fields from these resources do not segment metrics when
 included in search queries.

 This field is only set for artifacts whose category is RESOURCE.
      repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The attributeResources at the given index.

    • getAttributeResourcesBytes

      com.google.protobuf.ByteString getAttributeResourcesBytes(int index)
       Output only. The names of all resources that are selectable with the
 described artifact. Fields from these resources do not segment metrics when
 included in search queries.

 This field is only set for artifacts whose category is RESOURCE.
      repeated string attribute_resources = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the attributeResources at the given index.

    • getMetricsList

      List<String> getMetricsList()
       Output only. This field lists the names of all metrics that are selectable
 with the described artifact when it is used in the FROM clause. It is only
 set for artifacts whose category is RESOURCE.
      repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the metrics.

    • getMetricsCount

      int getMetricsCount()
       Output only. This field lists the names of all metrics that are selectable
 with the described artifact when it is used in the FROM clause. It is only
 set for artifacts whose category is RESOURCE.
      repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of metrics.

    • getMetrics

      String getMetrics(int index)
       Output only. This field lists the names of all metrics that are selectable
 with the described artifact when it is used in the FROM clause. It is only
 set for artifacts whose category is RESOURCE.
      repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The metrics at the given index.

    • getMetricsBytes

      com.google.protobuf.ByteString getMetricsBytes(int index)
       Output only. This field lists the names of all metrics that are selectable
 with the described artifact when it is used in the FROM clause. It is only
 set for artifacts whose category is RESOURCE.
      repeated string metrics = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the metrics at the given index.

    • getSegmentsList

      List<String> getSegmentsList()
       Output only. This field lists the names of all artifacts, whether a segment
 or another resource, that segment metrics when included in search queries
 and when the described artifact is used in the FROM clause. It is only set
 for artifacts whose category is RESOURCE.
      repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the segments.

    • getSegmentsCount

      int getSegmentsCount()
       Output only. This field lists the names of all artifacts, whether a segment
 or another resource, that segment metrics when included in search queries
 and when the described artifact is used in the FROM clause. It is only set
 for artifacts whose category is RESOURCE.
      repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of segments.

    • getSegments

      String getSegments(int index)
       Output only. This field lists the names of all artifacts, whether a segment
 or another resource, that segment metrics when included in search queries
 and when the described artifact is used in the FROM clause. It is only set
 for artifacts whose category is RESOURCE.
      repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The segments at the given index.

    • getSegmentsBytes

      com.google.protobuf.ByteString getSegmentsBytes(int index)
       Output only. This field lists the names of all artifacts, whether a segment
 or another resource, that segment metrics when included in search queries
 and when the described artifact is used in the FROM clause. It is only set
 for artifacts whose category is RESOURCE.
      repeated string segments = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the segments at the given index.

    • getEnumValuesList

      List<String> getEnumValuesList()
       Output only. Values the artifact can assume if it is a field of type ENUM.

 This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
      repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enumValues.

    • getEnumValuesCount

      int getEnumValuesCount()
       Output only. Values the artifact can assume if it is a field of type ENUM.

 This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
      repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of enumValues.

    • getEnumValues

      String getEnumValues(int index)
       Output only. Values the artifact can assume if it is a field of type ENUM.

 This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
      repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The enumValues at the given index.

    • getEnumValuesBytes

      com.google.protobuf.ByteString getEnumValuesBytes(int index)
       Output only. Values the artifact can assume if it is a field of type ENUM.

 This field is only set for artifacts of category SEGMENT or ATTRIBUTE.
      repeated string enum_values = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the enumValues at the given index.

    • getDataTypeValue

      int getDataTypeValue()
       Output only. This field determines the operators that can be used with the
 artifact in WHERE clauses.
      .google.ads.googleads.v18.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for dataType.

    • getDataType

      GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType getDataType()
       Output only. This field determines the operators that can be used with the
 artifact in WHERE clauses.
      .google.ads.googleads.v18.enums.GoogleAdsFieldDataTypeEnum.GoogleAdsFieldDataType data_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The dataType.

    • hasTypeUrl

      boolean hasTypeUrl()
       Output only. The URL of proto describing the artifact's data type.
      optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the typeUrl field is set.

    • getTypeUrl

      String getTypeUrl()
       Output only. The URL of proto describing the artifact's data type.
      optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The typeUrl.

    • getTypeUrlBytes

      com.google.protobuf.ByteString getTypeUrlBytes()
       Output only. The URL of proto describing the artifact's data type.
      optional string type_url = 30 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for typeUrl.

    • hasIsRepeated

      boolean hasIsRepeated()
       Output only. Whether the field artifact is repeated.
      optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the isRepeated field is set.

    • getIsRepeated

      boolean getIsRepeated()
       Output only. Whether the field artifact is repeated.
      optional bool is_repeated = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The isRepeated.