Package com.google.ads.googleads.v10.resources

Class GoogleAdsField

  • All Implemented Interfaces:
    GoogleAdsFieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class GoogleAdsField
extends com.google.protobuf.GeneratedMessageV3
implements GoogleAdsFieldOrBuilder
     A field or resource (artifact) used by GoogleAdsService.
    Protobuf type google.ads.googleads.v10.resources.GoogleAdsField
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceName

        public java.lang.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) = { ... }
        Specified by:
        getResourceName in interface GoogleAdsFieldOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public 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) = { ... }
        Specified by:
        getResourceNameBytes in interface GoogleAdsFieldOrBuilder
        Returns:
        The bytes for resourceName.

      • hasName

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

      • getName

        public java.lang.String getName()
         Output only. The name of the artifact.
        optional string name = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface GoogleAdsFieldOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • getCategoryValue

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

      • hasSelectable

        public 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];
        Specified by:
        hasSelectable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the selectable field is set.

      • getSelectable

        public 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];
        Specified by:
        getSelectable in interface GoogleAdsFieldOrBuilder
        Returns:
        The selectable.

      • hasFilterable

        public 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];
        Specified by:
        hasFilterable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the filterable field is set.

      • getFilterable

        public 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];
        Specified by:
        getFilterable in interface GoogleAdsFieldOrBuilder
        Returns:
        The filterable.

      • hasSortable

        public 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];
        Specified by:
        hasSortable in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the sortable field is set.

      • getSortable

        public 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];
        Specified by:
        getSortable in interface GoogleAdsFieldOrBuilder
        Returns:
        The sortable.

      • getSelectableWithList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getSelectableWithList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the selectableWith.

      • getSelectableWithCount

        public 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];
        Specified by:
        getSelectableWithCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of selectableWith.

      • getSelectableWith

        public java.lang.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];
        Specified by:
        getSelectableWith in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The selectableWith at the given index.

      • getSelectableWithBytes

        public 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];
        Specified by:
        getSelectableWithBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the selectableWith at the given index.

      • getAttributeResourcesList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getAttributeResourcesList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the attributeResources.

      • getAttributeResourcesCount

        public 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];
        Specified by:
        getAttributeResourcesCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of attributeResources.

      • getAttributeResources

        public java.lang.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];
        Specified by:
        getAttributeResources in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The attributeResources at the given index.

      • getAttributeResourcesBytes

        public 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];
        Specified by:
        getAttributeResourcesBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the attributeResources at the given index.

      • getMetricsList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getMetricsList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the metrics.

      • getMetricsCount

        public 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];
        Specified by:
        getMetricsCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of metrics.

      • getMetrics

        public java.lang.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];
        Specified by:
        getMetrics in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The metrics at the given index.

      • getMetricsBytes

        public 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];
        Specified by:
        getMetricsBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the metrics at the given index.

      • getSegmentsList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getSegmentsList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the segments.

      • getSegmentsCount

        public 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];
        Specified by:
        getSegmentsCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of segments.

      • getSegments

        public java.lang.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];
        Specified by:
        getSegments in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The segments at the given index.

      • getSegmentsBytes

        public 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];
        Specified by:
        getSegmentsBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the segments at the given index.

      • getEnumValuesList

        public com.google.protobuf.ProtocolStringList 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];
        Specified by:
        getEnumValuesList in interface GoogleAdsFieldOrBuilder
        Returns:
        A list containing the enumValues.

      • getEnumValuesCount

        public 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];
        Specified by:
        getEnumValuesCount in interface GoogleAdsFieldOrBuilder
        Returns:
        The count of enumValues.

      • getEnumValues

        public java.lang.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];
        Specified by:
        getEnumValues in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The enumValues at the given index.

      • getEnumValuesBytes

        public 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];
        Specified by:
        getEnumValuesBytes in interface GoogleAdsFieldOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the enumValues at the given index.

      • getDataTypeValue

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

      • getDataType

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

      • hasTypeUrl

        public 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];
        Specified by:
        hasTypeUrl in interface GoogleAdsFieldOrBuilder
        Returns:
        Whether the typeUrl field is set.

      • getTypeUrl

        public java.lang.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];
        Specified by:
        getTypeUrl in interface GoogleAdsFieldOrBuilder
        Returns:
        The typeUrl.

      • getTypeUrlBytes

        public 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];
        Specified by:
        getTypeUrlBytes in interface GoogleAdsFieldOrBuilder
        Returns:
        The bytes for typeUrl.

      • hasIsRepeated

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

      • getIsRepeated

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static GoogleAdsField parseFrom​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(java.nio.ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static GoogleAdsField parseFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static GoogleAdsField parseFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static GoogleAdsField parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static GoogleAdsField parseDelimitedFrom​(java.io.InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static GoogleAdsField parseFrom​(com.google.protobuf.CodedInputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static GoogleAdsField parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public GoogleAdsField.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public GoogleAdsField.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected GoogleAdsField.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static GoogleAdsField getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<GoogleAdsField> parser()

      • getParserForType

        public com.google.protobuf.Parser<GoogleAdsField> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public GoogleAdsField getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder