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

Class AggregateMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v25.services.AggregateMetrics
All Implemented Interfaces:
AggregateMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AggregateMetrics extends com.google.protobuf.GeneratedMessage implements AggregateMetricsOrBuilder
 Metrics calculated by aggregating values of a single metric.
Protobuf type google.ads.googleads.v25.services.AggregateMetrics
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AggregateMetrics.Builder
    Metrics calculated by aggregating values of a single metric.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLICKS_FIELD_NUMBER
     
    static final int
    COST_FIELD_NUMBER
     
    static final int
    ENGAGEMENTS_FIELD_NUMBER
     
    static final int
    IMPRESSIONS_FIELD_NUMBER
     
    static final int
    INTERACTIONS_FIELD_NUMBER
     
    static final int
    VIDEO_TRUEVIEW_VIEWS_FIELD_NUMBER
     
    static final int
    VIEWABLE_IMPRESSIONS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    double
    getClicks()
    The number of clicks received.
    double
    getCost()
    The total cost paid by the customer.
    static AggregateMetrics
    getDefaultInstance()
     
    AggregateMetrics
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    double
    getEngagements()
    The number of engagements.
    double
    getImpressions()
    The number of times the Ad was shown to users.
    double
    getInteractions()
    The number of interactions.
    com.google.protobuf.Parser<AggregateMetrics>
    getParserForType()
     
    int
    getSerializedSize()
     
    double
    getVideoTrueviewViews()
    The number of video TrueView views.
    double
    getViewableImpressions()
    The number of impressions that are considered viewable according to the Active View criteria.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AggregateMetrics.Builder
    newBuilder()
     
    static AggregateMetrics.Builder
    newBuilder(AggregateMetrics prototype)
     
    AggregateMetrics.Builder
    newBuilderForType()
     
    protected AggregateMetrics.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AggregateMetrics
    parseDelimitedFrom(InputStream input)
     
    static AggregateMetrics
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregateMetrics
    parseFrom(byte[] data)
     
    static AggregateMetrics
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregateMetrics
    parseFrom(com.google.protobuf.ByteString data)
     
    static AggregateMetrics
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregateMetrics
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AggregateMetrics
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregateMetrics
    parseFrom(InputStream input)
     
    static AggregateMetrics
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AggregateMetrics
    parseFrom(ByteBuffer data)
     
    static AggregateMetrics
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AggregateMetrics>
    parser()
     
    AggregateMetrics.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • COST_FIELD_NUMBER

      public static final int COST_FIELD_NUMBER
      See Also:

    • VIDEO_TRUEVIEW_VIEWS_FIELD_NUMBER

      public static final int VIDEO_TRUEVIEW_VIEWS_FIELD_NUMBER
      See Also:

    • IMPRESSIONS_FIELD_NUMBER

      public static final int IMPRESSIONS_FIELD_NUMBER
      See Also:

    • VIEWABLE_IMPRESSIONS_FIELD_NUMBER

      public static final int VIEWABLE_IMPRESSIONS_FIELD_NUMBER
      See Also:

    • CLICKS_FIELD_NUMBER

      public static final int CLICKS_FIELD_NUMBER
      See Also:

    • INTERACTIONS_FIELD_NUMBER

      public static final int INTERACTIONS_FIELD_NUMBER
      See Also:

    • ENGAGEMENTS_FIELD_NUMBER

      public static final int ENGAGEMENTS_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

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

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

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

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

    • getClicks

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

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

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

    • 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 AggregateMetrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AggregateMetrics.Builder newBuilder()

    • newBuilder

      public static AggregateMetrics.Builder newBuilder(AggregateMetrics prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AggregateMetrics getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AggregateMetrics> 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 AggregateMetrics getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder