Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Metric

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.MetricOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Metric>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest.Imp
    public static final class OpenRtb.BidRequest.Imp.Metric
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp.Metric>
implements OpenRtb.BidRequest.Imp.MetricOrBuilder
     OpenRTB 2.5: This object is associated with an impression as
 an array of metrics. These metrics can offer insight into
 the impression to assist with decisioning such as average recent
 viewability, click-through rate, etc.  Each metric is identified
 by its type, reports the value of the metric, and optionally
 identifies the source or vendor measuring the value.
    Protobuf type com.google.openrtb.BidRequest.Imp.Metric
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidRequest.Imp.Metric.Builder
      OpenRTB 2.5: This object is associated with an impression as an array of metrics.

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

        com.google.protobuf.GeneratedMessageV3.ExtendableMessage.ExtensionWriter

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static com.google.protobuf.Parser<OpenRtb.BidRequest.Imp.Metric> PARSER
      Deprecated.
      static int TYPE_FIELD_NUMBER  
      static int VALUE_FIELD_NUMBER  
      static int VENDOR_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasType

        public boolean hasType()
         Type of metric being presented using exchange curated string
 names which should be published to bidders a priori.
 REQUIRED by the OpenRTB specification.
        optional string type = 1;
        Specified by:
        hasType in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        Whether the type field is set.

      • getType

        public String getType()
         Type of metric being presented using exchange curated string
 names which should be published to bidders a priori.
 REQUIRED by the OpenRTB specification.
        optional string type = 1;
        Specified by:
        getType in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         Type of metric being presented using exchange curated string
 names which should be published to bidders a priori.
 REQUIRED by the OpenRTB specification.
        optional string type = 1;
        Specified by:
        getTypeBytes in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        The bytes for type.

      • hasValue

        public boolean hasValue()
         Number representing the value of the metric.
 Probabilities must be in the range 0.0 - 1.0.
 REQUIRED by the OpenRTB specification.
        optional double value = 2;
        Specified by:
        hasValue in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public double getValue()
         Number representing the value of the metric.
 Probabilities must be in the range 0.0 - 1.0.
 REQUIRED by the OpenRTB specification.
        optional double value = 2;
        Specified by:
        getValue in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        The value.

      • hasVendor

        public boolean hasVendor()
         Source of the value using exchange curated string names
 which should be published to bidders a priori.
 If the exchange itself is the source versus a third party,
 "EXCHANGE" is recommended.
 RECOMMENDED by the OpenRTB specification.
        optional string vendor = 3;
        Specified by:
        hasVendor in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        Whether the vendor field is set.

      • getVendor

        public String getVendor()
         Source of the value using exchange curated string names
 which should be published to bidders a priori.
 If the exchange itself is the source versus a third party,
 "EXCHANGE" is recommended.
 RECOMMENDED by the OpenRTB specification.
        optional string vendor = 3;
        Specified by:
        getVendor in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        The vendor.

      • getVendorBytes

        public com.google.protobuf.ByteString getVendorBytes()
         Source of the value using exchange curated string names
 which should be published to bidders a priori.
 If the exchange itself is the source versus a third party,
 "EXCHANGE" is recommended.
 RECOMMENDED by the OpenRTB specification.
        optional string vendor = 3;
        Specified by:
        getVendorBytes in interface OpenRtb.BidRequest.Imp.MetricOrBuilder
        Returns:
        The bytes for vendor.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • 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 OpenRtb.BidRequest.Imp.Metric parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Metric parseFrom​(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Metric parseFrom​(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Metric parseFrom​(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Metric parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidRequest.Imp.Metric parseFrom​(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public OpenRtb.BidRequest.Imp.Metric.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OpenRtb.BidRequest.Imp.Metric.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected OpenRtb.BidRequest.Imp.Metric.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<OpenRtb.BidRequest.Imp.Metric> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public OpenRtb.BidRequest.Imp.Metric getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Metric>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder