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

Class CampaignSearchTermInsight.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CampaignSearchTermInsight.Builder>
com.google.ads.googleads.v18.resources.CampaignSearchTermInsight.Builder
All Implemented Interfaces:
CampaignSearchTermInsightOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CampaignSearchTermInsight
public static final class CampaignSearchTermInsight.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CampaignSearchTermInsight.Builder> implements CampaignSearchTermInsightOrBuilder
 A Campaign search term view.
 Historical data is available starting March 2023.
Protobuf type google.ads.googleads.v18.resources.CampaignSearchTermInsight

  • Method Details

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public CampaignSearchTermInsight.Builder mergeFrom(CampaignSearchTermInsight other)

    • isInitialized

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

    • mergeFrom

      public CampaignSearchTermInsight.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<CampaignSearchTermInsight.Builder>
      Throws:
      IOException

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

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

    • getResourceNameBytes

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

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

    • setResourceName

      public CampaignSearchTermInsight.Builder setResourceName(String value)
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

 `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{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 CampaignSearchTermInsight.Builder clearResourceName()
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

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

    • setResourceNameBytes

      public CampaignSearchTermInsight.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Output only. The resource name of the campaign level search term insight.
 Campaign level search term insight resource names have the form:

 `customers/{customer_id}/campaignSearchTermInsights/{campaign_id}~{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 CampaignSearchTermInsightOrBuilder
      Returns:
      Whether the categoryLabel field is set.

    • getCategoryLabel

      public 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 CampaignSearchTermInsightOrBuilder
      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 CampaignSearchTermInsightOrBuilder
      Returns:
      The bytes for categoryLabel.

    • setCategoryLabel

      public CampaignSearchTermInsight.Builder setCategoryLabel(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 CampaignSearchTermInsight.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 CampaignSearchTermInsight.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 CampaignSearchTermInsightOrBuilder
      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 CampaignSearchTermInsightOrBuilder
      Returns:
      The id.

    • setId

      public CampaignSearchTermInsight.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 CampaignSearchTermInsight.Builder clearId()
       Output only. The ID of the insight.
      optional int64 id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasCampaignId

      public boolean hasCampaignId()
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCampaignId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      Whether the campaignId field is set.

    • getCampaignId

      public long getCampaignId()
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCampaignId in interface CampaignSearchTermInsightOrBuilder
      Returns:
      The campaignId.

    • setCampaignId

      public CampaignSearchTermInsight.Builder setCampaignId(long value)
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The campaignId to set.
      Returns:
      This builder for chaining.

    • clearCampaignId

      public CampaignSearchTermInsight.Builder clearCampaignId()
       Output only. The ID of the campaign.
      optional int64 campaign_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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