Class BrandSentimentInsight.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BrandSentimentInsight.Builder>
com.google.ads.googleads.v25.services.BrandSentimentInsight.Builder
All Implemented Interfaces:
BrandSentimentInsightOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
BrandSentimentInsight

public static final class BrandSentimentInsight.Builder extends com.google.protobuf.GeneratedMessage.Builder<BrandSentimentInsight.Builder> implements BrandSentimentInsightOrBuilder
 Brand sentiment for a specific month. Measuring brand sentiment involves
 using AI models to analyze YouTube video content related to the brand,
 categorizing the sentiment as positive, negative, or neutral.
 Only the video content itself is analyzed; user comments are not included.
 The AI models are powered by Gemini and can make mistakes.
 
Protobuf type google.ads.googleads.v25.services.BrandSentimentInsight
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<BrandSentimentInsight.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.GeneratedMessage.Builder<BrandSentimentInsight.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.GeneratedMessage.Builder<BrandSentimentInsight.Builder>
    • getDefaultInstanceForType

      public BrandSentimentInsight getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public BrandSentimentInsight.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<BrandSentimentInsight.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<BrandSentimentInsight.Builder>
    • mergeFrom

      public BrandSentimentInsight.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<BrandSentimentInsight.Builder>
      Throws:
      IOException
    • getMonth

      public String getMonth()
       The month that the brand sentiment represents in the string format
       "YYYY-MM".
       
      string month = 1;
      Specified by:
      getMonth in interface BrandSentimentInsightOrBuilder
      Returns:
      The month.
    • getMonthBytes

      public com.google.protobuf.ByteString getMonthBytes()
       The month that the brand sentiment represents in the string format
       "YYYY-MM".
       
      string month = 1;
      Specified by:
      getMonthBytes in interface BrandSentimentInsightOrBuilder
      Returns:
      The bytes for month.
    • setMonth

      public BrandSentimentInsight.Builder setMonth(String value)
       The month that the brand sentiment represents in the string format
       "YYYY-MM".
       
      string month = 1;
      Parameters:
      value - The month to set.
      Returns:
      This builder for chaining.
    • clearMonth

      public BrandSentimentInsight.Builder clearMonth()
       The month that the brand sentiment represents in the string format
       "YYYY-MM".
       
      string month = 1;
      Returns:
      This builder for chaining.
    • setMonthBytes

      public BrandSentimentInsight.Builder setMonthBytes(com.google.protobuf.ByteString value)
       The month that the brand sentiment represents in the string format
       "YYYY-MM".
       
      string month = 1;
      Parameters:
      value - The bytes for month to set.
      Returns:
      This builder for chaining.
    • getHasInsufficientData

      public boolean getHasInsufficientData()
       When true, there is insufficient data to calculate the brand sentiment.
       
      bool has_insufficient_data = 2;
      Specified by:
      getHasInsufficientData in interface BrandSentimentInsightOrBuilder
      Returns:
      The hasInsufficientData.
    • setHasInsufficientData

      public BrandSentimentInsight.Builder setHasInsufficientData(boolean value)
       When true, there is insufficient data to calculate the brand sentiment.
       
      bool has_insufficient_data = 2;
      Parameters:
      value - The hasInsufficientData to set.
      Returns:
      This builder for chaining.
    • clearHasInsufficientData

      public BrandSentimentInsight.Builder clearHasInsufficientData()
       When true, there is insufficient data to calculate the brand sentiment.
       
      bool has_insufficient_data = 2;
      Returns:
      This builder for chaining.
    • getSentimentDistributionsList

      public List<SentimentInsightDistribution> getSentimentDistributionsList()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
      Specified by:
      getSentimentDistributionsList in interface BrandSentimentInsightOrBuilder
    • getSentimentDistributionsCount

      public int getSentimentDistributionsCount()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
      Specified by:
      getSentimentDistributionsCount in interface BrandSentimentInsightOrBuilder
    • getSentimentDistributions

      public SentimentInsightDistribution getSentimentDistributions(int index)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
      Specified by:
      getSentimentDistributions in interface BrandSentimentInsightOrBuilder
    • setSentimentDistributions

      public BrandSentimentInsight.Builder setSentimentDistributions(int index, SentimentInsightDistribution value)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • setSentimentDistributions

      public BrandSentimentInsight.Builder setSentimentDistributions(int index, SentimentInsightDistribution.Builder builderForValue)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addSentimentDistributions

      public BrandSentimentInsight.Builder addSentimentDistributions(SentimentInsightDistribution value)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addSentimentDistributions

      public BrandSentimentInsight.Builder addSentimentDistributions(int index, SentimentInsightDistribution value)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addSentimentDistributions

      public BrandSentimentInsight.Builder addSentimentDistributions(SentimentInsightDistribution.Builder builderForValue)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addSentimentDistributions

      public BrandSentimentInsight.Builder addSentimentDistributions(int index, SentimentInsightDistribution.Builder builderForValue)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addAllSentimentDistributions

      public BrandSentimentInsight.Builder addAllSentimentDistributions(Iterable<? extends SentimentInsightDistribution> values)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • clearSentimentDistributions

      public BrandSentimentInsight.Builder clearSentimentDistributions()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • removeSentimentDistributions

      public BrandSentimentInsight.Builder removeSentimentDistributions(int index)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • getSentimentDistributionsBuilder

      public SentimentInsightDistribution.Builder getSentimentDistributionsBuilder(int index)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • getSentimentDistributionsOrBuilder

      public SentimentInsightDistributionOrBuilder getSentimentDistributionsOrBuilder(int index)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
      Specified by:
      getSentimentDistributionsOrBuilder in interface BrandSentimentInsightOrBuilder
    • getSentimentDistributionsOrBuilderList

      public List<? extends SentimentInsightDistributionOrBuilder> getSentimentDistributionsOrBuilderList()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
      Specified by:
      getSentimentDistributionsOrBuilderList in interface BrandSentimentInsightOrBuilder
    • addSentimentDistributionsBuilder

      public SentimentInsightDistribution.Builder addSentimentDistributionsBuilder()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • addSentimentDistributionsBuilder

      public SentimentInsightDistribution.Builder addSentimentDistributionsBuilder(int index)
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • getSentimentDistributionsBuilderList

      public List<SentimentInsightDistribution.Builder> getSentimentDistributionsBuilderList()
       Distribution of sentiment between positive, negative, and neutral.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightDistribution sentiment_distributions = 3;
    • getSentimentSummariesList

      public List<SentimentInsightSummary> getSentimentSummariesList()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
      Specified by:
      getSentimentSummariesList in interface BrandSentimentInsightOrBuilder
    • getSentimentSummariesCount

      public int getSentimentSummariesCount()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
      Specified by:
      getSentimentSummariesCount in interface BrandSentimentInsightOrBuilder
    • getSentimentSummaries

      public SentimentInsightSummary getSentimentSummaries(int index)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
      Specified by:
      getSentimentSummaries in interface BrandSentimentInsightOrBuilder
    • setSentimentSummaries

      public BrandSentimentInsight.Builder setSentimentSummaries(int index, SentimentInsightSummary value)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • setSentimentSummaries

      public BrandSentimentInsight.Builder setSentimentSummaries(int index, SentimentInsightSummary.Builder builderForValue)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addSentimentSummaries

      public BrandSentimentInsight.Builder addSentimentSummaries(SentimentInsightSummary value)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addSentimentSummaries

      public BrandSentimentInsight.Builder addSentimentSummaries(int index, SentimentInsightSummary value)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addSentimentSummaries

      public BrandSentimentInsight.Builder addSentimentSummaries(SentimentInsightSummary.Builder builderForValue)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addSentimentSummaries

      public BrandSentimentInsight.Builder addSentimentSummaries(int index, SentimentInsightSummary.Builder builderForValue)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addAllSentimentSummaries

      public BrandSentimentInsight.Builder addAllSentimentSummaries(Iterable<? extends SentimentInsightSummary> values)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • clearSentimentSummaries

      public BrandSentimentInsight.Builder clearSentimentSummaries()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • removeSentimentSummaries

      public BrandSentimentInsight.Builder removeSentimentSummaries(int index)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • getSentimentSummariesBuilder

      public SentimentInsightSummary.Builder getSentimentSummariesBuilder(int index)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • getSentimentSummariesOrBuilder

      public SentimentInsightSummaryOrBuilder getSentimentSummariesOrBuilder(int index)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
      Specified by:
      getSentimentSummariesOrBuilder in interface BrandSentimentInsightOrBuilder
    • getSentimentSummariesOrBuilderList

      public List<? extends SentimentInsightSummaryOrBuilder> getSentimentSummariesOrBuilderList()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
      Specified by:
      getSentimentSummariesOrBuilderList in interface BrandSentimentInsightOrBuilder
    • addSentimentSummariesBuilder

      public SentimentInsightSummary.Builder addSentimentSummariesBuilder()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • addSentimentSummariesBuilder

      public SentimentInsightSummary.Builder addSentimentSummariesBuilder(int index)
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;
    • getSentimentSummariesBuilderList

      public List<SentimentInsightSummary.Builder> getSentimentSummariesBuilderList()
       A summary of what was positive and negative about content related to the
       brand. No summaries are generated for neutral sentiment. The summary is
       generated by AI models.
       
      repeated .google.ads.googleads.v25.services.SentimentInsightSummary sentiment_summaries = 4;