Package com.google.ads.googleads.v25.services

Interface TrendInsightOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TrendInsight, TrendInsight.Builder
@Generated public interface TrendInsightOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasTrendAttribute

      boolean hasTrendAttribute()
       The attribute this trend is for.
      .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata trend_attribute = 1;
      Returns:
      Whether the trendAttribute field is set.

    • getTrendAttribute

      AudienceInsightsAttributeMetadata getTrendAttribute()
       The attribute this trend is for.
      .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata trend_attribute = 1;
      Returns:
      The trendAttribute.

    • getTrendAttributeOrBuilder

      AudienceInsightsAttributeMetadataOrBuilder getTrendAttributeOrBuilder()
       The attribute this trend is for.
      .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata trend_attribute = 1;

    • hasTrendMetrics

      boolean hasTrendMetrics()
       Metrics associated with this trend. These metrics are for the latest
 available month and the comparison period is 3 months.
      .google.ads.googleads.v25.services.TrendInsightMetrics trend_metrics = 2;
      Returns:
      Whether the trendMetrics field is set.

    • getTrendMetrics

      TrendInsightMetrics getTrendMetrics()
       Metrics associated with this trend. These metrics are for the latest
 available month and the comparison period is 3 months.
      .google.ads.googleads.v25.services.TrendInsightMetrics trend_metrics = 2;
      Returns:
      The trendMetrics.

    • getTrendMetricsOrBuilder

      TrendInsightMetricsOrBuilder getTrendMetricsOrBuilder()
       Metrics associated with this trend. These metrics are for the latest
 available month and the comparison period is 3 months.
      .google.ads.googleads.v25.services.TrendInsightMetrics trend_metrics = 2;

    • getTrendValue

      int getTrendValue()
       Indicate if a trend is sustained or emerging. Use
 trend_metrics.trend_change_percent to determine the direction of the
 trend.
      .google.ads.googleads.v25.enums.InsightsTrendEnum.InsightsTrend trend = 3;
      Returns:
      The enum numeric value on the wire for trend.

    • getTrend

      InsightsTrendEnum.InsightsTrend getTrend()
       Indicate if a trend is sustained or emerging. Use
 trend_metrics.trend_change_percent to determine the direction of the
 trend.
      .google.ads.googleads.v25.enums.InsightsTrendEnum.InsightsTrend trend = 3;
      Returns:
      The trend.

    • getTrendDataPointsList

      List<TrendInsightDataPoint> getTrendDataPointsList()
       3 years of historical data for the trend, including the most recent month
 the TrendInsight represents. Each data point represents 1 month of data and
 the comparison period is 1 month. The data points are ordered from most
 recent month to least recent month. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.TrendInsightDataPoint trend_data_points = 6;

    • getTrendDataPoints

      TrendInsightDataPoint getTrendDataPoints(int index)
       3 years of historical data for the trend, including the most recent month
 the TrendInsight represents. Each data point represents 1 month of data and
 the comparison period is 1 month. The data points are ordered from most
 recent month to least recent month. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.TrendInsightDataPoint trend_data_points = 6;

    • getTrendDataPointsCount

      int getTrendDataPointsCount()
       3 years of historical data for the trend, including the most recent month
 the TrendInsight represents. Each data point represents 1 month of data and
 the comparison period is 1 month. The data points are ordered from most
 recent month to least recent month. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.TrendInsightDataPoint trend_data_points = 6;

    • getTrendDataPointsOrBuilderList

      List<? extends TrendInsightDataPointOrBuilder> getTrendDataPointsOrBuilderList()
       3 years of historical data for the trend, including the most recent month
 the TrendInsight represents. Each data point represents 1 month of data and
 the comparison period is 1 month. The data points are ordered from most
 recent month to least recent month. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.TrendInsightDataPoint trend_data_points = 6;

    • getTrendDataPointsOrBuilder

      TrendInsightDataPointOrBuilder getTrendDataPointsOrBuilder(int index)
       3 years of historical data for the trend, including the most recent month
 the TrendInsight represents. Each data point represents 1 month of data and
 the comparison period is 1 month. The data points are ordered from most
 recent month to least recent month. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.TrendInsightDataPoint trend_data_points = 6;

    • getBrandSentimentInsightsList

      List<BrandSentimentInsight> getBrandSentimentInsightsList()
       The brand sentiment for this topic.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge graph entity topic has the Brand capability.
 - Supplemental data
 [BRAND_SENTIMENT_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.BRAND_SENTIMENT_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.BrandSentimentInsight brand_sentiment_insights = 7;

    • getBrandSentimentInsights

      BrandSentimentInsight getBrandSentimentInsights(int index)
       The brand sentiment for this topic.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge graph entity topic has the Brand capability.
 - Supplemental data
 [BRAND_SENTIMENT_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.BRAND_SENTIMENT_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.BrandSentimentInsight brand_sentiment_insights = 7;

    • getBrandSentimentInsightsCount

      int getBrandSentimentInsightsCount()
       The brand sentiment for this topic.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge graph entity topic has the Brand capability.
 - Supplemental data
 [BRAND_SENTIMENT_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.BRAND_SENTIMENT_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.BrandSentimentInsight brand_sentiment_insights = 7;

    • getBrandSentimentInsightsOrBuilderList

      List<? extends BrandSentimentInsightOrBuilder> getBrandSentimentInsightsOrBuilderList()
       The brand sentiment for this topic.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge graph entity topic has the Brand capability.
 - Supplemental data
 [BRAND_SENTIMENT_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.BRAND_SENTIMENT_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.BrandSentimentInsight brand_sentiment_insights = 7;

    • getBrandSentimentInsightsOrBuilder

      BrandSentimentInsightOrBuilder getBrandSentimentInsightsOrBuilder(int index)
       The brand sentiment for this topic.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge graph entity topic has the Brand capability.
 - Supplemental data
 [BRAND_SENTIMENT_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.BRAND_SENTIMENT_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.BrandSentimentInsight brand_sentiment_insights = 7;

    • getRelatedVideosList

      List<AudienceInsightsAttributeMetadata> getRelatedVideosList()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata related_videos = 4;

    • getRelatedVideos

      AudienceInsightsAttributeMetadata getRelatedVideos(int index)
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata related_videos = 4;

    • getRelatedVideosCount

      int getRelatedVideosCount()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata related_videos = 4;

    • getRelatedVideosOrBuilderList

      List<? extends AudienceInsightsAttributeMetadataOrBuilder> getRelatedVideosOrBuilderList()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata related_videos = 4;

    • getRelatedVideosOrBuilder

      AudienceInsightsAttributeMetadataOrBuilder getRelatedVideosOrBuilder(int index)
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.common.AudienceInsightsAttributeMetadata related_videos = 4;

    • getRelatedCreatorsList

      List<YouTubeCreatorInsights> getRelatedCreatorsList()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_creators = 5;

    • getRelatedCreators

      YouTubeCreatorInsights getRelatedCreators(int index)
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_creators = 5;

    • getRelatedCreatorsCount

      int getRelatedCreatorsCount()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_creators = 5;

    • getRelatedCreatorsOrBuilderList

      List<? extends YouTubeCreatorInsightsOrBuilder> getRelatedCreatorsOrBuilderList()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_creators = 5;

    • getRelatedCreatorsOrBuilder

      YouTubeCreatorInsightsOrBuilder getRelatedCreatorsOrBuilder(int index)
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_creators = 5;

    • getRelatedLocalCreatorsList

      List<YouTubeCreatorInsights> getRelatedLocalCreatorsList()
       Related local creators for this topic who have consented to share their
 location data. Related local creators refers to creators that are based in
 or post from the chosen country and are viewed in the chosen country.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge Graph entity topic has the
 [CREATOR_TOPIC_INSIGHTS][google.ads.googleads.v25.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_local_creators = 8;

    • getRelatedLocalCreators

      YouTubeCreatorInsights getRelatedLocalCreators(int index)
       Related local creators for this topic who have consented to share their
 location data. Related local creators refers to creators that are based in
 or post from the chosen country and are viewed in the chosen country.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge Graph entity topic has the
 [CREATOR_TOPIC_INSIGHTS][google.ads.googleads.v25.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_local_creators = 8;

    • getRelatedLocalCreatorsCount

      int getRelatedLocalCreatorsCount()
       Related local creators for this topic who have consented to share their
 location data. Related local creators refers to creators that are based in
 or post from the chosen country and are viewed in the chosen country.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge Graph entity topic has the
 [CREATOR_TOPIC_INSIGHTS][google.ads.googleads.v25.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_local_creators = 8;

    • getRelatedLocalCreatorsOrBuilderList

      List<? extends YouTubeCreatorInsightsOrBuilder> getRelatedLocalCreatorsOrBuilderList()
       Related local creators for this topic who have consented to share their
 location data. Related local creators refers to creators that are based in
 or post from the chosen country and are viewed in the chosen country.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge Graph entity topic has the
 [CREATOR_TOPIC_INSIGHTS][google.ads.googleads.v25.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_local_creators = 8;

    • getRelatedLocalCreatorsOrBuilder

      YouTubeCreatorInsightsOrBuilder getRelatedLocalCreatorsOrBuilder(int index)
       Related local creators for this topic who have consented to share their
 location data. Related local creators refers to creators that are based in
 or post from the chosen country and are viewed in the chosen country.
 Only populated when all of the following are true:
 - The trend request uses search_topics.
 - The Knowledge Graph entity topic has the
 [CREATOR_TOPIC_INSIGHTS][google.ads.googleads.v25.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v25.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v25.services.YouTubeCreatorInsights related_local_creators = 8;