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

Class RateMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RateMetrics.Builder>
com.google.ads.googleads.v23.services.RateMetrics.Builder
All Implemented Interfaces:
RateMetricsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RateMetrics
public static final class RateMetrics.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RateMetrics.Builder> implements RateMetricsOrBuilder
 Average rate metrics. Metrics that represent monetary values are returned
 in USD by default, if unspecified in the request.
Protobuf type google.ads.googleads.v23.services.RateMetrics

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RateMetrics.Builder>

    • clear

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

    • getDefaultInstanceForType

      public RateMetrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public RateMetrics.Builder mergeFrom(RateMetrics other)

    • isInitialized

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

    • mergeFrom

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

    • getAverageCpm

      public double getAverageCpm()
       Average cost-per-thousand impressions (CPM).
      double average_cpm = 1;
      Specified by:
      getAverageCpm in interface RateMetricsOrBuilder
      Returns:
      The averageCpm.

    • setAverageCpm

      public RateMetrics.Builder setAverageCpm(double value)
       Average cost-per-thousand impressions (CPM).
      double average_cpm = 1;
      Parameters:
      value - The averageCpm to set.
      Returns:
      This builder for chaining.

    • clearAverageCpm

      public RateMetrics.Builder clearAverageCpm()
       Average cost-per-thousand impressions (CPM).
      double average_cpm = 1;
      Returns:
      This builder for chaining.

    • getAverageActiveViewCpm

      public double getAverageActiveViewCpm()
       Average cost-per-thousand viewable impressions.
      double average_active_view_cpm = 2;
      Specified by:
      getAverageActiveViewCpm in interface RateMetricsOrBuilder
      Returns:
      The averageActiveViewCpm.

    • setAverageActiveViewCpm

      public RateMetrics.Builder setAverageActiveViewCpm(double value)
       Average cost-per-thousand viewable impressions.
      double average_active_view_cpm = 2;
      Parameters:
      value - The averageActiveViewCpm to set.
      Returns:
      This builder for chaining.

    • clearAverageActiveViewCpm

      public RateMetrics.Builder clearAverageActiveViewCpm()
       Average cost-per-thousand viewable impressions.
      double average_active_view_cpm = 2;
      Returns:
      This builder for chaining.

    • getTrueviewAverageCpv

      public double getTrueviewAverageCpv()
       The average TrueView cost-per-view (CPV) is defined by the total cost of
 all ad TrueView views divided by the number of TrueView views.
      double trueview_average_cpv = 3;
      Specified by:
      getTrueviewAverageCpv in interface RateMetricsOrBuilder
      Returns:
      The trueviewAverageCpv.

    • setTrueviewAverageCpv

      public RateMetrics.Builder setTrueviewAverageCpv(double value)
       The average TrueView cost-per-view (CPV) is defined by the total cost of
 all ad TrueView views divided by the number of TrueView views.
      double trueview_average_cpv = 3;
      Parameters:
      value - The trueviewAverageCpv to set.
      Returns:
      This builder for chaining.

    • clearTrueviewAverageCpv

      public RateMetrics.Builder clearTrueviewAverageCpv()
       The average TrueView cost-per-view (CPV) is defined by the total cost of
 all ad TrueView views divided by the number of TrueView views.
      double trueview_average_cpv = 3;
      Returns:
      This builder for chaining.

    • getAverageCpc

      public double getAverageCpc()
       The average cost-per-click (CPC) is defined by the total cost of all
 clicks divided by the total number of clicks received.
      double average_cpc = 4;
      Specified by:
      getAverageCpc in interface RateMetricsOrBuilder
      Returns:
      The averageCpc.

    • setAverageCpc

      public RateMetrics.Builder setAverageCpc(double value)
       The average cost-per-click (CPC) is defined by the total cost of all
 clicks divided by the total number of clicks received.
      double average_cpc = 4;
      Parameters:
      value - The averageCpc to set.
      Returns:
      This builder for chaining.

    • clearAverageCpc

      public RateMetrics.Builder clearAverageCpc()
       The average cost-per-click (CPC) is defined by the total cost of all
 clicks divided by the total number of clicks received.
      double average_cpc = 4;
      Returns:
      This builder for chaining.

    • getAverageCpi

      public double getAverageCpi()
       The average cost-per-interaction (CPI) is defined by the total cost of
 all interactions divided by the total number of interactions.
      double average_cpi = 5;
      Specified by:
      getAverageCpi in interface RateMetricsOrBuilder
      Returns:
      The averageCpi.

    • setAverageCpi

      public RateMetrics.Builder setAverageCpi(double value)
       The average cost-per-interaction (CPI) is defined by the total cost of
 all interactions divided by the total number of interactions.
      double average_cpi = 5;
      Parameters:
      value - The averageCpi to set.
      Returns:
      This builder for chaining.

    • clearAverageCpi

      public RateMetrics.Builder clearAverageCpi()
       The average cost-per-interaction (CPI) is defined by the total cost of
 all interactions divided by the total number of interactions.
      double average_cpi = 5;
      Returns:
      This builder for chaining.

    • getAverageCpe

      public double getAverageCpe()
       The average cost-per-engagement (CPE) is defined by the total cost of all
 ad engagements divided by the total number of ad engagements.
      double average_cpe = 6;
      Specified by:
      getAverageCpe in interface RateMetricsOrBuilder
      Returns:
      The averageCpe.

    • setAverageCpe

      public RateMetrics.Builder setAverageCpe(double value)
       The average cost-per-engagement (CPE) is defined by the total cost of all
 ad engagements divided by the total number of ad engagements.
      double average_cpe = 6;
      Parameters:
      value - The averageCpe to set.
      Returns:
      This builder for chaining.

    • clearAverageCpe

      public RateMetrics.Builder clearAverageCpe()
       The average cost-per-engagement (CPE) is defined by the total cost of all
 ad engagements divided by the total number of ad engagements.
      double average_cpe = 6;
      Returns:
      This builder for chaining.

    • getInteractionRate

      public double getInteractionRate()
       How often people interact with your ad after it is shown to them. This is
 the number of interactions divided by the number of times your ad is
 shown.
      double interaction_rate = 7;
      Specified by:
      getInteractionRate in interface RateMetricsOrBuilder
      Returns:
      The interactionRate.

    • setInteractionRate

      public RateMetrics.Builder setInteractionRate(double value)
       How often people interact with your ad after it is shown to them. This is
 the number of interactions divided by the number of times your ad is
 shown.
      double interaction_rate = 7;
      Parameters:
      value - The interactionRate to set.
      Returns:
      This builder for chaining.

    • clearInteractionRate

      public RateMetrics.Builder clearInteractionRate()
       How often people interact with your ad after it is shown to them. This is
 the number of interactions divided by the number of times your ad is
 shown.
      double interaction_rate = 7;
      Returns:
      This builder for chaining.

    • getEngagementRate

      public double getEngagementRate()
       How often people engage with your ad after it's shown to them. This is
 the number of ad expansions divided by the number of times your ad is
 shown.
      double engagement_rate = 8;
      Specified by:
      getEngagementRate in interface RateMetricsOrBuilder
      Returns:
      The engagementRate.

    • setEngagementRate

      public RateMetrics.Builder setEngagementRate(double value)
       How often people engage with your ad after it's shown to them. This is
 the number of ad expansions divided by the number of times your ad is
 shown.
      double engagement_rate = 8;
      Parameters:
      value - The engagementRate to set.
      Returns:
      This builder for chaining.

    • clearEngagementRate

      public RateMetrics.Builder clearEngagementRate()
       How often people engage with your ad after it's shown to them. This is
 the number of ad expansions divided by the number of times your ad is
 shown.
      double engagement_rate = 8;
      Returns:
      This builder for chaining.

    • getActiveViewViewability

      public double getActiveViewViewability()
       The percentage of time when your ad appeared on an Active View enabled
 site (measurable impressions) and was viewable (viewable impressions).
      double active_view_viewability = 9;
      Specified by:
      getActiveViewViewability in interface RateMetricsOrBuilder
      Returns:
      The activeViewViewability.

    • setActiveViewViewability

      public RateMetrics.Builder setActiveViewViewability(double value)
       The percentage of time when your ad appeared on an Active View enabled
 site (measurable impressions) and was viewable (viewable impressions).
      double active_view_viewability = 9;
      Parameters:
      value - The activeViewViewability to set.
      Returns:
      This builder for chaining.

    • clearActiveViewViewability

      public RateMetrics.Builder clearActiveViewViewability()
       The percentage of time when your ad appeared on an Active View enabled
 site (measurable impressions) and was viewable (viewable impressions).
      double active_view_viewability = 9;
      Returns:
      This builder for chaining.

    • getTrueviewViewRate

      public double getTrueviewViewRate()
       Number of completed TrueView views divided by the number of impressions.
      double trueview_view_rate = 10;
      Specified by:
      getTrueviewViewRate in interface RateMetricsOrBuilder
      Returns:
      The trueviewViewRate.

    • setTrueviewViewRate

      public RateMetrics.Builder setTrueviewViewRate(double value)
       Number of completed TrueView views divided by the number of impressions.
      double trueview_view_rate = 10;
      Parameters:
      value - The trueviewViewRate to set.
      Returns:
      This builder for chaining.

    • clearTrueviewViewRate

      public RateMetrics.Builder clearTrueviewViewRate()
       Number of completed TrueView views divided by the number of impressions.
      double trueview_view_rate = 10;
      Returns:
      This builder for chaining.

    • getClickThroughRate

      public double getClickThroughRate()
       The number of clicks your ad receives (Clicks) divided by the number
 of times your ad is shown (Impressions).
      double click_through_rate = 11;
      Specified by:
      getClickThroughRate in interface RateMetricsOrBuilder
      Returns:
      The clickThroughRate.

    • setClickThroughRate

      public RateMetrics.Builder setClickThroughRate(double value)
       The number of clicks your ad receives (Clicks) divided by the number
 of times your ad is shown (Impressions).
      double click_through_rate = 11;
      Parameters:
      value - The clickThroughRate to set.
      Returns:
      This builder for chaining.

    • clearClickThroughRate

      public RateMetrics.Builder clearClickThroughRate()
       The number of clicks your ad receives (Clicks) divided by the number
 of times your ad is shown (Impressions).
      double click_through_rate = 11;
      Returns:
      This builder for chaining.

    • getVideoCompletionP25Rate

      public double getVideoCompletionP25Rate()
       Percentage of impressions where the viewer watched 25% of your video.
      double video_completion_p25_rate = 12;
      Specified by:
      getVideoCompletionP25Rate in interface RateMetricsOrBuilder
      Returns:
      The videoCompletionP25Rate.

    • setVideoCompletionP25Rate

      public RateMetrics.Builder setVideoCompletionP25Rate(double value)
       Percentage of impressions where the viewer watched 25% of your video.
      double video_completion_p25_rate = 12;
      Parameters:
      value - The videoCompletionP25Rate to set.
      Returns:
      This builder for chaining.

    • clearVideoCompletionP25Rate

      public RateMetrics.Builder clearVideoCompletionP25Rate()
       Percentage of impressions where the viewer watched 25% of your video.
      double video_completion_p25_rate = 12;
      Returns:
      This builder for chaining.

    • getVideoCompletionP50Rate

      public double getVideoCompletionP50Rate()
       Percentage of impressions where the viewer watched 50% of your video.
      double video_completion_p50_rate = 13;
      Specified by:
      getVideoCompletionP50Rate in interface RateMetricsOrBuilder
      Returns:
      The videoCompletionP50Rate.

    • setVideoCompletionP50Rate

      public RateMetrics.Builder setVideoCompletionP50Rate(double value)
       Percentage of impressions where the viewer watched 50% of your video.
      double video_completion_p50_rate = 13;
      Parameters:
      value - The videoCompletionP50Rate to set.
      Returns:
      This builder for chaining.

    • clearVideoCompletionP50Rate

      public RateMetrics.Builder clearVideoCompletionP50Rate()
       Percentage of impressions where the viewer watched 50% of your video.
      double video_completion_p50_rate = 13;
      Returns:
      This builder for chaining.

    • getVideoCompletionP75Rate

      public double getVideoCompletionP75Rate()
       Percentage of impressions where the viewer watched 75% of your video.
      double video_completion_p75_rate = 14;
      Specified by:
      getVideoCompletionP75Rate in interface RateMetricsOrBuilder
      Returns:
      The videoCompletionP75Rate.

    • setVideoCompletionP75Rate

      public RateMetrics.Builder setVideoCompletionP75Rate(double value)
       Percentage of impressions where the viewer watched 75% of your video.
      double video_completion_p75_rate = 14;
      Parameters:
      value - The videoCompletionP75Rate to set.
      Returns:
      This builder for chaining.

    • clearVideoCompletionP75Rate

      public RateMetrics.Builder clearVideoCompletionP75Rate()
       Percentage of impressions where the viewer watched 75% of your video.
      double video_completion_p75_rate = 14;
      Returns:
      This builder for chaining.

    • getVideoCompletionP100Rate

      public double getVideoCompletionP100Rate()
       Percentage of impressions where the viewer watched all of your video.
      double video_completion_p100_rate = 15;
      Specified by:
      getVideoCompletionP100Rate in interface RateMetricsOrBuilder
      Returns:
      The videoCompletionP100Rate.

    • setVideoCompletionP100Rate

      public RateMetrics.Builder setVideoCompletionP100Rate(double value)
       Percentage of impressions where the viewer watched all of your video.
      double video_completion_p100_rate = 15;
      Parameters:
      value - The videoCompletionP100Rate to set.
      Returns:
      This builder for chaining.

    • clearVideoCompletionP100Rate

      public RateMetrics.Builder clearVideoCompletionP100Rate()
       Percentage of impressions where the viewer watched all of your video.
      double video_completion_p100_rate = 15;
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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