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

Class RateMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v23.services.RateMetrics
All Implemented Interfaces:
RateMetricsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RateMetrics extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RateMetrics.Builder
    Average rate metrics.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

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

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    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
    ACTIVE_VIEW_VIEWABILITY_FIELD_NUMBER
     
    static final int
    AVERAGE_ACTIVE_VIEW_CPM_FIELD_NUMBER
     
    static final int
    AVERAGE_CPC_FIELD_NUMBER
     
    static final int
    AVERAGE_CPE_FIELD_NUMBER
     
    static final int
    AVERAGE_CPI_FIELD_NUMBER
     
    static final int
    AVERAGE_CPM_FIELD_NUMBER
     
    static final int
    CLICK_THROUGH_RATE_FIELD_NUMBER
     
    static final int
    ENGAGEMENT_RATE_FIELD_NUMBER
     
    static final int
    INTERACTION_RATE_FIELD_NUMBER
     
    static final int
    TRUEVIEW_AVERAGE_CPV_FIELD_NUMBER
     
    static final int
    TRUEVIEW_VIEW_RATE_FIELD_NUMBER
     
    static final int
    VIDEO_COMPLETION_P100_RATE_FIELD_NUMBER
     
    static final int
    VIDEO_COMPLETION_P25_RATE_FIELD_NUMBER
     
    static final int
    VIDEO_COMPLETION_P50_RATE_FIELD_NUMBER
     
    static final int
    VIDEO_COMPLETION_P75_RATE_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
    getActiveViewViewability()
    The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
    double
    getAverageActiveViewCpm()
    Average cost-per-thousand viewable impressions.
    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
    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
    getAverageCpi()
    The average cost-per-interaction (CPI) is defined by the total cost of all interactions divided by the total number of interactions.
    double
    getAverageCpm()
    Average cost-per-thousand impressions (CPM).
    double
    getClickThroughRate()
    The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
    static RateMetrics
    getDefaultInstance()
     
    RateMetrics
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    double
    getEngagementRate()
    How often people engage with your ad after it's shown to them.
    double
    getInteractionRate()
    How often people interact with your ad after it is shown to them.
    com.google.protobuf.Parser<RateMetrics>
    getParserForType()
     
    int
    getSerializedSize()
     
    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
    getTrueviewViewRate()
    Number of completed TrueView views divided by the number of impressions.
    double
    getVideoCompletionP100Rate()
    Percentage of impressions where the viewer watched all of your video.
    double
    getVideoCompletionP25Rate()
    Percentage of impressions where the viewer watched 25% of your video.
    double
    getVideoCompletionP50Rate()
    Percentage of impressions where the viewer watched 50% of your video.
    double
    getVideoCompletionP75Rate()
    Percentage of impressions where the viewer watched 75% of your video.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RateMetrics.Builder
    newBuilder()
     
    static RateMetrics.Builder
    newBuilder(RateMetrics prototype)
     
    RateMetrics.Builder
    newBuilderForType()
     
    protected RateMetrics.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RateMetrics
    parseDelimitedFrom(InputStream input)
     
    static RateMetrics
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateMetrics
    parseFrom(byte[] data)
     
    static RateMetrics
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateMetrics
    parseFrom(com.google.protobuf.ByteString data)
     
    static RateMetrics
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateMetrics
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RateMetrics
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateMetrics
    parseFrom(InputStream input)
     
    static RateMetrics
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RateMetrics
    parseFrom(ByteBuffer data)
     
    static RateMetrics
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RateMetrics>
    parser()
     
    RateMetrics.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, 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.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    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

    • AVERAGE_CPM_FIELD_NUMBER

      public static final int AVERAGE_CPM_FIELD_NUMBER
      See Also:

    • AVERAGE_ACTIVE_VIEW_CPM_FIELD_NUMBER

      public static final int AVERAGE_ACTIVE_VIEW_CPM_FIELD_NUMBER
      See Also:

    • TRUEVIEW_AVERAGE_CPV_FIELD_NUMBER

      public static final int TRUEVIEW_AVERAGE_CPV_FIELD_NUMBER
      See Also:

    • AVERAGE_CPC_FIELD_NUMBER

      public static final int AVERAGE_CPC_FIELD_NUMBER
      See Also:

    • AVERAGE_CPI_FIELD_NUMBER

      public static final int AVERAGE_CPI_FIELD_NUMBER
      See Also:

    • AVERAGE_CPE_FIELD_NUMBER

      public static final int AVERAGE_CPE_FIELD_NUMBER
      See Also:

    • INTERACTION_RATE_FIELD_NUMBER

      public static final int INTERACTION_RATE_FIELD_NUMBER
      See Also:

    • ENGAGEMENT_RATE_FIELD_NUMBER

      public static final int ENGAGEMENT_RATE_FIELD_NUMBER
      See Also:

    • ACTIVE_VIEW_VIEWABILITY_FIELD_NUMBER

      public static final int ACTIVE_VIEW_VIEWABILITY_FIELD_NUMBER
      See Also:

    • TRUEVIEW_VIEW_RATE_FIELD_NUMBER

      public static final int TRUEVIEW_VIEW_RATE_FIELD_NUMBER
      See Also:

    • CLICK_THROUGH_RATE_FIELD_NUMBER

      public static final int CLICK_THROUGH_RATE_FIELD_NUMBER
      See Also:

    • VIDEO_COMPLETION_P25_RATE_FIELD_NUMBER

      public static final int VIDEO_COMPLETION_P25_RATE_FIELD_NUMBER
      See Also:

    • VIDEO_COMPLETION_P50_RATE_FIELD_NUMBER

      public static final int VIDEO_COMPLETION_P50_RATE_FIELD_NUMBER
      See Also:

    • VIDEO_COMPLETION_P75_RATE_FIELD_NUMBER

      public static final int VIDEO_COMPLETION_P75_RATE_FIELD_NUMBER
      See Also:

    • VIDEO_COMPLETION_P100_RATE_FIELD_NUMBER

      public static final int VIDEO_COMPLETION_P100_RATE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getAverageCpm

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • isInitialized

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RateMetrics.Builder newBuilder()

    • newBuilder

      public static RateMetrics.Builder newBuilder(RateMetrics prototype)

    • toBuilder

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

    • newBuilderForType

      protected RateMetrics.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RateMetrics getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RateMetrics> 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 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