Package com.google.openrtb
Interface OpenRtb.BidRequest.Imp.VideoOrBuilder
-
- All Superinterfaces:
com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Video>,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpenRtb.BidRequest.Imp.Video,OpenRtb.BidRequest.Imp.Video.Builder
- Enclosing class:
- OpenRtb.BidRequest.Imp
public static interface OpenRtb.BidRequest.Imp.VideoOrBuilder extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Video>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated 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.booleangetBoxingallowed()Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed.OpenRtb.BidRequest.Imp.BannergetCompanionad(int index)Array of Banner objects (Section 3.2.3) if companion ads are available.OpenRtb.BidRequest.Imp.Video.CompanionAdgetCompanionad21()Deprecated.com.google.openrtb.BidRequest.Imp.Video.companionad_21 is deprecated.OpenRtb.BidRequest.Imp.Video.CompanionAdOrBuildergetCompanionad21OrBuilder()Deprecated.intgetCompanionadCount()Array of Banner objects (Section 3.2.3) if companion ads are available.List<OpenRtb.BidRequest.Imp.Banner>getCompanionadList()Array of Banner objects (Section 3.2.3) if companion ads are available.OpenRtb.BidRequest.Imp.BannerOrBuildergetCompanionadOrBuilder(int index)Array of Banner objects (Section 3.2.3) if companion ads are available.List<? extends OpenRtb.BidRequest.Imp.BannerOrBuilder>getCompanionadOrBuilderList()Array of Banner objects (Section 3.2.3) if companion ads are available.OpenRtb.CompanionTypegetCompaniontype(int index)Supported VAST companion ad types.intgetCompaniontypeCount()Supported VAST companion ad types.List<OpenRtb.CompanionType>getCompaniontypeList()Supported VAST 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).intgetH()Height of the video player in device independent pixels (DIPS).OpenRtb.VideoLinearitygetLinearity()Indicates if the impression must be linear, nonlinear, etc.intgetMaxbitrate()Maximum bit rate in Kbps.intgetMaxduration()Maximum video ad duration in seconds.intgetMaxextended()Maximum extended video ad duration, if extension is allowed.StringgetMimes(int index)Allowlist of content MIME types supported.com.google.protobuf.ByteStringgetMimesBytes(int index)Allowlist of content MIME types supported.intgetMimesCount()Allowlist of content MIME types supported.List<String>getMimesList()Allowlist of content MIME types supported.intgetMinbitrate()Minimum bit rate in Kbps.intgetMinduration()Minimum video ad duration in seconds.OpenRtb.VideoPlacementTypegetPlacement()Placement type for the impression.OpenRtb.PlaybackCessationModegetPlaybackend()The event that causes playback to end.OpenRtb.PlaybackMethodgetPlaybackmethod(int index)Playback methods that may be in use.intgetPlaybackmethodCount()Playback methods that may be in use.List<OpenRtb.PlaybackMethod>getPlaybackmethodList()Playback methods that may be in use.OpenRtb.AdPositiongetPos()Ad position on screen.OpenRtb.ProtocolgetProtocol()Deprecated.com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated.OpenRtb.ProtocolgetProtocols(int index)Array of supported video bid response protocols.intgetProtocolsCount()Array of supported video bid response protocols.List<OpenRtb.Protocol>getProtocolsList()Array of supported video bid response 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.booleangetSkip()Indicates if the player will allow the video to be skipped.intgetSkipafter()Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.intgetSkipmin()Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.intgetStartdelay()Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.intgetW()Width of the video player in device independent pixels (DIPS).booleanhasBoxingallowed()Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed.booleanhasCompanionad21()Deprecated.com.google.openrtb.BidRequest.Imp.Video.companionad_21 is deprecated.booleanhasH()Height of the video player in device independent pixels (DIPS).booleanhasLinearity()Indicates if the impression must be linear, nonlinear, etc.booleanhasMaxbitrate()Maximum bit rate in Kbps.booleanhasMaxduration()Maximum video ad duration in seconds.booleanhasMaxextended()Maximum extended video ad duration, if extension is allowed.booleanhasMinbitrate()Minimum bit rate in Kbps.booleanhasMinduration()Minimum video ad duration in seconds.booleanhasPlacement()Placement type for the impression.booleanhasPlaybackend()The event that causes playback to end.booleanhasPos()Ad position on screen.booleanhasProtocol()Deprecated.com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated.booleanhasSequence()If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.booleanhasSkip()Indicates if the player will allow the video to be skipped.booleanhasSkipafter()Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.booleanhasSkipmin()Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.booleanhasStartdelay()Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.booleanhasW()Width of the video player in device independent pixels (DIPS).-
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()
Allowlist of content MIME types supported. Popular MIME types include, but are not limited to "image/jpg", "image/gif" and "application/x-shockwave-flash". REQUIRED by the OpenRTB specification: at least 1 element.
repeated string mimes = 1;- Returns:
- A list containing the mimes.
-
getMimesCount
int getMimesCount()
Allowlist of content MIME types supported. Popular MIME types include, but are not limited to "image/jpg", "image/gif" and "application/x-shockwave-flash". REQUIRED by the OpenRTB specification: at least 1 element.
repeated string mimes = 1;- Returns:
- The count of mimes.
-
getMimes
String getMimes(int index)
Allowlist of content MIME types supported. Popular MIME types include, but are not limited to "image/jpg", "image/gif" and "application/x-shockwave-flash". 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)
Allowlist of content MIME types supported. Popular MIME types include, but are not limited to "image/jpg", "image/gif" and "application/x-shockwave-flash". 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 video ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 minduration = 3 [default = 0];- Returns:
- Whether the minduration field is set.
-
getMinduration
int getMinduration()
Minimum video ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 minduration = 3 [default = 0];- Returns:
- The minduration.
-
hasMaxduration
boolean hasMaxduration()
Maximum video ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 maxduration = 4;- Returns:
- Whether the maxduration field is set.
-
getMaxduration
int getMaxduration()
Maximum video ad duration in seconds. RECOMMENDED by the OpenRTB specification.
optional int32 maxduration = 4;- Returns:
- The maxduration.
-
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 = 8;- 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 = 8;- Returns:
- The startdelay.
-
getProtocolsList
List<OpenRtb.Protocol> getProtocolsList()
Array of supported video bid response protocols. At least one supported protocol must be specified.
repeated .com.google.openrtb.Protocol protocols = 21 [packed = true];- Returns:
- A list containing the protocols.
-
getProtocolsCount
int getProtocolsCount()
Array of supported video bid response protocols. At least one supported protocol must be specified.
repeated .com.google.openrtb.Protocol protocols = 21 [packed = true];- Returns:
- The count of protocols.
-
getProtocols
OpenRtb.Protocol getProtocols(int index)
Array of supported video bid response protocols. At least one supported protocol must be specified.
repeated .com.google.openrtb.Protocol protocols = 21 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The protocols at the given index.
-
hasW
boolean hasW()
Width of the video player in device independent pixels (DIPS). RECOMMENDED by the OpenRTB specification.
optional int32 w = 6;- Returns:
- Whether the w field is set.
-
getW
int getW()
Width of the video player in device independent pixels (DIPS). RECOMMENDED by the OpenRTB specification.
optional int32 w = 6;- Returns:
- The w.
-
hasH
boolean hasH()
Height of the video player in device independent pixels (DIPS). RECOMMENDED by the OpenRTB specification.
optional int32 h = 7;- Returns:
- Whether the h field is set.
-
getH
int getH()
Height of the video player in device independent pixels (DIPS). RECOMMENDED by the OpenRTB specification.
optional int32 h = 7;- Returns:
- The h.
-
hasPlacement
boolean hasPlacement()
Placement type for the impression.
optional .com.google.openrtb.VideoPlacementType placement = 26;- Returns:
- Whether the placement field is set.
-
getPlacement
OpenRtb.VideoPlacementType getPlacement()
Placement type for the impression.
optional .com.google.openrtb.VideoPlacementType placement = 26;- Returns:
- The placement.
-
hasLinearity
boolean hasLinearity()
Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.
optional .com.google.openrtb.VideoLinearity linearity = 2;- Returns:
- Whether the linearity field is set.
-
getLinearity
OpenRtb.VideoLinearity getLinearity()
Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.
optional .com.google.openrtb.VideoLinearity linearity = 2;- Returns:
- The linearity.
-
hasSkip
boolean hasSkip()
Indicates if the player will allow the video to be skipped. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of 16 indicating skippable video.
optional bool skip = 23;- Returns:
- Whether the skip field is set.
-
getSkip
boolean getSkip()
Indicates if the player will allow the video to be skipped. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of 16 indicating skippable video.
optional bool skip = 23;- Returns:
- The skip.
-
hasSkipmin
boolean hasSkipmin()
Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.
optional int32 skipmin = 24;- Returns:
- Whether the skipmin field is set.
-
getSkipmin
int getSkipmin()
Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.
optional int32 skipmin = 24;- Returns:
- The skipmin.
-
hasSkipafter
boolean hasSkipafter()
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
optional int32 skipafter = 25;- Returns:
- Whether the skipafter field is set.
-
getSkipafter
int getSkipafter()
Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
optional int32 skipafter = 25;- Returns:
- The skipafter.
-
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 = 9 [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 = 9 [default = 1];- Returns:
- The sequence.
-
getBattrList
List<OpenRtb.CreativeAttribute> getBattrList()
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 10 [packed = true];- Returns:
- A list containing the battr.
-
getBattrCount
int getBattrCount()
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 10 [packed = true];- Returns:
- The count of battr.
-
getBattr
OpenRtb.CreativeAttribute getBattr(int index)
Blocked creative attributes.
repeated .com.google.openrtb.CreativeAttribute battr = 10 [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 = 11;- 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 = 11;- Returns:
- The maxextended.
-
hasMinbitrate
boolean hasMinbitrate()
Minimum bit rate in Kbps.
optional int32 minbitrate = 12;- Returns:
- Whether the minbitrate field is set.
-
getMinbitrate
int getMinbitrate()
Minimum bit rate in Kbps.
optional int32 minbitrate = 12;- Returns:
- The minbitrate.
-
hasMaxbitrate
boolean hasMaxbitrate()
Maximum bit rate in Kbps.
optional int32 maxbitrate = 13;- Returns:
- Whether the maxbitrate field is set.
-
getMaxbitrate
int getMaxbitrate()
Maximum bit rate in Kbps.
optional int32 maxbitrate = 13;- Returns:
- The maxbitrate.
-
hasBoxingallowed
boolean hasBoxingallowed()
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed.
optional bool boxingallowed = 14 [default = true];- Returns:
- Whether the boxingallowed field is set.
-
getBoxingallowed
boolean getBoxingallowed()
Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed.
optional bool boxingallowed = 14 [default = true];- Returns:
- The boxingallowed.
-
getPlaybackmethodList
List<OpenRtb.PlaybackMethod> getPlaybackmethodList()
Playback methods that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.
repeated .com.google.openrtb.PlaybackMethod playbackmethod = 15 [packed = true];- Returns:
- A list containing the playbackmethod.
-
getPlaybackmethodCount
int getPlaybackmethodCount()
Playback methods that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.
repeated .com.google.openrtb.PlaybackMethod playbackmethod = 15 [packed = true];- Returns:
- The count of playbackmethod.
-
getPlaybackmethod
OpenRtb.PlaybackMethod getPlaybackmethod(int index)
Playback methods that may be in use. If none are specified, any method may be used. Only one method is typically used in practice. As a result, this array may be converted to an integer in a future version of the specification. It is strongly advised to use only the first element of this array in preparation for this change.
repeated .com.google.openrtb.PlaybackMethod playbackmethod = 15 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The playbackmethod at the given index.
-
hasPlaybackend
boolean hasPlaybackend()
The event that causes playback to end.
optional .com.google.openrtb.PlaybackCessationMode playbackend = 27;- Returns:
- Whether the playbackend field is set.
-
getPlaybackend
OpenRtb.PlaybackCessationMode getPlaybackend()
The event that causes playback to end.
optional .com.google.openrtb.PlaybackCessationMode playbackend = 27;- Returns:
- The playbackend.
-
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 = 16 [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 = 16 [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 = 16 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The delivery at the given index.
-
hasPos
boolean hasPos()
Ad position on screen.
optional .com.google.openrtb.AdPosition pos = 17;- Returns:
- Whether the pos field is set.
-
getPos
OpenRtb.AdPosition getPos()
Ad position on screen.
optional .com.google.openrtb.AdPosition pos = 17;- Returns:
- The pos.
-
getCompanionadList
List<OpenRtb.BidRequest.Imp.Banner> getCompanionadList()
Array of Banner objects (Section 3.2.3) if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
-
getCompanionad
OpenRtb.BidRequest.Imp.Banner getCompanionad(int index)
Array of Banner objects (Section 3.2.3) if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
-
getCompanionadCount
int getCompanionadCount()
Array of Banner objects (Section 3.2.3) if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
-
getCompanionadOrBuilderList
List<? extends OpenRtb.BidRequest.Imp.BannerOrBuilder> getCompanionadOrBuilderList()
Array of Banner objects (Section 3.2.3) if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
-
getCompanionadOrBuilder
OpenRtb.BidRequest.Imp.BannerOrBuilder getCompanionadOrBuilder(int index)
Array of Banner objects (Section 3.2.3) if companion ads are available.
repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
-
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 = 19 [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 = 19 [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 = 19 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The api at the given index.
-
getCompaniontypeList
List<OpenRtb.CompanionType> getCompaniontypeList()
Supported VAST 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 VAST 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 VAST 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.
-
hasProtocol
@Deprecated boolean hasProtocol()
Deprecated.com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>. Video bid response protocol.
optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];- Returns:
- Whether the protocol field is set.
-
getProtocol
@Deprecated OpenRtb.Protocol getProtocol()
Deprecated.com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>. Video bid response protocol.
optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];- Returns:
- The protocol.
-
hasCompanionad21
@Deprecated boolean hasCompanionad21()
Deprecated.com.google.openrtb.BidRequest.Imp.Video.companionad_21 is deprecated. See openrtb.proto;l=504REMOVED in OpenRTB 2.2+. Prefer the field <code>companionad</code>.
optional .com.google.openrtb.BidRequest.Imp.Video.CompanionAd companionad_21 = 22 [deprecated = true];- Returns:
- Whether the companionad21 field is set.
-
getCompanionad21
@Deprecated OpenRtb.BidRequest.Imp.Video.CompanionAd getCompanionad21()
Deprecated.com.google.openrtb.BidRequest.Imp.Video.companionad_21 is deprecated. See openrtb.proto;l=504REMOVED in OpenRTB 2.2+. Prefer the field <code>companionad</code>.
optional .com.google.openrtb.BidRequest.Imp.Video.CompanionAd companionad_21 = 22 [deprecated = true];- Returns:
- The companionad21.
-
getCompanionad21OrBuilder
@Deprecated OpenRtb.BidRequest.Imp.Video.CompanionAdOrBuilder getCompanionad21OrBuilder()
Deprecated.REMOVED in OpenRTB 2.2+. Prefer the field <code>companionad</code>.
optional .com.google.openrtb.BidRequest.Imp.Video.CompanionAd companionad_21 = 22 [deprecated = true];
-
-