Package com.google.ads.googleads.v15.resources

Class CustomerSearchTermInsight.Builder

  • All Implemented Interfaces:
    CustomerSearchTermInsightOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    CustomerSearchTermInsight
    public static final class CustomerSearchTermInsight.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>
implements CustomerSearchTermInsightOrBuilder
     A Customer search term view.
 Historical data is available starting March 2023.
    Protobuf type google.ads.googleads.v15.resources.CustomerSearchTermInsight

    • Method Detail

      • 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.Builder<CustomerSearchTermInsight.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>

      • getDefaultInstanceForType

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

      • build

        public CustomerSearchTermInsight build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public CustomerSearchTermInsight buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setField

        public CustomerSearchTermInsight.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>

      • setRepeatedField

        public CustomerSearchTermInsight.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>

      • addRepeatedField

        public CustomerSearchTermInsight.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>

      • isInitialized

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

      • mergeFrom

        public CustomerSearchTermInsight.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CustomerSearchTermInsight.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Output only. The resource name of the customer level search term insight.
 Customer level search term insight resource names have the form:

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface CustomerSearchTermInsightOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the customer level search term insight.
 Customer level search term insight resource names have the form:

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface CustomerSearchTermInsightOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public CustomerSearchTermInsight.Builder setResourceName​(java.lang.String value)
         Output only. The resource name of the customer level search term insight.
 Customer level search term insight resource names have the form:

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The resourceName to set.
        Returns:
        This builder for chaining.

      • clearResourceName

        public CustomerSearchTermInsight.Builder clearResourceName()
         Output only. The resource name of the customer level search term insight.
 Customer level search term insight resource names have the form:

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public CustomerSearchTermInsight.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the customer level search term insight.
 Customer level search term insight resource names have the form:

 `customers/{customer_id}/customerSearchTermInsights/{category_id}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for resourceName to set.
        Returns:
        This builder for chaining.

      • hasCategoryLabel

        public boolean hasCategoryLabel()
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCategoryLabel in interface CustomerSearchTermInsightOrBuilder
        Returns:
        Whether the categoryLabel field is set.

      • getCategoryLabel

        public java.lang.String getCategoryLabel()
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCategoryLabel in interface CustomerSearchTermInsightOrBuilder
        Returns:
        The categoryLabel.

      • getCategoryLabelBytes

        public com.google.protobuf.ByteString getCategoryLabelBytes()
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCategoryLabelBytes in interface CustomerSearchTermInsightOrBuilder
        Returns:
        The bytes for categoryLabel.

      • setCategoryLabel

        public CustomerSearchTermInsight.Builder setCategoryLabel​(java.lang.String value)
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The categoryLabel to set.
        Returns:
        This builder for chaining.

      • clearCategoryLabel

        public CustomerSearchTermInsight.Builder clearCategoryLabel()
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setCategoryLabelBytes

        public CustomerSearchTermInsight.Builder setCategoryLabelBytes​(com.google.protobuf.ByteString value)
         Output only. The label for the search category. An empty string denotes the
 catch-all category for search terms that didn't fit into another category.
        optional string category_label = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for categoryLabel to set.
        Returns:
        This builder for chaining.

      • hasId

        public boolean hasId()
         Output only. The ID of the insight.
        optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface CustomerSearchTermInsightOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. The ID of the insight.
        optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface CustomerSearchTermInsightOrBuilder
        Returns:
        The id.

      • setId

        public CustomerSearchTermInsight.Builder setId​(long value)
         Output only. The ID of the insight.
        optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public CustomerSearchTermInsight.Builder clearId()
         Output only. The ID of the insight.
        optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final CustomerSearchTermInsight.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>

      • mergeUnknownFields

        public final CustomerSearchTermInsight.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CustomerSearchTermInsight.Builder>