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

Class AggregateMetrics.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AggregateMetrics.Builder>
com.google.ads.googleads.v25.services.AggregateMetrics.Builder
All Implemented Interfaces:
AggregateMetricsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AggregateMetrics
public static final class AggregateMetrics.Builder extends com.google.protobuf.GeneratedMessage.Builder<AggregateMetrics.Builder> implements AggregateMetricsOrBuilder
 Metrics calculated by aggregating values of a single metric.
Protobuf type google.ads.googleads.v25.services.AggregateMetrics

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public AggregateMetrics.Builder mergeFrom(AggregateMetrics other)

    • isInitialized

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

    • mergeFrom

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

    • getCost

      public double getCost()
       The total cost paid by the customer. Cost is represented in USD by default,
 if unspecified in the request.
      double cost = 1;
      Specified by:
      getCost in interface AggregateMetricsOrBuilder
      Returns:
      The cost.

    • setCost

      public AggregateMetrics.Builder setCost(double value)
       The total cost paid by the customer. Cost is represented in USD by default,
 if unspecified in the request.
      double cost = 1;
      Parameters:
      value - The cost to set.
      Returns:
      This builder for chaining.

    • clearCost

      public AggregateMetrics.Builder clearCost()
       The total cost paid by the customer. Cost is represented in USD by default,
 if unspecified in the request.
      double cost = 1;
      Returns:
      This builder for chaining.

    • getVideoTrueviewViews

      public double getVideoTrueviewViews()
       The number of video TrueView views.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on TrueView Views.
      double video_trueview_views = 2;
      Specified by:
      getVideoTrueviewViews in interface AggregateMetricsOrBuilder
      Returns:
      The videoTrueviewViews.

    • setVideoTrueviewViews

      public AggregateMetrics.Builder setVideoTrueviewViews(double value)
       The number of video TrueView views.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on TrueView Views.
      double video_trueview_views = 2;
      Parameters:
      value - The videoTrueviewViews to set.
      Returns:
      This builder for chaining.

    • clearVideoTrueviewViews

      public AggregateMetrics.Builder clearVideoTrueviewViews()
       The number of video TrueView views.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on TrueView Views.
      double video_trueview_views = 2;
      Returns:
      This builder for chaining.

    • getImpressions

      public double getImpressions()
       The number of times the Ad was shown to users.
      double impressions = 3;
      Specified by:
      getImpressions in interface AggregateMetricsOrBuilder
      Returns:
      The impressions.

    • setImpressions

      public AggregateMetrics.Builder setImpressions(double value)
       The number of times the Ad was shown to users.
      double impressions = 3;
      Parameters:
      value - The impressions to set.
      Returns:
      This builder for chaining.

    • clearImpressions

      public AggregateMetrics.Builder clearImpressions()
       The number of times the Ad was shown to users.
      double impressions = 3;
      Returns:
      This builder for chaining.

    • getViewableImpressions

      public double getViewableImpressions()
       The number of impressions that are considered viewable according to the
 Active View criteria.

 See https://support.google.com/google-ads/answer/7029393 for more
 information on Active View.
      double viewable_impressions = 4;
      Specified by:
      getViewableImpressions in interface AggregateMetricsOrBuilder
      Returns:
      The viewableImpressions.

    • setViewableImpressions

      public AggregateMetrics.Builder setViewableImpressions(double value)
       The number of impressions that are considered viewable according to the
 Active View criteria.

 See https://support.google.com/google-ads/answer/7029393 for more
 information on Active View.
      double viewable_impressions = 4;
      Parameters:
      value - The viewableImpressions to set.
      Returns:
      This builder for chaining.

    • clearViewableImpressions

      public AggregateMetrics.Builder clearViewableImpressions()
       The number of impressions that are considered viewable according to the
 Active View criteria.

 See https://support.google.com/google-ads/answer/7029393 for more
 information on Active View.
      double viewable_impressions = 4;
      Returns:
      This builder for chaining.

    • getClicks

      public double getClicks()
       The number of clicks received.
      double clicks = 5;
      Specified by:
      getClicks in interface AggregateMetricsOrBuilder
      Returns:
      The clicks.

    • setClicks

      public AggregateMetrics.Builder setClicks(double value)
       The number of clicks received.
      double clicks = 5;
      Parameters:
      value - The clicks to set.
      Returns:
      This builder for chaining.

    • clearClicks

      public AggregateMetrics.Builder clearClicks()
       The number of clicks received.
      double clicks = 5;
      Returns:
      This builder for chaining.

    • getInteractions

      public double getInteractions()
       The number of interactions. Interactions include physical clicks,
 engagements, and video views that are logged as clicks.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on interactions.
      double interactions = 6;
      Specified by:
      getInteractions in interface AggregateMetricsOrBuilder
      Returns:
      The interactions.

    • setInteractions

      public AggregateMetrics.Builder setInteractions(double value)
       The number of interactions. Interactions include physical clicks,
 engagements, and video views that are logged as clicks.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on interactions.
      double interactions = 6;
      Parameters:
      value - The interactions to set.
      Returns:
      This builder for chaining.

    • clearInteractions

      public AggregateMetrics.Builder clearInteractions()
       The number of interactions. Interactions include physical clicks,
 engagements, and video views that are logged as clicks.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on interactions.
      double interactions = 6;
      Returns:
      This builder for chaining.

    • getEngagements

      public double getEngagements()
       The number of engagements. Engagements are ad interactions such as
 expanding a lightbox Ad or clicking on a video teaser.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on engagements.
      double engagements = 7;
      Specified by:
      getEngagements in interface AggregateMetricsOrBuilder
      Returns:
      The engagements.

    • setEngagements

      public AggregateMetrics.Builder setEngagements(double value)
       The number of engagements. Engagements are ad interactions such as
 expanding a lightbox Ad or clicking on a video teaser.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on engagements.
      double engagements = 7;
      Parameters:
      value - The engagements to set.
      Returns:
      This builder for chaining.

    • clearEngagements

      public AggregateMetrics.Builder clearEngagements()
       The number of engagements. Engagements are ad interactions such as
 expanding a lightbox Ad or clicking on a video teaser.

 See https://support.google.com/google-ads/answer/2375431 for more
 information on engagements.
      double engagements = 7;
      Returns:
      This builder for chaining.