Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Metric.Builder

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.MetricOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Metric>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    OpenRtb.BidRequest.Imp.Metric
    public static final class OpenRtb.BidRequest.Imp.Metric.Builder
extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<OpenRtb.BidRequest.Imp.Metric,​OpenRtb.BidRequest.Imp.Metric.Builder>
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

    • Method Detail

      • 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.Builder<OpenRtb.BidRequest.Imp.Metric.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.GeneratedMessageV3.Builder<OpenRtb.BidRequest.Imp.Metric.Builder>

      • 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

      • build

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

      • buildPartial

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

      • mergeFrom

        public OpenRtb.BidRequest.Imp.Metric.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<OpenRtb.BidRequest.Imp.Metric.Builder>
        Throws:
        IOException

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

      • setType

        public OpenRtb.BidRequest.Imp.Metric.Builder setType​(String value)
         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;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public OpenRtb.BidRequest.Imp.Metric.Builder clearType()
         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;
        Returns:
        This builder for chaining.

      • setTypeBytes

        public OpenRtb.BidRequest.Imp.Metric.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

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

      • setValue

        public OpenRtb.BidRequest.Imp.Metric.Builder setValue​(double value)
         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;
        Parameters:
        value - The value to set.
        Returns:
        This builder for chaining.

      • clearValue

        public OpenRtb.BidRequest.Imp.Metric.Builder clearValue()
         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;
        Returns:
        This builder for chaining.

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

      • setVendor

        public OpenRtb.BidRequest.Imp.Metric.Builder setVendor​(String value)
         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;
        Parameters:
        value - The vendor to set.
        Returns:
        This builder for chaining.

      • clearVendor

        public OpenRtb.BidRequest.Imp.Metric.Builder clearVendor()
         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;
        Returns:
        This builder for chaining.

      • setVendorBytes

        public OpenRtb.BidRequest.Imp.Metric.Builder setVendorBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for vendor to set.
        Returns:
        This builder for chaining.