Package com.google.openrtb
Interface OpenRtb.BidRequest.Imp.AudioOrBuilder
-
- All Superinterfaces:
com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Audio>,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpenRtb.BidRequest.Imp.Audio,OpenRtb.BidRequest.Imp.Audio.Builder
- Enclosing class:
- OpenRtb.BidRequest.Imp
public static interface OpenRtb.BidRequest.Imp.AudioOrBuilder extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Audio>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OpenRtb.APIFrameworkgetApi(int index)List of supported API frameworks for this impression.intgetApiCount()List of supported API frameworks for this impression.List<OpenRtb.APIFramework>getApiList()List of supported API frameworks for this impression.OpenRtb.CreativeAttributegetBattr(int index)Blocked creative attributes.intgetBattrCount()Blocked creative attributes.List<OpenRtb.CreativeAttribute>getBattrList()Blocked creative attributes.OpenRtb.BidRequest.Imp.BannergetCompanionad(int index)Array of Banner objects if companion ads are available.intgetCompanionadCount()Array of Banner objects if companion ads are available.List<OpenRtb.BidRequest.Imp.Banner>getCompanionadList()Array of Banner objects if companion ads are available.OpenRtb.BidRequest.Imp.BannerOrBuildergetCompanionadOrBuilder(int index)Array of Banner objects if companion ads are available.List<? extends OpenRtb.BidRequest.Imp.BannerOrBuilder>getCompanionadOrBuilderList()Array of Banner objects if companion ads are available.OpenRtb.CompanionTypegetCompaniontype(int index)Supported DAAST companion ad types.intgetCompaniontypeCount()Supported DAAST companion ad types.List<OpenRtb.CompanionType>getCompaniontypeList()Supported DAAST companion ad types.OpenRtb.ContentDeliveryMethodgetDelivery(int index)Supported delivery methods (e.g., streaming, progressive).intgetDeliveryCount()Supported delivery methods (e.g., streaming, progressive).List<OpenRtb.ContentDeliveryMethod>getDeliveryList()Supported delivery methods (e.g., streaming, progressive).OpenRtb.FeedTypegetFeed()Type of audio feed.intgetMaxbitrate()Maximum bit rate in Kbps.intgetMaxduration()Maximum audio ad duration in seconds.intgetMaxextended()Maximum extended video ad duration, if extension is allowed.intgetMaxseq()The maximum number of ads that can be played in an ad pod.StringgetMimes(int index)Content MIME types supported (e.g., "audio/mp4").com.google.protobuf.ByteStringgetMimesBytes(int index)Content MIME types supported (e.g., "audio/mp4").intgetMimesCount()Content MIME types supported (e.g., "audio/mp4").List<String>getMimesList()Content MIME types supported (e.g., "audio/mp4").intgetMinbitrate()Minimum bit rate in Kbps.intgetMinduration()Minimum audio ad duration in seconds.OpenRtb.VolumeNormalizationModegetNvol()Volume normalization mode.OpenRtb.ProtocolgetProtocols(int index)Array of supported audio protocols.intgetProtocolsCount()Array of supported audio protocols.List<OpenRtb.Protocol>getProtocolsList()Array of supported audio protocols.intgetSequence()If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.intgetStartdelay()Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.booleangetStitched()Indicates if the ad is stitched with audio content or delivered independently.booleanhasFeed()Type of audio feed.booleanhasMaxbitrate()Maximum bit rate in Kbps.booleanhasMaxduration()Maximum audio ad duration in seconds.booleanhasMaxextended()Maximum extended video ad duration, if extension is allowed.booleanhasMaxseq()The maximum number of ads that can be played in an ad pod.booleanhasMinbitrate()Minimum bit rate in Kbps.booleanhasMinduration()Minimum audio ad duration in seconds.booleanhasNvol()Volume normalization mode.booleanhasSequence()If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.booleanhasStartdelay()Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.booleanhasStitched()Indicates if the ad is stitched with audio content or delivered independently.-
Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
-
-
-
-
Method Detail
-
getMimesList
List<String> getMimesList()
Content MIME types supported (e.g., "audio/mp4"). REQUIRED by the OpenRTB specification: at least 1 element.
repeated string mimes = 1;- Returns:
- A list containing the mimes.
-
getMimesCount
int getMimesCount()
Content MIME types supported (e.g., "audio/mp4"). REQUIRED by the OpenRTB specification: at least 1 element.
repeated string mimes = 1;- Returns:
- The count of mimes.
-
getMimes
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;- Parameters:
index- The index of the element to return.- Returns:
- The mimes at the given index.
-
getMimesBytes
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;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the mimes at the given index.
-
hasMinduration
boolean hasMinduration()
Minimum audio ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 minduration = 2 [default = 0];- Returns:
- Whether the minduration field is set.
-
getMinduration
int getMinduration()
Minimum audio ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 minduration = 2 [default = 0];- Returns:
- The minduration.
-
hasMaxduration
boolean hasMaxduration()
Maximum audio ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 maxduration = 3;- Returns:
- Whether the maxduration field is set.
-
getMaxduration
int getMaxduration()
Maximum audio ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 maxduration = 3;- Returns:
- The maxduration.
-
getProtocolsList
List<OpenRtb.Protocol> getProtocolsList()
Array of supported audio protocols. RECOMMENDED by the OpenRTB specification.
repeated .com.google.openrtb.Protocol protocols = 4 [packed = true];- Returns:
- A list containing the protocols.
-
getProtocolsCount
int getProtocolsCount()
Array of supported audio protocols. RECOMMENDED by the OpenRTB specification.
repeated .com.google.openrtb.Protocol protocols = 4 [packed = true];- Returns:
- The count of protocols.
-
getProtocols
OpenRtb.Protocol getProtocols(int index)
Array of supported audio protocols. RECOMMENDED by the OpenRTB specification.
repeated .com.google.openrtb.Protocol protocols = 4 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The protocols at the given index.
-
hasStartdelay
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;- Returns:
- Whether the startdelay field is set.
-
getStartdelay
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;- Returns:
- The startdelay.
-
hasSequence
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];- Returns:
- Whether the sequence field is set.
-
getSequence
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];- Returns:
- The sequence.
-
getBattrList
List<OpenRtb.CreativeAttribute> getBattrList()
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 7 [packed = true];- Returns:
- A list containing the battr.
-
getBattrCount
int getBattrCount()
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 7 [packed = true];- Returns:
- The count of battr.
-
getBattr
OpenRtb.CreativeAttribute getBattr(int index)
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 7 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The battr at the given index.
-
hasMaxextended
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;- Returns:
- Whether the maxextended field is set.
-
getMaxextended
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;- Returns:
- The maxextended.
-
hasMinbitrate
boolean hasMinbitrate()
Minimum bit rate in Kbps.
optional int32 minbitrate = 9;- Returns:
- Whether the minbitrate field is set.
-
getMinbitrate
int getMinbitrate()
Minimum bit rate in Kbps.
optional int32 minbitrate = 9;- Returns:
- The minbitrate.
-
hasMaxbitrate
boolean hasMaxbitrate()
Maximum bit rate in Kbps.
optional int32 maxbitrate = 10;- Returns:
- Whether the maxbitrate field is set.
-
getMaxbitrate
int getMaxbitrate()
Maximum bit rate in Kbps.
optional int32 maxbitrate = 10;- Returns:
- The maxbitrate.
-
getDeliveryList
List<OpenRtb.ContentDeliveryMethod> getDeliveryList()
Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported.
repeated .com.google.openrtb.ContentDeliveryMethod delivery = 11 [packed = true];- Returns:
- A list containing the delivery.
-
getDeliveryCount
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];- Returns:
- The count of delivery.
-
getDelivery
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];- Parameters:
index- The index of the element to return.- Returns:
- The delivery at the given index.
-
getCompanionadList
List<OpenRtb.BidRequest.Imp.Banner> getCompanionadList()
Array of Banner objects if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 12;
-
getCompanionad
OpenRtb.BidRequest.Imp.Banner getCompanionad(int index)
Array of Banner objects if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 12;
-
getCompanionadCount
int getCompanionadCount()
Array of Banner objects if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 12;
-
getCompanionadOrBuilderList
List<? extends OpenRtb.BidRequest.Imp.BannerOrBuilder> getCompanionadOrBuilderList()
Array of Banner objects if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 12;
-
getCompanionadOrBuilder
OpenRtb.BidRequest.Imp.BannerOrBuilder getCompanionadOrBuilder(int index)
Array of Banner objects if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 12;
-
getApiList
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];- Returns:
- A list containing the api.
-
getApiCount
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];- Returns:
- The count of api.
-
getApi
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];- Parameters:
index- The index of the element to return.- Returns:
- The api at the given index.
-
getCompaniontypeList
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];- Returns:
- A list containing the companiontype.
-
getCompaniontypeCount
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];- Returns:
- The count of companiontype.
-
getCompaniontype
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];- Parameters:
index- The index of the element to return.- Returns:
- The companiontype at the given index.
-
hasMaxseq
boolean hasMaxseq()
The maximum number of ads that can be played in an ad pod.
optional int32 maxseq = 21;- Returns:
- Whether the maxseq field is set.
-
getMaxseq
int getMaxseq()
The maximum number of ads that can be played in an ad pod.
optional int32 maxseq = 21;- Returns:
- The maxseq.
-
hasFeed
boolean hasFeed()
Type of audio feed.
optional .com.google.openrtb.FeedType feed = 22;- Returns:
- Whether the feed field is set.
-
getFeed
OpenRtb.FeedType getFeed()
Type of audio feed.
optional .com.google.openrtb.FeedType feed = 22;- Returns:
- The feed.
-
hasStitched
boolean hasStitched()
Indicates if the ad is stitched with audio content or delivered independently.
optional bool stitched = 23;- Returns:
- Whether the stitched field is set.
-
getStitched
boolean getStitched()
Indicates if the ad is stitched with audio content or delivered independently.
optional bool stitched = 23;- Returns:
- The stitched.
-
hasNvol
boolean hasNvol()
Volume normalization mode.
optional .com.google.openrtb.VolumeNormalizationMode nvol = 24;- Returns:
- Whether the nvol field is set.
-
getNvol
OpenRtb.VolumeNormalizationMode getNvol()
Volume normalization mode.
optional .com.google.openrtb.VolumeNormalizationMode nvol = 24;- Returns:
- The nvol.
-
-