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

Class CustomerMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v25.services.CustomerMetrics
All Implemented Interfaces:
CustomerMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class CustomerMetrics extends com.google.protobuf.GeneratedMessage implements CustomerMetricsOrBuilder
 Metrics representing the customer’s Ad performance.
Protobuf type google.ads.googleads.v25.services.CustomerMetrics
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CustomerMetrics.Builder
    Metrics representing the customer’s Ad performance.

    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
    AGGREGATE_METRICS_FIELD_NUMBER
     
    static final int
    AVERAGE_RATE_METRICS_FIELD_NUMBER
     
    static final int
    SHARE_METRICS_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)
     
    AggregateMetrics
    getAggregateMetrics()
    Metrics calculated by aggregating values of a single metric for the customer.
    AggregateMetricsOrBuilder
    getAggregateMetricsOrBuilder()
    Metrics calculated by aggregating values of a single metric for the customer.
    RateMetrics
    getAverageRateMetrics()
    Average rate metrics calculated by dividing one metric by another.
    RateMetricsOrBuilder
    getAverageRateMetricsOrBuilder()
    Average rate metrics calculated by dividing one metric by another.
    static CustomerMetrics
    getDefaultInstance()
     
    CustomerMetrics
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CustomerMetrics>
    getParserForType()
     
    int
    getSerializedSize()
     
    ShareMetrics
    getShareMetrics()
    Metrics calculated by dividing the metric of the customer by that of the selected benchmarks source.
    ShareMetricsOrBuilder
    getShareMetricsOrBuilder()
    Metrics calculated by dividing the metric of the customer by that of the selected benchmarks source.
    boolean
    hasAggregateMetrics()
    Metrics calculated by aggregating values of a single metric for the customer.
    boolean
    hasAverageRateMetrics()
    Average rate metrics calculated by dividing one metric by another.
    int
    hashCode()
     
    boolean
    hasShareMetrics()
    Metrics calculated by dividing the metric of the customer by that of the selected benchmarks source.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CustomerMetrics.Builder
    newBuilder()
     
    static CustomerMetrics.Builder
    newBuilder(CustomerMetrics prototype)
     
    CustomerMetrics.Builder
    newBuilderForType()
     
    protected CustomerMetrics.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CustomerMetrics
    parseDelimitedFrom(InputStream input)
     
    static CustomerMetrics
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomerMetrics
    parseFrom(byte[] data)
     
    static CustomerMetrics
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomerMetrics
    parseFrom(com.google.protobuf.ByteString data)
     
    static CustomerMetrics
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomerMetrics
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CustomerMetrics
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomerMetrics
    parseFrom(InputStream input)
     
    static CustomerMetrics
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CustomerMetrics
    parseFrom(ByteBuffer data)
     
    static CustomerMetrics
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CustomerMetrics>
    parser()
     
    CustomerMetrics.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

    • AVERAGE_RATE_METRICS_FIELD_NUMBER

      public static final int AVERAGE_RATE_METRICS_FIELD_NUMBER
      See Also:

    • SHARE_METRICS_FIELD_NUMBER

      public static final int SHARE_METRICS_FIELD_NUMBER
      See Also:

    • AGGREGATE_METRICS_FIELD_NUMBER

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

    • hasAverageRateMetrics

      public boolean hasAverageRateMetrics()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      hasAverageRateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the averageRateMetrics field is set.

    • getAverageRateMetrics

      public RateMetrics getAverageRateMetrics()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      getAverageRateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The averageRateMetrics.

    • getAverageRateMetricsOrBuilder

      public RateMetricsOrBuilder getAverageRateMetricsOrBuilder()
       Average rate metrics calculated by dividing one metric by another.
      .google.ads.googleads.v25.services.RateMetrics average_rate_metrics = 1;
      Specified by:
      getAverageRateMetricsOrBuilder in interface CustomerMetricsOrBuilder

    • hasShareMetrics

      public boolean hasShareMetrics()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      hasShareMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the shareMetrics field is set.

    • getShareMetrics

      public ShareMetrics getShareMetrics()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      getShareMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The shareMetrics.

    • getShareMetricsOrBuilder

      public ShareMetricsOrBuilder getShareMetricsOrBuilder()
       Metrics calculated by dividing the metric of the customer by that of the
 selected benchmarks source. These metrics are only returned when:

 1. `all_advertisers` is used as the `benchmarks_source`. Note that the
 request `category_filter` must be set when using `all_advertisers`.
      .google.ads.googleads.v25.services.ShareMetrics share_metrics = 2;
      Specified by:
      getShareMetricsOrBuilder in interface CustomerMetricsOrBuilder

    • hasAggregateMetrics

      public boolean hasAggregateMetrics()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      hasAggregateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      Whether the aggregateMetrics field is set.

    • getAggregateMetrics

      public AggregateMetrics getAggregateMetrics()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      getAggregateMetrics in interface CustomerMetricsOrBuilder
      Returns:
      The aggregateMetrics.

    • getAggregateMetricsOrBuilder

      public AggregateMetricsOrBuilder getAggregateMetricsOrBuilder()
       Metrics calculated by aggregating values of a single metric for the
 customer.
      .google.ads.googleads.v25.services.AggregateMetrics aggregate_metrics = 3;
      Specified by:
      getAggregateMetricsOrBuilder in interface CustomerMetricsOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CustomerMetrics.Builder newBuilder()

    • newBuilder

      public static CustomerMetrics.Builder newBuilder(CustomerMetrics prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CustomerMetrics getDefaultInstance()

    • parser

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

    • getParserForType

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