Package com.google.openrtb

Class OpenRtb.BidRequest.Source

  • All Implemented Interfaces:
    OpenRtb.BidRequest.SourceOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Source>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest
    public static final class OpenRtb.BidRequest.Source
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Source>
implements OpenRtb.BidRequest.SourceOrBuilder
     OpenRTB 2.5: This object describes the nature and behavior of the entity
 that is the source of the bid request upstream from the exchange.
 The primary purpose of this object is to define post-auction or upstream
 decisioning when the exchange itself does not control the final decision.
 A common example of this is header bidding, but it can also apply to
 upstream server entities such as another RTB exchange, a mediation
 platform, or an ad server combines direct campaigns with 3rd party
 demand in decisioning.
    Protobuf type com.google.openrtb.BidRequest.Source
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidRequest.Source.Builder
      OpenRTB 2.5: This object describes the nature and behavior of the entity that is the source of the bid request upstream from the exchange.

      • 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 int FD_FIELD_NUMBER  
      static com.google.protobuf.Parser<OpenRtb.BidRequest.Source> PARSER
      Deprecated.
      static int PCHAIN_FIELD_NUMBER  
      static int TID_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static OpenRtb.BidRequest.Source getDefaultInstance()  
      OpenRtb.BidRequest.Source getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getFd()
      Entity responsible for the final impression sale decision, where false = exchange, true = upstream source RECOMMENDED by the OpenRTB specification.
      com.google.protobuf.Parser<OpenRtb.BidRequest.Source> getParserForType()  
      String getPchain()
      Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.
      com.google.protobuf.ByteString getPchainBytes()
      Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.
      int getSerializedSize()  
      String getTid()
      Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
      com.google.protobuf.ByteString getTidBytes()
      Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasFd()
      Entity responsible for the final impression sale decision, where false = exchange, true = upstream source RECOMMENDED by the OpenRTB specification.
      int hashCode()  
      boolean hasPchain()
      Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.
      boolean hasTid()
      Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static OpenRtb.BidRequest.Source.Builder newBuilder()  
      static OpenRtb.BidRequest.Source.Builder newBuilder​(OpenRtb.BidRequest.Source prototype)  
      OpenRtb.BidRequest.Source.Builder newBuilderForType()  
      protected OpenRtb.BidRequest.Source.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static OpenRtb.BidRequest.Source parseDelimitedFrom​(InputStream input)  
      static OpenRtb.BidRequest.Source parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static OpenRtb.BidRequest.Source parseFrom​(byte[] data)  
      static OpenRtb.BidRequest.Source parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static OpenRtb.BidRequest.Source parseFrom​(com.google.protobuf.ByteString data)  
      static OpenRtb.BidRequest.Source parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static OpenRtb.BidRequest.Source parseFrom​(com.google.protobuf.CodedInputStream input)  
      static OpenRtb.BidRequest.Source parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static OpenRtb.BidRequest.Source parseFrom​(InputStream input)  
      static OpenRtb.BidRequest.Source parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static OpenRtb.BidRequest.Source parseFrom​(ByteBuffer data)  
      static OpenRtb.BidRequest.Source parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<OpenRtb.BidRequest.Source> parser()  
      OpenRtb.BidRequest.Source.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField, parseUnknownFieldProto3

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, isStringEmpty, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, 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, hasField, hasOneof

    • 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

      • hasFd

        public boolean hasFd()
         Entity responsible for the final impression sale decision,
 where false = exchange, true = upstream source
 RECOMMENDED by the OpenRTB specification.
        optional bool fd = 1;
        Specified by:
        hasFd in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        Whether the fd field is set.

      • getFd

        public boolean getFd()
         Entity responsible for the final impression sale decision,
 where false = exchange, true = upstream source
 RECOMMENDED by the OpenRTB specification.
        optional bool fd = 1;
        Specified by:
        getFd in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        The fd.

      • hasTid

        public boolean hasTid()
         Transaction ID that must be common across all participants in
 this bid request (e.g., potentially multiple exchanges).
 RECOMMENDED by the OpenRTB specification.
        optional string tid = 2;
        Specified by:
        hasTid in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        Whether the tid field is set.

      • getTid

        public String getTid()
         Transaction ID that must be common across all participants in
 this bid request (e.g., potentially multiple exchanges).
 RECOMMENDED by the OpenRTB specification.
        optional string tid = 2;
        Specified by:
        getTid in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        The tid.

      • getTidBytes

        public com.google.protobuf.ByteString getTidBytes()
         Transaction ID that must be common across all participants in
 this bid request (e.g., potentially multiple exchanges).
 RECOMMENDED by the OpenRTB specification.
        optional string tid = 2;
        Specified by:
        getTidBytes in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        The bytes for tid.

      • hasPchain

        public boolean hasPchain()
         Payment ID chain string containing embedded syntax
 described in the TAG Payment ID Protocol v1.0.
 RECOMMENDED by the OpenRTB specification.
        optional string pchain = 3;
        Specified by:
        hasPchain in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        Whether the pchain field is set.

      • getPchain

        public String getPchain()
         Payment ID chain string containing embedded syntax
 described in the TAG Payment ID Protocol v1.0.
 RECOMMENDED by the OpenRTB specification.
        optional string pchain = 3;
        Specified by:
        getPchain in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        The pchain.

      • getPchainBytes

        public com.google.protobuf.ByteString getPchainBytes()
         Payment ID chain string containing embedded syntax
 described in the TAG Payment ID Protocol v1.0.
 RECOMMENDED by the OpenRTB specification.
        optional string pchain = 3;
        Specified by:
        getPchainBytes in interface OpenRtb.BidRequest.SourceOrBuilder
        Returns:
        The bytes for pchain.

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static OpenRtb.BidRequest.Source 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.Source parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected OpenRtb.BidRequest.Source.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.Source> 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.Source getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Source>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder