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

Class SearchTermView.Builder

  • All Implemented Interfaces:
    SearchTermViewOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    SearchTermView
    public static final class SearchTermView.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchTermView.Builder>
implements SearchTermViewOrBuilder
     A search term view with metrics aggregated by search term at the ad group
 level.
    Protobuf type google.ads.googleads.v10.resources.SearchTermView

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

      • clear

        public SearchTermView.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchTermView.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<SearchTermView.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public SearchTermView.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchTermView.Builder>

      • setField

        public SearchTermView.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<SearchTermView.Builder>

      • clearField

        public SearchTermView.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchTermView.Builder>

      • clearOneof

        public SearchTermView.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchTermView.Builder>

      • setRepeatedField

        public SearchTermView.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<SearchTermView.Builder>

      • addRepeatedField

        public SearchTermView.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<SearchTermView.Builder>

      • mergeFrom

        public SearchTermView.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchTermView.Builder>

      • isInitialized

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

      • mergeFrom

        public SearchTermView.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<SearchTermView.Builder>
        Throws:
        java.io.IOException

      • getResourceName

        public java.lang.String getResourceName()
         Output only. The resource name of the search term view.
 Search term view resource names have the form:
 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface SearchTermViewOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the search term view.
 Search term view resource names have the form:
 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface SearchTermViewOrBuilder
        Returns:
        The bytes for resourceName.

      • setResourceName

        public SearchTermView.Builder setResourceName​(java.lang.String value)
         Output only. The resource name of the search term view.
 Search term view resource names have the form:
 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
        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 SearchTermView.Builder clearResourceName()
         Output only. The resource name of the search term view.
 Search term view resource names have the form:
 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setResourceNameBytes

        public SearchTermView.Builder setResourceNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the search term view.
 Search term view resource names have the form:
 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
        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.

      • hasSearchTerm

        public boolean hasSearchTerm()
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSearchTerm in interface SearchTermViewOrBuilder
        Returns:
        Whether the searchTerm field is set.

      • getSearchTerm

        public java.lang.String getSearchTerm()
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSearchTerm in interface SearchTermViewOrBuilder
        Returns:
        The searchTerm.

      • getSearchTermBytes

        public com.google.protobuf.ByteString getSearchTermBytes()
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSearchTermBytes in interface SearchTermViewOrBuilder
        Returns:
        The bytes for searchTerm.

      • setSearchTerm

        public SearchTermView.Builder setSearchTerm​(java.lang.String value)
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The searchTerm to set.
        Returns:
        This builder for chaining.

      • clearSearchTerm

        public SearchTermView.Builder clearSearchTerm()
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setSearchTermBytes

        public SearchTermView.Builder setSearchTermBytes​(com.google.protobuf.ByteString value)
         Output only. The search term.
        optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for searchTerm to set.
        Returns:
        This builder for chaining.

      • hasAdGroup

        public boolean hasAdGroup()
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        hasAdGroup in interface SearchTermViewOrBuilder
        Returns:
        Whether the adGroup field is set.

      • getAdGroup

        public java.lang.String getAdGroup()
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroup in interface SearchTermViewOrBuilder
        Returns:
        The adGroup.

      • getAdGroupBytes

        public com.google.protobuf.ByteString getAdGroupBytes()
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupBytes in interface SearchTermViewOrBuilder
        Returns:
        The bytes for adGroup.

      • setAdGroup

        public SearchTermView.Builder setAdGroup​(java.lang.String value)
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The adGroup to set.
        Returns:
        This builder for chaining.

      • clearAdGroup

        public SearchTermView.Builder clearAdGroup()
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setAdGroupBytes

        public SearchTermView.Builder setAdGroupBytes​(com.google.protobuf.ByteString value)
         Output only. The ad group the search term served in.
        optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for adGroup to set.
        Returns:
        This builder for chaining.

      • getStatusValue

        public int getStatusValue()
         Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
        .google.ads.googleads.v10.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface SearchTermViewOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • setStatusValue

        public SearchTermView.Builder setStatusValue​(int value)
         Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
        .google.ads.googleads.v10.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for status to set.
        Returns:
        This builder for chaining.

      • setStatus

        public SearchTermView.Builder setStatus​(SearchTermTargetingStatusEnum.SearchTermTargetingStatus value)
         Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
        .google.ads.googleads.v10.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public SearchTermView.Builder clearStatus()
         Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
        .google.ads.googleads.v10.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final SearchTermView.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<SearchTermView.Builder>

      • mergeUnknownFields

        public final SearchTermView.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<SearchTermView.Builder>