Package com.google.ads.googleads.v23.services

Class YouTubeMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<YouTubeMetrics.Builder>
com.google.ads.googleads.v23.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.GeneratedMessage.Builder<YouTubeMetrics.Builder> implements YouTubeMetricsOrBuilder
 YouTube Channel metrics.
Protobuf type google.ads.googleads.v23.services.YouTubeMetrics

  • 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<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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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. A measurement of how often
 people engage with the creator's content. The value, between 0 and 1, is
 calculated as total engagement divided by total views.
      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. A measurement of how often
 people engage with the creator's content. The value, between 0 and 1, is
 calculated as total engagement divided by total views.
      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. A measurement of how often
 people engage with the creator's content. The value, between 0 and 1, is
 calculated as total engagement divided by total views.
      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.

    • getIsActiveLiveStreamCreator

      public boolean getIsActiveLiveStreamCreator()
       When true, this channel has published a live stream in the last 90 days.
      bool is_active_live_stream_creator = 16;
      Specified by:
      getIsActiveLiveStreamCreator in interface YouTubeMetricsOrBuilder
      Returns:
      The isActiveLiveStreamCreator.

    • setIsActiveLiveStreamCreator

      public YouTubeMetrics.Builder setIsActiveLiveStreamCreator(boolean value)
       When true, this channel has published a live stream in the last 90 days.
      bool is_active_live_stream_creator = 16;
      Parameters:
      value - The isActiveLiveStreamCreator to set.
      Returns:
      This builder for chaining.

    • clearIsActiveLiveStreamCreator

      public YouTubeMetrics.Builder clearIsActiveLiveStreamCreator()
       When true, this channel has published a live stream in the last 90 days.
      bool is_active_live_stream_creator = 16;
      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.

    • getPartnershipOpportunitiesList

      public List<PartnershipOpportunityEnum.PartnershipOpportunity> getPartnershipOpportunitiesList()
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Specified by:
      getPartnershipOpportunitiesList in interface YouTubeMetricsOrBuilder
      Returns:
      A list containing the partnershipOpportunities.

    • getPartnershipOpportunitiesCount

      public int getPartnershipOpportunitiesCount()
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Specified by:
      getPartnershipOpportunitiesCount in interface YouTubeMetricsOrBuilder
      Returns:
      The count of partnershipOpportunities.

    • getPartnershipOpportunities

      public PartnershipOpportunityEnum.PartnershipOpportunity getPartnershipOpportunities(int index)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Specified by:
      getPartnershipOpportunities in interface YouTubeMetricsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The partnershipOpportunities at the given index.

    • setPartnershipOpportunities

      public YouTubeMetrics.Builder setPartnershipOpportunities(int index, PartnershipOpportunityEnum.PartnershipOpportunity value)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      index - The index to set the value at.
      value - The partnershipOpportunities to set.
      Returns:
      This builder for chaining.

    • addPartnershipOpportunities

      public YouTubeMetrics.Builder addPartnershipOpportunities(PartnershipOpportunityEnum.PartnershipOpportunity value)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      value - The partnershipOpportunities to add.
      Returns:
      This builder for chaining.

    • addAllPartnershipOpportunities

      public YouTubeMetrics.Builder addAllPartnershipOpportunities(Iterable<? extends PartnershipOpportunityEnum.PartnershipOpportunity> values)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      values - The partnershipOpportunities to add.
      Returns:
      This builder for chaining.

    • clearPartnershipOpportunities

      public YouTubeMetrics.Builder clearPartnershipOpportunities()
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Returns:
      This builder for chaining.

    • getPartnershipOpportunitiesValueList

      public List<Integer> getPartnershipOpportunitiesValueList()
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Specified by:
      getPartnershipOpportunitiesValueList in interface YouTubeMetricsOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for partnershipOpportunities.

    • getPartnershipOpportunitiesValue

      public int getPartnershipOpportunitiesValue(int index)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Specified by:
      getPartnershipOpportunitiesValue in interface YouTubeMetricsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of partnershipOpportunities at the given index.

    • setPartnershipOpportunitiesValue

      public YouTubeMetrics.Builder setPartnershipOpportunitiesValue(int index, int value)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for partnershipOpportunities to set.
      Returns:
      This builder for chaining.

    • addPartnershipOpportunitiesValue

      public YouTubeMetrics.Builder addPartnershipOpportunitiesValue(int value)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      value - The enum numeric value on the wire for partnershipOpportunities to add.
      Returns:
      This builder for chaining.

    • addAllPartnershipOpportunitiesValue

      public YouTubeMetrics.Builder addAllPartnershipOpportunitiesValue(Iterable<Integer> values)
       Partnership opportunities available for this creator.
      repeated .google.ads.googleads.v23.enums.PartnershipOpportunityEnum.PartnershipOpportunity partnership_opportunities = 17;
      Parameters:
      values - The enum numeric values on the wire for partnershipOpportunities to add.
      Returns:
      This builder for chaining.