Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Audio

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.AudioOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Audio>, 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.Audio
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp.Audio>
implements OpenRtb.BidRequest.Imp.AudioOrBuilder
     This object represents an audio type impression. Many of the fields
 are non-essential for minimally viable transactions, but are included
 to offer fine control when needed. Audio in OpenRTB generally assumes
 compliance with the DAAST standard. As such, the notion of companion
 ads is supported by optionally including an array of Banner objects
 that define these companion ads.
 The presence of a Audio as a subordinate of the Imp object indicates
 that this impression is offered as an audio type impression.
 At the publisher's discretion, that same impression may also be offered
 as banner, video, and/or native by also including as Imp subordinates
 objects of those types. However, any given bid for the impression must
 conform to one of the offered types.
    Protobuf type com.google.openrtb.BidRequest.Imp.Audio
    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

      • getMimesList

        public com.google.protobuf.ProtocolStringList getMimesList()
         Content MIME types supported (e.g., "audio/mp4").
 REQUIRED by the OpenRTB specification: at least 1 element.
        repeated string mimes = 1;
        Specified by:
        getMimesList in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        A list containing the mimes.

      • getMimesCount

        public int getMimesCount()
         Content MIME types supported (e.g., "audio/mp4").
 REQUIRED by the OpenRTB specification: at least 1 element.
        repeated string mimes = 1;
        Specified by:
        getMimesCount in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The count of mimes.

      • getMimes

        public String getMimes​(int index)
         Content MIME types supported (e.g., "audio/mp4").
 REQUIRED by the OpenRTB specification: at least 1 element.
        repeated string mimes = 1;
        Specified by:
        getMimes in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The mimes at the given index.

      • getMimesBytes

        public com.google.protobuf.ByteString getMimesBytes​(int index)
         Content MIME types supported (e.g., "audio/mp4").
 REQUIRED by the OpenRTB specification: at least 1 element.
        repeated string mimes = 1;
        Specified by:
        getMimesBytes in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the mimes at the given index.

      • hasMinduration

        public boolean hasMinduration()
         Minimum audio ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 minduration = 2 [default = 0];
        Specified by:
        hasMinduration in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the minduration field is set.

      • getMinduration

        public int getMinduration()
         Minimum audio ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 minduration = 2 [default = 0];
        Specified by:
        getMinduration in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The minduration.

      • hasMaxduration

        public boolean hasMaxduration()
         Maximum audio ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 maxduration = 3;
        Specified by:
        hasMaxduration in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the maxduration field is set.

      • getMaxduration

        public int getMaxduration()
         Maximum audio ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 maxduration = 3;
        Specified by:
        getMaxduration in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The maxduration.

      • getProtocolsCount

        public int getProtocolsCount()
         Array of supported audio protocols.
 RECOMMENDED by the OpenRTB specification.
        repeated .com.google.openrtb.Protocol protocols = 4 [packed = true];
        Specified by:
        getProtocolsCount in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The count of protocols.

      • getProtocols

        public OpenRtb.Protocol getProtocols​(int index)
         Array of supported audio protocols.
 RECOMMENDED by the OpenRTB specification.
        repeated .com.google.openrtb.Protocol protocols = 4 [packed = true];
        Specified by:
        getProtocols in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The protocols at the given index.

      • hasStartdelay

        public boolean hasStartdelay()
         Indicates the start delay in seconds for pre-roll, mid-roll, or
 post-roll ad placements.
 Refer to enum StartDelay for generic values.
 RECOMMENDED by the OpenRTB specification.
        optional int32 startdelay = 5;
        Specified by:
        hasStartdelay in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the startdelay field is set.

      • getStartdelay

        public int getStartdelay()
         Indicates the start delay in seconds for pre-roll, mid-roll, or
 post-roll ad placements.
 Refer to enum StartDelay for generic values.
 RECOMMENDED by the OpenRTB specification.
        optional int32 startdelay = 5;
        Specified by:
        getStartdelay in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The startdelay.

      • hasSequence

        public boolean hasSequence()
         If multiple ad impressions are offered in the same bid request,
 the sequence number will allow for the coordinated delivery of
 multiple creatives.
        optional int32 sequence = 6 [default = 1];
        Specified by:
        hasSequence in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the sequence field is set.

      • getSequence

        public int getSequence()
         If multiple ad impressions are offered in the same bid request,
 the sequence number will allow for the coordinated delivery of
 multiple creatives.
        optional int32 sequence = 6 [default = 1];
        Specified by:
        getSequence in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The sequence.

      • getBattrCount

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

      • hasMaxextended

        public boolean hasMaxextended()
         Maximum extended video ad duration, if extension is allowed.
 If blank or 0, extension is not allowed. If -1, extension is allowed,
 and there is no time limit imposed. If greater than 0, then the value
 represents the number of seconds of extended play supported beyond
 the maxduration value.
        optional int32 maxextended = 8;
        Specified by:
        hasMaxextended in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the maxextended field is set.

      • getMaxextended

        public int getMaxextended()
         Maximum extended video ad duration, if extension is allowed.
 If blank or 0, extension is not allowed. If -1, extension is allowed,
 and there is no time limit imposed. If greater than 0, then the value
 represents the number of seconds of extended play supported beyond
 the maxduration value.
        optional int32 maxextended = 8;
        Specified by:
        getMaxextended in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The maxextended.

      • getDeliveryCount

        public int getDeliveryCount()
         Supported delivery methods (e.g., streaming, progressive).
 If none specified, assume all are supported.
        repeated .com.google.openrtb.ContentDeliveryMethod delivery = 11 [packed = true];
        Specified by:
        getDeliveryCount in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The count of delivery.

      • getDelivery

        public OpenRtb.ContentDeliveryMethod getDelivery​(int index)
         Supported delivery methods (e.g., streaming, progressive).
 If none specified, assume all are supported.
        repeated .com.google.openrtb.ContentDeliveryMethod delivery = 11 [packed = true];
        Specified by:
        getDelivery in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The delivery at the given index.

      • 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 = 13 [packed = true];
        Specified by:
        getApiList in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        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 = 13 [packed = true];
        Specified by:
        getApiCount in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        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 = 13 [packed = true];
        Specified by:
        getApi in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The api at the given index.

      • getCompaniontypeList

        public List<OpenRtb.CompanionType> getCompaniontypeList()
         Supported DAAST companion ad types.  Recommended if companion Banner
 objects are included via the companionad array.
        repeated .com.google.openrtb.CompanionType companiontype = 20 [packed = true];
        Specified by:
        getCompaniontypeList in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        A list containing the companiontype.

      • getCompaniontypeCount

        public int getCompaniontypeCount()
         Supported DAAST companion ad types.  Recommended if companion Banner
 objects are included via the companionad array.
        repeated .com.google.openrtb.CompanionType companiontype = 20 [packed = true];
        Specified by:
        getCompaniontypeCount in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The count of companiontype.

      • getCompaniontype

        public OpenRtb.CompanionType getCompaniontype​(int index)
         Supported DAAST companion ad types.  Recommended if companion Banner
 objects are included via the companionad array.
        repeated .com.google.openrtb.CompanionType companiontype = 20 [packed = true];
        Specified by:
        getCompaniontype in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The companiontype at the given index.

      • hasMaxseq

        public boolean hasMaxseq()
         The maximum number of ads that can be played in an ad pod.
        optional int32 maxseq = 21;
        Specified by:
        hasMaxseq in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the maxseq field is set.

      • hasFeed

        public boolean hasFeed()
         Type of audio feed.
        optional .com.google.openrtb.FeedType feed = 22;
        Specified by:
        hasFeed in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the feed field is set.

      • hasStitched

        public boolean hasStitched()
         Indicates if the ad is stitched with audio content or delivered
 independently.
        optional bool stitched = 23;
        Specified by:
        hasStitched in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the stitched field is set.

      • getStitched

        public boolean getStitched()
         Indicates if the ad is stitched with audio content or delivered
 independently.
        optional bool stitched = 23;
        Specified by:
        getStitched in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        The stitched.

      • hasNvol

        public boolean hasNvol()
         Volume normalization mode.
        optional .com.google.openrtb.VolumeNormalizationMode nvol = 24;
        Specified by:
        hasNvol in interface OpenRtb.BidRequest.Imp.AudioOrBuilder
        Returns:
        Whether the nvol field is set.

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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