Package com.google.ads.googleads.v20.services

Class YouTubeMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<YouTubeMetrics.Builder>
com.google.ads.googleads.v20.services.YouTubeMetrics.Builder
All Implemented Interfaces:
YouTubeMetricsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
YouTubeMetrics
public static final class YouTubeMetrics.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<YouTubeMetrics.Builder> implements YouTubeMetricsOrBuilder
 YouTube Channel metrics.
Protobuf type google.ads.googleads.v20.services.YouTubeMetrics

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public YouTubeMetrics.Builder mergeFrom(YouTubeMetrics other)

    • isInitialized

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

    • mergeFrom

      public YouTubeMetrics.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<YouTubeMetrics.Builder>
      Throws:
      IOException

    • getSubscriberCount

      public long getSubscriberCount()
       The number of subscribers.
      int64 subscriber_count = 1;
      Specified by:
      getSubscriberCount in interface YouTubeMetricsOrBuilder
      Returns:
      The subscriberCount.

    • setSubscriberCount

      public YouTubeMetrics.Builder setSubscriberCount(long value)
       The number of subscribers.
      int64 subscriber_count = 1;
      Parameters:
      value - The subscriberCount to set.
      Returns:
      This builder for chaining.

    • clearSubscriberCount

      public YouTubeMetrics.Builder clearSubscriberCount()
       The number of subscribers.
      int64 subscriber_count = 1;
      Returns:
      This builder for chaining.

    • getViewsCount

      public long getViewsCount()
       The total number of views.
      int64 views_count = 2;
      Specified by:
      getViewsCount in interface YouTubeMetricsOrBuilder
      Returns:
      The viewsCount.

    • setViewsCount

      public YouTubeMetrics.Builder setViewsCount(long value)
       The total number of views.
      int64 views_count = 2;
      Parameters:
      value - The viewsCount to set.
      Returns:
      This builder for chaining.

    • clearViewsCount

      public YouTubeMetrics.Builder clearViewsCount()
       The total number of views.
      int64 views_count = 2;
      Returns:
      This builder for chaining.

    • getVideoCount

      public long getVideoCount()
       The total number of videos.
      int64 video_count = 3;
      Specified by:
      getVideoCount in interface YouTubeMetricsOrBuilder
      Returns:
      The videoCount.

    • setVideoCount

      public YouTubeMetrics.Builder setVideoCount(long value)
       The total number of videos.
      int64 video_count = 3;
      Parameters:
      value - The videoCount to set.
      Returns:
      This builder for chaining.

    • clearVideoCount

      public YouTubeMetrics.Builder clearVideoCount()
       The total number of videos.
      int64 video_count = 3;
      Returns:
      This builder for chaining.

    • getLikesCount

      public long getLikesCount()
       The total number of likes across all videos of this channel.
      int64 likes_count = 5;
      Specified by:
      getLikesCount in interface YouTubeMetricsOrBuilder
      Returns:
      The likesCount.

    • setLikesCount

      public YouTubeMetrics.Builder setLikesCount(long value)
       The total number of likes across all videos of this channel.
      int64 likes_count = 5;
      Parameters:
      value - The likesCount to set.
      Returns:
      This builder for chaining.

    • clearLikesCount

      public YouTubeMetrics.Builder clearLikesCount()
       The total number of likes across all videos of this channel.
      int64 likes_count = 5;
      Returns:
      This builder for chaining.

    • getSharesCount

      public long getSharesCount()
       The total number of shares across all videos of this channel.
      int64 shares_count = 6;
      Specified by:
      getSharesCount in interface YouTubeMetricsOrBuilder
      Returns:
      The sharesCount.

    • setSharesCount

      public YouTubeMetrics.Builder setSharesCount(long value)
       The total number of shares across all videos of this channel.
      int64 shares_count = 6;
      Parameters:
      value - The sharesCount to set.
      Returns:
      This builder for chaining.

    • clearSharesCount

      public YouTubeMetrics.Builder clearSharesCount()
       The total number of shares across all videos of this channel.
      int64 shares_count = 6;
      Returns:
      This builder for chaining.

    • getCommentsCount

      public long getCommentsCount()
       The total number of comments across all videos of this channel.
      int64 comments_count = 7;
      Specified by:
      getCommentsCount in interface YouTubeMetricsOrBuilder
      Returns:
      The commentsCount.

    • setCommentsCount

      public YouTubeMetrics.Builder setCommentsCount(long value)
       The total number of comments across all videos of this channel.
      int64 comments_count = 7;
      Parameters:
      value - The commentsCount to set.
      Returns:
      This builder for chaining.

    • clearCommentsCount

      public YouTubeMetrics.Builder clearCommentsCount()
       The total number of comments across all videos of this channel.
      int64 comments_count = 7;
      Returns:
      This builder for chaining.

    • getEngagementRate

      public double getEngagementRate()
       The lifetime engagement rate of this channel. The value is computed as the
 total number of likes, shares, and comments across all videos divided by
 the total number of videos.
      double engagement_rate = 8;
      Specified by:
      getEngagementRate in interface YouTubeMetricsOrBuilder
      Returns:
      The engagementRate.

    • setEngagementRate

      public YouTubeMetrics.Builder setEngagementRate(double value)
       The lifetime engagement rate of this channel. The value is computed as the
 total number of likes, shares, and comments across all videos divided by
 the total number of videos.
      double engagement_rate = 8;
      Parameters:
      value - The engagementRate to set.
      Returns:
      This builder for chaining.

    • clearEngagementRate

      public YouTubeMetrics.Builder clearEngagementRate()
       The lifetime engagement rate of this channel. The value is computed as the
 total number of likes, shares, and comments across all videos divided by
 the total number of videos.
      double engagement_rate = 8;
      Returns:
      This builder for chaining.

    • getAverageViewsPerVideo

      public double getAverageViewsPerVideo()
       The average number of views per video in the last 28 days.
      double average_views_per_video = 9;
      Specified by:
      getAverageViewsPerVideo in interface YouTubeMetricsOrBuilder
      Returns:
      The averageViewsPerVideo.

    • setAverageViewsPerVideo

      public YouTubeMetrics.Builder setAverageViewsPerVideo(double value)
       The average number of views per video in the last 28 days.
      double average_views_per_video = 9;
      Parameters:
      value - The averageViewsPerVideo to set.
      Returns:
      This builder for chaining.

    • clearAverageViewsPerVideo

      public YouTubeMetrics.Builder clearAverageViewsPerVideo()
       The average number of views per video in the last 28 days.
      double average_views_per_video = 9;
      Returns:
      This builder for chaining.

    • getAverageLikesPerVideo

      public double getAverageLikesPerVideo()
       The average number of likes per video in the last 28 days.
      double average_likes_per_video = 10;
      Specified by:
      getAverageLikesPerVideo in interface YouTubeMetricsOrBuilder
      Returns:
      The averageLikesPerVideo.

    • setAverageLikesPerVideo

      public YouTubeMetrics.Builder setAverageLikesPerVideo(double value)
       The average number of likes per video in the last 28 days.
      double average_likes_per_video = 10;
      Parameters:
      value - The averageLikesPerVideo to set.
      Returns:
      This builder for chaining.

    • clearAverageLikesPerVideo

      public YouTubeMetrics.Builder clearAverageLikesPerVideo()
       The average number of likes per video in the last 28 days.
      double average_likes_per_video = 10;
      Returns:
      This builder for chaining.

    • getAverageSharesPerVideo

      public double getAverageSharesPerVideo()
       The average number of shares per video in the last 28 days.
      double average_shares_per_video = 11;
      Specified by:
      getAverageSharesPerVideo in interface YouTubeMetricsOrBuilder
      Returns:
      The averageSharesPerVideo.

    • setAverageSharesPerVideo

      public YouTubeMetrics.Builder setAverageSharesPerVideo(double value)
       The average number of shares per video in the last 28 days.
      double average_shares_per_video = 11;
      Parameters:
      value - The averageSharesPerVideo to set.
      Returns:
      This builder for chaining.

    • clearAverageSharesPerVideo

      public YouTubeMetrics.Builder clearAverageSharesPerVideo()
       The average number of shares per video in the last 28 days.
      double average_shares_per_video = 11;
      Returns:
      This builder for chaining.

    • getAverageCommentsPerVideo

      public double getAverageCommentsPerVideo()
       The average number of comments per video in the last 28 days.
      double average_comments_per_video = 12;
      Specified by:
      getAverageCommentsPerVideo in interface YouTubeMetricsOrBuilder
      Returns:
      The averageCommentsPerVideo.

    • setAverageCommentsPerVideo

      public YouTubeMetrics.Builder setAverageCommentsPerVideo(double value)
       The average number of comments per video in the last 28 days.
      double average_comments_per_video = 12;
      Parameters:
      value - The averageCommentsPerVideo to set.
      Returns:
      This builder for chaining.

    • clearAverageCommentsPerVideo

      public YouTubeMetrics.Builder clearAverageCommentsPerVideo()
       The average number of comments per video in the last 28 days.
      double average_comments_per_video = 12;
      Returns:
      This builder for chaining.

    • getShortsViewsCount

      public long getShortsViewsCount()
       The total number of views across all Shorts videos of this channel.
      int64 shorts_views_count = 13;
      Specified by:
      getShortsViewsCount in interface YouTubeMetricsOrBuilder
      Returns:
      The shortsViewsCount.

    • setShortsViewsCount

      public YouTubeMetrics.Builder setShortsViewsCount(long value)
       The total number of views across all Shorts videos of this channel.
      int64 shorts_views_count = 13;
      Parameters:
      value - The shortsViewsCount to set.
      Returns:
      This builder for chaining.

    • clearShortsViewsCount

      public YouTubeMetrics.Builder clearShortsViewsCount()
       The total number of views across all Shorts videos of this channel.
      int64 shorts_views_count = 13;
      Returns:
      This builder for chaining.

    • getShortsVideoCount

      public long getShortsVideoCount()
       The total number of Shorts videos.
      int64 shorts_video_count = 14;
      Specified by:
      getShortsVideoCount in interface YouTubeMetricsOrBuilder
      Returns:
      The shortsVideoCount.

    • setShortsVideoCount

      public YouTubeMetrics.Builder setShortsVideoCount(long value)
       The total number of Shorts videos.
      int64 shorts_video_count = 14;
      Parameters:
      value - The shortsVideoCount to set.
      Returns:
      This builder for chaining.

    • clearShortsVideoCount

      public YouTubeMetrics.Builder clearShortsVideoCount()
       The total number of Shorts videos.
      int64 shorts_video_count = 14;
      Returns:
      This builder for chaining.

    • getIsActiveShortsCreator

      public boolean getIsActiveShortsCreator()
       When true, this channel has published a Shorts video in the last 90 days.
      bool is_active_shorts_creator = 4;
      Specified by:
      getIsActiveShortsCreator in interface YouTubeMetricsOrBuilder
      Returns:
      The isActiveShortsCreator.

    • setIsActiveShortsCreator

      public YouTubeMetrics.Builder setIsActiveShortsCreator(boolean value)
       When true, this channel has published a Shorts video in the last 90 days.
      bool is_active_shorts_creator = 4;
      Parameters:
      value - The isActiveShortsCreator to set.
      Returns:
      This builder for chaining.

    • clearIsActiveShortsCreator

      public YouTubeMetrics.Builder clearIsActiveShortsCreator()
       When true, this channel has published a Shorts video in the last 90 days.
      bool is_active_shorts_creator = 4;
      Returns:
      This builder for chaining.

    • getIsBrandConnectCreator

      public boolean getIsBrandConnectCreator()
       When true, this creator can be partnered with to create original branded
 content using the Google Ads creator partnership platform, BrandConnect.

 See https://support.google.com/google-ads/answer/13828964 for more
 information about BrandConnect.
      bool is_brand_connect_creator = 15;
      Specified by:
      getIsBrandConnectCreator in interface YouTubeMetricsOrBuilder
      Returns:
      The isBrandConnectCreator.

    • setIsBrandConnectCreator

      public YouTubeMetrics.Builder setIsBrandConnectCreator(boolean value)
       When true, this creator can be partnered with to create original branded
 content using the Google Ads creator partnership platform, BrandConnect.

 See https://support.google.com/google-ads/answer/13828964 for more
 information about BrandConnect.
      bool is_brand_connect_creator = 15;
      Parameters:
      value - The isBrandConnectCreator to set.
      Returns:
      This builder for chaining.

    • clearIsBrandConnectCreator

      public YouTubeMetrics.Builder clearIsBrandConnectCreator()
       When true, this creator can be partnered with to create original branded
 content using the Google Ads creator partnership platform, BrandConnect.

 See https://support.google.com/google-ads/answer/13828964 for more
 information about BrandConnect.
      bool is_brand_connect_creator = 15;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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