Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Native

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.NativeOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Native>, 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.Native
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp.Native>
implements OpenRtb.BidRequest.Imp.NativeOrBuilder
     OpenRTB 2.3: This object represents a native type impression.
 Native ad units are intended to blend seamlessly into the surrounding
 content (e.g., a sponsored Twitter or Facebook post). As such, the
 response must be well-structured to afford the publisher fine-grained
 control over rendering.
 The Native Subcommittee has developed a companion specification to
 OpenRTB called the Native Ad Specification. It defines the request
 parameters and response markup structure of native ad units.
 This object provides the means of transporting request parameters as an
 opaque string so that the specific parameters can evolve separately
 under the auspices of the Native Ad Specification. Similarly, the
 ad markup served will be structured according to that specification.
 The presence of a Native as a subordinate of the Imp object indicates
 that this impression is offered as a native type impression.
 At the publisher's discretion, that same impression may also be offered
 as banner and/or video by also including as Imp subordinates the Banner
 and/or Video objects, respectively. However, any given bid for the
 impression must conform to one of the offered types.
    Protobuf type com.google.openrtb.BidRequest.Imp.Native
    See Also:
    Serialized Form

    • 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

      • hasRequest

        public boolean hasRequest()
         Request payload complying with the Native Ad Specification.
 Exactly one of {request, request_native} should be used;
 this is the OpenRTB-compliant field for JSON serialization.
        string request = 1;
        Specified by:
        hasRequest in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        Whether the request field is set.

      • getRequest

        public String getRequest()
         Request payload complying with the Native Ad Specification.
 Exactly one of {request, request_native} should be used;
 this is the OpenRTB-compliant field for JSON serialization.
        string request = 1;
        Specified by:
        getRequest in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The request.

      • getRequestBytes

        public com.google.protobuf.ByteString getRequestBytes()
         Request payload complying with the Native Ad Specification.
 Exactly one of {request, request_native} should be used;
 this is the OpenRTB-compliant field for JSON serialization.
        string request = 1;
        Specified by:
        getRequestBytes in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The bytes for request.

      • hasRequestNative

        public boolean hasRequestNative()
         Request payload complying with the Native Ad Specification.
 Exactly one of {request, request_native} should be used;
 this is an alternate field preferred for Protobuf serialization.
        .com.google.openrtb.NativeRequest request_native = 50;
        Specified by:
        hasRequestNative in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        Whether the requestNative field is set.

      • getRequestNative

        public OpenRtb.NativeRequest getRequestNative()
         Request payload complying with the Native Ad Specification.
 Exactly one of {request, request_native} should be used;
 this is an alternate field preferred for Protobuf serialization.
        .com.google.openrtb.NativeRequest request_native = 50;
        Specified by:
        getRequestNative in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The requestNative.

      • hasVer

        public boolean hasVer()
         Version of the Native Ad Specification to which request complies.
 RECOMMENDED by the OpenRTB specification.
        optional string ver = 2;
        Specified by:
        hasVer in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        Whether the ver field is set.

      • getVer

        public String getVer()
         Version of the Native Ad Specification to which request complies.
 RECOMMENDED by the OpenRTB specification.
        optional string ver = 2;
        Specified by:
        getVer in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The ver.

      • getVerBytes

        public com.google.protobuf.ByteString getVerBytes()
         Version of the Native Ad Specification to which request complies.
 RECOMMENDED by the OpenRTB specification.
        optional string ver = 2;
        Specified by:
        getVerBytes in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The bytes for ver.

      • getApiList

        public List<OpenRtb.APIFramework> getApiList()
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 3 [packed = true];
        Specified by:
        getApiList in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        A list containing the api.

      • getApiCount

        public int getApiCount()
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 3 [packed = true];
        Specified by:
        getApiCount in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The count of api.

      • getApi

        public OpenRtb.APIFramework getApi​(int index)
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 3 [packed = true];
        Specified by:
        getApi in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The api at the given index.

      • getBattrCount

        public int getBattrCount()
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 4 [packed = true];
        Specified by:
        getBattrCount in interface OpenRtb.BidRequest.Imp.NativeOrBuilder
        Returns:
        The count of battr.

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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