Package com.google.ads.googleads.v24.services

Class TrendInsight

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v24.services.TrendInsight
All Implemented Interfaces:
TrendInsightOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TrendInsight extends com.google.protobuf.GeneratedMessage implements TrendInsightOrBuilder
 A trend insight for a given attribute.
Protobuf type google.ads.googleads.v24.services.TrendInsight
See Also:

  • Field Details

    • TREND_ATTRIBUTE_FIELD_NUMBER

      public static final int TREND_ATTRIBUTE_FIELD_NUMBER
      See Also:

    • TREND_METRICS_FIELD_NUMBER

      public static final int TREND_METRICS_FIELD_NUMBER
      See Also:

    • TREND_FIELD_NUMBER

      public static final int TREND_FIELD_NUMBER
      See Also:

    • TREND_DATA_POINTS_FIELD_NUMBER

      public static final int TREND_DATA_POINTS_FIELD_NUMBER
      See Also:

  • 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

    • hasTrendAttribute

      public boolean hasTrendAttribute()
       The attribute this trend is for.
      .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata trend_attribute = 1;
      Specified by:
      hasTrendAttribute in interface TrendInsightOrBuilder
      Returns:
      Whether the trendAttribute field is set.

    • getTrendAttribute

      public AudienceInsightsAttributeMetadata getTrendAttribute()
       The attribute this trend is for.
      .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata trend_attribute = 1;
      Specified by:
      getTrendAttribute in interface TrendInsightOrBuilder
      Returns:
      The trendAttribute.

    • getTrendAttributeOrBuilder

      public AudienceInsightsAttributeMetadataOrBuilder getTrendAttributeOrBuilder()
       The attribute this trend is for.
      .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata trend_attribute = 1;
      Specified by:
      getTrendAttributeOrBuilder in interface TrendInsightOrBuilder

    • hasTrendMetrics

      public 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.v24.services.TrendInsightMetrics trend_metrics = 2;
      Specified by:
      hasTrendMetrics in interface TrendInsightOrBuilder
      Returns:
      Whether the trendMetrics field is set.

    • getTrendMetrics

      public 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.v24.services.TrendInsightMetrics trend_metrics = 2;
      Specified by:
      getTrendMetrics in interface TrendInsightOrBuilder
      Returns:
      The trendMetrics.

    • getTrendMetricsOrBuilder

      public 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.v24.services.TrendInsightMetrics trend_metrics = 2;
      Specified by:
      getTrendMetricsOrBuilder in interface TrendInsightOrBuilder

    • getTrendValue

      public 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.v24.enums.InsightsTrendEnum.InsightsTrend trend = 3;
      Specified by:
      getTrendValue in interface TrendInsightOrBuilder
      Returns:
      The enum numeric value on the wire for trend.

    • getTrend

      public 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.v24.enums.InsightsTrendEnum.InsightsTrend trend = 3;
      Specified by:
      getTrend in interface TrendInsightOrBuilder
      Returns:
      The trend.

    • getTrendDataPointsList

      public 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.v24.services.TrendInsightDataPoint trend_data_points = 6;
      Specified by:
      getTrendDataPointsList in interface TrendInsightOrBuilder

    • getTrendDataPointsOrBuilderList

      public 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.v24.services.TrendInsightDataPoint trend_data_points = 6;
      Specified by:
      getTrendDataPointsOrBuilderList in interface TrendInsightOrBuilder

    • getTrendDataPointsCount

      public 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.v24.services.TrendInsightDataPoint trend_data_points = 6;
      Specified by:
      getTrendDataPointsCount in interface TrendInsightOrBuilder

    • getTrendDataPoints

      public 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.v24.services.TrendInsightDataPoint trend_data_points = 6;
      Specified by:
      getTrendDataPoints in interface TrendInsightOrBuilder

    • getTrendDataPointsOrBuilder

      public 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.v24.services.TrendInsightDataPoint trend_data_points = 6;
      Specified by:
      getTrendDataPointsOrBuilder in interface TrendInsightOrBuilder

    • getRelatedVideosList

      public List<AudienceInsightsAttributeMetadata> getRelatedVideosList()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata related_videos = 4;
      Specified by:
      getRelatedVideosList in interface TrendInsightOrBuilder

    • getRelatedVideosOrBuilderList

      public List<? extends AudienceInsightsAttributeMetadataOrBuilder> getRelatedVideosOrBuilderList()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata related_videos = 4;
      Specified by:
      getRelatedVideosOrBuilderList in interface TrendInsightOrBuilder

    • getRelatedVideosCount

      public int getRelatedVideosCount()
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata related_videos = 4;
      Specified by:
      getRelatedVideosCount in interface TrendInsightOrBuilder

    • getRelatedVideos

      public AudienceInsightsAttributeMetadata getRelatedVideos(int index)
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata related_videos = 4;
      Specified by:
      getRelatedVideos in interface TrendInsightOrBuilder

    • getRelatedVideosOrBuilder

      public AudienceInsightsAttributeMetadataOrBuilder getRelatedVideosOrBuilder(int index)
       Related videos for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.common.AudienceInsightsAttributeMetadata related_videos = 4;
      Specified by:
      getRelatedVideosOrBuilder in interface TrendInsightOrBuilder

    • getRelatedCreatorsList

      public List<YouTubeCreatorInsights> getRelatedCreatorsList()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_creators = 5;
      Specified by:
      getRelatedCreatorsList in interface TrendInsightOrBuilder

    • getRelatedCreatorsOrBuilderList

      public List<? extends YouTubeCreatorInsightsOrBuilder> getRelatedCreatorsOrBuilderList()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_creators = 5;
      Specified by:
      getRelatedCreatorsOrBuilderList in interface TrendInsightOrBuilder

    • getRelatedCreatorsCount

      public int getRelatedCreatorsCount()
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_creators = 5;
      Specified by:
      getRelatedCreatorsCount in interface TrendInsightOrBuilder

    • getRelatedCreators

      public YouTubeCreatorInsights getRelatedCreators(int index)
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_creators = 5;
      Specified by:
      getRelatedCreators in interface TrendInsightOrBuilder

    • getRelatedCreatorsOrBuilder

      public YouTubeCreatorInsightsOrBuilder getRelatedCreatorsOrBuilder(int index)
       Related creators for this topic. Only populated for trends using
 search_topics.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_creators = 5;
      Specified by:
      getRelatedCreatorsOrBuilder in interface TrendInsightOrBuilder

    • getRelatedLocalCreatorsList

      public 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.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v24.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_local_creators = 8;
      Specified by:
      getRelatedLocalCreatorsList in interface TrendInsightOrBuilder

    • getRelatedLocalCreatorsOrBuilderList

      public 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.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v24.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_local_creators = 8;
      Specified by:
      getRelatedLocalCreatorsOrBuilderList in interface TrendInsightOrBuilder

    • getRelatedLocalCreatorsCount

      public 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.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v24.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_local_creators = 8;
      Specified by:
      getRelatedLocalCreatorsCount in interface TrendInsightOrBuilder

    • getRelatedLocalCreators

      public 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.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v24.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_local_creators = 8;
      Specified by:
      getRelatedLocalCreators in interface TrendInsightOrBuilder

    • getRelatedLocalCreatorsOrBuilder

      public 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.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_TOPIC_INSIGHTS]
 capability.
 - Supplemental data
 [LOCAL_CREATOR_DATA][google.ads.googleads.v24.enums.ContentCreatorInsightsSupplementalDataEnum.ContentCreatorInsightsSupplementalData.LOCAL_CREATOR_DATA]
 is requested.
      repeated .google.ads.googleads.v24.services.YouTubeCreatorInsights related_local_creators = 8;
      Specified by:
      getRelatedLocalCreatorsOrBuilder in interface TrendInsightOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TrendInsight parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TrendInsight parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrendInsight parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrendInsight parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TrendInsight parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrendInsight parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TrendInsight parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TrendInsight.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TrendInsight.Builder newBuilder()

    • newBuilder

      public static TrendInsight.Builder newBuilder(TrendInsight prototype)

    • toBuilder

      public TrendInsight.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TrendInsight.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TrendInsight getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TrendInsight> parser()

    • getParserForType

      public com.google.protobuf.Parser<TrendInsight> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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