Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Video.Builder

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.VideoOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Video>, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    OpenRtb.BidRequest.Imp.Video
    public static final class OpenRtb.BidRequest.Imp.Video.Builder
extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<OpenRtb.BidRequest.Imp.Video,​OpenRtb.BidRequest.Imp.Video.Builder>
implements OpenRtb.BidRequest.Imp.VideoOrBuilder
     OpenRTB 2.0: This object represents an in-stream video impression.
 Many of the fields are non-essential for minimally viable transactions,
 but are included to offer fine control when needed. Video in OpenRTB
 generally assumes compliance with the VAST standard. As such, the notion
 of companion ads is supported by optionally including an array of Banner
 objects (refer to the Banner object in Section 3.2.3) that define these
 companion ads.
 The presence of a Video as a subordinate of the Imp object indicates
 that this impression is offered as a video type impression. At the
 publisher's discretion, that same impression may also be offered as
 banner and/or native by also including as Imp subordinates the Banner
 and/or Native objects, respectively. However, any given bid for the
 impression must conform to one of the offered types.
    Protobuf type com.google.openrtb.BidRequest.Imp.Video

    • Method Detail

      • 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.Builder<OpenRtb.BidRequest.Imp.Video.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OpenRtb.BidRequest.Imp.Video.Builder>

      • getDefaultInstanceForType

        public OpenRtb.BidRequest.Imp.Video getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Video>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public OpenRtb.BidRequest.Imp.Video build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OpenRtb.BidRequest.Imp.Video buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • mergeFrom

        public OpenRtb.BidRequest.Imp.Video.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OpenRtb.BidRequest.Imp.Video.Builder>
        Throws:
        IOException

      • getMimesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getMimesList in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        A list containing the mimes.

      • getMimesCount

        public 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;
        Specified by:
        getMimesCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The count of mimes.

      • getMimes

        public 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;
        Specified by:
        getMimes in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        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)
         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;
        Specified by:
        getMimesBytes in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the mimes at the given index.

      • setMimes

        public OpenRtb.BidRequest.Imp.Video.Builder setMimes​(int index,
                                                     String value)
         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 to set the value at.
        value - The mimes to set.
        Returns:
        This builder for chaining.

      • addMimes

        public OpenRtb.BidRequest.Imp.Video.Builder addMimes​(String value)
         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:
        value - The mimes to add.
        Returns:
        This builder for chaining.

      • addAllMimes

        public OpenRtb.BidRequest.Imp.Video.Builder addAllMimes​(Iterable<String> values)
         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:
        values - The mimes to add.
        Returns:
        This builder for chaining.

      • clearMimes

        public OpenRtb.BidRequest.Imp.Video.Builder clearMimes()
         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:
        This builder for chaining.

      • addMimesBytes

        public OpenRtb.BidRequest.Imp.Video.Builder addMimesBytes​(com.google.protobuf.ByteString value)
         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:
        value - The bytes of the mimes to add.
        Returns:
        This builder for chaining.

      • hasMinduration

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

      • getMinduration

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

      • setMinduration

        public OpenRtb.BidRequest.Imp.Video.Builder setMinduration​(int value)
         Minimum video ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 minduration = 3 [default = 0];
        Parameters:
        value - The minduration to set.
        Returns:
        This builder for chaining.

      • clearMinduration

        public OpenRtb.BidRequest.Imp.Video.Builder clearMinduration()
         Minimum video ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 minduration = 3 [default = 0];
        Returns:
        This builder for chaining.

      • hasMaxduration

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

      • getMaxduration

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

      • setMaxduration

        public OpenRtb.BidRequest.Imp.Video.Builder setMaxduration​(int value)
         Maximum video ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 maxduration = 4;
        Parameters:
        value - The maxduration to set.
        Returns:
        This builder for chaining.

      • clearMaxduration

        public OpenRtb.BidRequest.Imp.Video.Builder clearMaxduration()
         Maximum video ad duration in seconds.
 RECOMMENDED by the OpenRTB specification.
        optional int32 maxduration = 4;
        Returns:
        This builder for chaining.

      • 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 = 8;
        Specified by:
        hasStartdelay in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        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 = 8;
        Specified by:
        getStartdelay in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The startdelay.

      • setStartdelay

        public OpenRtb.BidRequest.Imp.Video.Builder setStartdelay​(int value)
         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;
        Parameters:
        value - The startdelay to set.
        Returns:
        This builder for chaining.

      • clearStartdelay

        public OpenRtb.BidRequest.Imp.Video.Builder clearStartdelay()
         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:
        This builder for chaining.

      • getProtocolsList

        public 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];
        Specified by:
        getProtocolsList in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        A list containing the protocols.

      • getProtocolsCount

        public 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];
        Specified by:
        getProtocolsCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The count of protocols.

      • getProtocols

        public 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];
        Specified by:
        getProtocols in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The protocols at the given index.

      • setProtocols

        public OpenRtb.BidRequest.Imp.Video.Builder setProtocols​(int index,
                                                         OpenRtb.Protocol value)
         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 to set the value at.
        value - The protocols to set.
        Returns:
        This builder for chaining.

      • addProtocols

        public OpenRtb.BidRequest.Imp.Video.Builder addProtocols​(OpenRtb.Protocol value)
         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:
        value - The protocols to add.
        Returns:
        This builder for chaining.

      • addAllProtocols

        public OpenRtb.BidRequest.Imp.Video.Builder addAllProtocols​(Iterable<? extends OpenRtb.Protocol> values)
         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:
        values - The protocols to add.
        Returns:
        This builder for chaining.

      • clearProtocols

        public OpenRtb.BidRequest.Imp.Video.Builder clearProtocols()
         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:
        This builder for chaining.

      • hasW

        public boolean hasW()
         Width of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 w = 6;
        Specified by:
        hasW in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the w field is set.

      • getW

        public int getW()
         Width of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 w = 6;
        Specified by:
        getW in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The w.

      • setW

        public OpenRtb.BidRequest.Imp.Video.Builder setW​(int value)
         Width of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 w = 6;
        Parameters:
        value - The w to set.
        Returns:
        This builder for chaining.

      • clearW

        public OpenRtb.BidRequest.Imp.Video.Builder clearW()
         Width of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 w = 6;
        Returns:
        This builder for chaining.

      • hasH

        public boolean hasH()
         Height of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 h = 7;
        Specified by:
        hasH in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the h field is set.

      • getH

        public int getH()
         Height of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 h = 7;
        Specified by:
        getH in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The h.

      • setH

        public OpenRtb.BidRequest.Imp.Video.Builder setH​(int value)
         Height of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 h = 7;
        Parameters:
        value - The h to set.
        Returns:
        This builder for chaining.

      • clearH

        public OpenRtb.BidRequest.Imp.Video.Builder clearH()
         Height of the video player in device independent pixels (DIPS).
 RECOMMENDED by the OpenRTB specification.
        optional int32 h = 7;
        Returns:
        This builder for chaining.

      • hasPlacement

        public boolean hasPlacement()
         Placement type for the impression.
        optional .com.google.openrtb.VideoPlacementType placement = 26;
        Specified by:
        hasPlacement in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the placement field is set.

      • clearPlacement

        public OpenRtb.BidRequest.Imp.Video.Builder clearPlacement()
         Placement type for the impression.
        optional .com.google.openrtb.VideoPlacementType placement = 26;
        Returns:
        This builder for chaining.

      • hasLinearity

        public 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;
        Specified by:
        hasLinearity in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the linearity field is set.

      • setLinearity

        public OpenRtb.BidRequest.Imp.Video.Builder setLinearity​(OpenRtb.VideoLinearity value)
         Indicates if the impression must be linear, nonlinear, etc.
 If none specified, assume all are allowed.
        optional .com.google.openrtb.VideoLinearity linearity = 2;
        Parameters:
        value - The linearity to set.
        Returns:
        This builder for chaining.

      • clearLinearity

        public OpenRtb.BidRequest.Imp.Video.Builder clearLinearity()
         Indicates if the impression must be linear, nonlinear, etc.
 If none specified, assume all are allowed.
        optional .com.google.openrtb.VideoLinearity linearity = 2;
        Returns:
        This builder for chaining.

      • hasSkip

        public 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;
        Specified by:
        hasSkip in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the skip field is set.

      • getSkip

        public 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;
        Specified by:
        getSkip in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The skip.

      • setSkip

        public OpenRtb.BidRequest.Imp.Video.Builder setSkip​(boolean value)
         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;
        Parameters:
        value - The skip to set.
        Returns:
        This builder for chaining.

      • clearSkip

        public OpenRtb.BidRequest.Imp.Video.Builder clearSkip()
         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:
        This builder for chaining.

      • hasSkipmin

        public 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;
        Specified by:
        hasSkipmin in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the skipmin field is set.

      • getSkipmin

        public 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;
        Specified by:
        getSkipmin in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The skipmin.

      • setSkipmin

        public OpenRtb.BidRequest.Imp.Video.Builder setSkipmin​(int value)
         Videos of total duration greater than this number of seconds
 can be skippable; only applicable if the ad is skippable.
        optional int32 skipmin = 24;
        Parameters:
        value - The skipmin to set.
        Returns:
        This builder for chaining.

      • clearSkipmin

        public OpenRtb.BidRequest.Imp.Video.Builder clearSkipmin()
         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:
        This builder for chaining.

      • hasSkipafter

        public boolean hasSkipafter()
         Number of seconds a video must play before skipping is
 enabled; only applicable if the ad is skippable.
        optional int32 skipafter = 25;
        Specified by:
        hasSkipafter in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the skipafter field is set.

      • getSkipafter

        public int getSkipafter()
         Number of seconds a video must play before skipping is
 enabled; only applicable if the ad is skippable.
        optional int32 skipafter = 25;
        Specified by:
        getSkipafter in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The skipafter.

      • setSkipafter

        public OpenRtb.BidRequest.Imp.Video.Builder setSkipafter​(int value)
         Number of seconds a video must play before skipping is
 enabled; only applicable if the ad is skippable.
        optional int32 skipafter = 25;
        Parameters:
        value - The skipafter to set.
        Returns:
        This builder for chaining.

      • clearSkipafter

        public OpenRtb.BidRequest.Imp.Video.Builder clearSkipafter()
         Number of seconds a video must play before skipping is
 enabled; only applicable if the ad is skippable.
        optional int32 skipafter = 25;
        Returns:
        This builder for chaining.

      • 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 = 9 [default = 1];
        Specified by:
        hasSequence in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        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 = 9 [default = 1];
        Specified by:
        getSequence in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The sequence.

      • setSequence

        public OpenRtb.BidRequest.Imp.Video.Builder setSequence​(int value)
         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];
        Parameters:
        value - The sequence to set.
        Returns:
        This builder for chaining.

      • clearSequence

        public OpenRtb.BidRequest.Imp.Video.Builder clearSequence()
         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:
        This builder for chaining.

      • getBattrCount

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

      • setBattr

        public OpenRtb.BidRequest.Imp.Video.Builder setBattr​(int index,
                                                     OpenRtb.CreativeAttribute value)
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 10 [packed = true];
        Parameters:
        index - The index to set the value at.
        value - The battr to set.
        Returns:
        This builder for chaining.

      • clearBattr

        public OpenRtb.BidRequest.Imp.Video.Builder clearBattr()
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 10 [packed = true];
        Returns:
        This builder for chaining.

      • 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 = 11;
        Specified by:
        hasMaxextended in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        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 = 11;
        Specified by:
        getMaxextended in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The maxextended.

      • setMaxextended

        public OpenRtb.BidRequest.Imp.Video.Builder setMaxextended​(int value)
         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;
        Parameters:
        value - The maxextended to set.
        Returns:
        This builder for chaining.

      • clearMaxextended

        public OpenRtb.BidRequest.Imp.Video.Builder clearMaxextended()
         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:
        This builder for chaining.

      • setMinbitrate

        public OpenRtb.BidRequest.Imp.Video.Builder setMinbitrate​(int value)
         Minimum bit rate in Kbps.
        optional int32 minbitrate = 12;
        Parameters:
        value - The minbitrate to set.
        Returns:
        This builder for chaining.

      • setMaxbitrate

        public OpenRtb.BidRequest.Imp.Video.Builder setMaxbitrate​(int value)
         Maximum bit rate in Kbps.
        optional int32 maxbitrate = 13;
        Parameters:
        value - The maxbitrate to set.
        Returns:
        This builder for chaining.

      • hasBoxingallowed

        public boolean hasBoxingallowed()
         Indicates if letter-boxing of 4:3 content into a 16:9 window is
 allowed.
        optional bool boxingallowed = 14 [default = true];
        Specified by:
        hasBoxingallowed in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the boxingallowed field is set.

      • getBoxingallowed

        public boolean getBoxingallowed()
         Indicates if letter-boxing of 4:3 content into a 16:9 window is
 allowed.
        optional bool boxingallowed = 14 [default = true];
        Specified by:
        getBoxingallowed in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The boxingallowed.

      • setBoxingallowed

        public OpenRtb.BidRequest.Imp.Video.Builder setBoxingallowed​(boolean value)
         Indicates if letter-boxing of 4:3 content into a 16:9 window is
 allowed.
        optional bool boxingallowed = 14 [default = true];
        Parameters:
        value - The boxingallowed to set.
        Returns:
        This builder for chaining.

      • clearBoxingallowed

        public OpenRtb.BidRequest.Imp.Video.Builder clearBoxingallowed()
         Indicates if letter-boxing of 4:3 content into a 16:9 window is
 allowed.
        optional bool boxingallowed = 14 [default = true];
        Returns:
        This builder for chaining.

      • getPlaybackmethodList

        public 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];
        Specified by:
        getPlaybackmethodList in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        A list containing the playbackmethod.

      • getPlaybackmethodCount

        public 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];
        Specified by:
        getPlaybackmethodCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The count of playbackmethod.

      • getPlaybackmethod

        public 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];
        Specified by:
        getPlaybackmethod in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The playbackmethod at the given index.

      • setPlaybackmethod

        public OpenRtb.BidRequest.Imp.Video.Builder setPlaybackmethod​(int index,
                                                              OpenRtb.PlaybackMethod value)
         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 to set the value at.
        value - The playbackmethod to set.
        Returns:
        This builder for chaining.

      • addPlaybackmethod

        public OpenRtb.BidRequest.Imp.Video.Builder addPlaybackmethod​(OpenRtb.PlaybackMethod value)
         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:
        value - The playbackmethod to add.
        Returns:
        This builder for chaining.

      • addAllPlaybackmethod

        public OpenRtb.BidRequest.Imp.Video.Builder addAllPlaybackmethod​(Iterable<? extends OpenRtb.PlaybackMethod> values)
         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:
        values - The playbackmethod to add.
        Returns:
        This builder for chaining.

      • clearPlaybackmethod

        public OpenRtb.BidRequest.Imp.Video.Builder clearPlaybackmethod()
         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:
        This builder for chaining.

      • hasPlaybackend

        public boolean hasPlaybackend()
         The event that causes playback to end.
        optional .com.google.openrtb.PlaybackCessationMode playbackend = 27;
        Specified by:
        hasPlaybackend in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the playbackend field is set.

      • clearPlaybackend

        public OpenRtb.BidRequest.Imp.Video.Builder clearPlaybackend()
         The event that causes playback to end.
        optional .com.google.openrtb.PlaybackCessationMode playbackend = 27;
        Returns:
        This builder for chaining.

      • getDeliveryCount

        public 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];
        Specified by:
        getDeliveryCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        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 = 16 [packed = true];
        Specified by:
        getDelivery in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The delivery at the given index.

      • setDelivery

        public OpenRtb.BidRequest.Imp.Video.Builder setDelivery​(int index,
                                                        OpenRtb.ContentDeliveryMethod value)
         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 to set the value at.
        value - The delivery to set.
        Returns:
        This builder for chaining.

      • addDelivery

        public OpenRtb.BidRequest.Imp.Video.Builder addDelivery​(OpenRtb.ContentDeliveryMethod value)
         Supported delivery methods (e.g., streaming, progressive).
 If none specified, assume all are supported.
        repeated .com.google.openrtb.ContentDeliveryMethod delivery = 16 [packed = true];
        Parameters:
        value - The delivery to add.
        Returns:
        This builder for chaining.

      • addAllDelivery

        public OpenRtb.BidRequest.Imp.Video.Builder addAllDelivery​(Iterable<? extends OpenRtb.ContentDeliveryMethod> values)
         Supported delivery methods (e.g., streaming, progressive).
 If none specified, assume all are supported.
        repeated .com.google.openrtb.ContentDeliveryMethod delivery = 16 [packed = true];
        Parameters:
        values - The delivery to add.
        Returns:
        This builder for chaining.

      • clearDelivery

        public OpenRtb.BidRequest.Imp.Video.Builder clearDelivery()
         Supported delivery methods (e.g., streaming, progressive).
 If none specified, assume all are supported.
        repeated .com.google.openrtb.ContentDeliveryMethod delivery = 16 [packed = true];
        Returns:
        This builder for chaining.

      • hasPos

        public boolean hasPos()
         Ad position on screen.
        optional .com.google.openrtb.AdPosition pos = 17;
        Specified by:
        hasPos in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the pos field is set.

      • getCompanionadCount

        public int getCompanionadCount()
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;
        Specified by:
        getCompanionadCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder

      • clearCompanionad

        public OpenRtb.BidRequest.Imp.Video.Builder clearCompanionad()
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

      • removeCompanionad

        public OpenRtb.BidRequest.Imp.Video.Builder removeCompanionad​(int index)
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

      • getCompanionadBuilder

        public OpenRtb.BidRequest.Imp.Banner.Builder getCompanionadBuilder​(int index)
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

      • addCompanionadBuilder

        public OpenRtb.BidRequest.Imp.Banner.Builder addCompanionadBuilder()
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

      • addCompanionadBuilder

        public OpenRtb.BidRequest.Imp.Banner.Builder addCompanionadBuilder​(int index)
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

      • getCompanionadBuilderList

        public List<OpenRtb.BidRequest.Imp.Banner.Builder> getCompanionadBuilderList()
         Array of Banner objects (Section 3.2.3) if companion ads are available.
        repeated .com.google.openrtb.BidRequest.Imp.Banner companionad = 18;

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

      • setApi

        public OpenRtb.BidRequest.Imp.Video.Builder setApi​(int index,
                                                   OpenRtb.APIFramework value)
         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 to set the value at.
        value - The api to set.
        Returns:
        This builder for chaining.

      • addApi

        public OpenRtb.BidRequest.Imp.Video.Builder addApi​(OpenRtb.APIFramework value)
         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:
        value - The api to add.
        Returns:
        This builder for chaining.

      • addAllApi

        public OpenRtb.BidRequest.Imp.Video.Builder addAllApi​(Iterable<? extends OpenRtb.APIFramework> values)
         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:
        values - The api to add.
        Returns:
        This builder for chaining.

      • clearApi

        public OpenRtb.BidRequest.Imp.Video.Builder clearApi()
         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:
        This builder for chaining.

      • getCompaniontypeList

        public 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];
        Specified by:
        getCompaniontypeList in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        A list containing the companiontype.

      • getCompaniontypeCount

        public 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];
        Specified by:
        getCompaniontypeCount in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The count of companiontype.

      • getCompaniontype

        public 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];
        Specified by:
        getCompaniontype in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The companiontype at the given index.

      • setCompaniontype

        public OpenRtb.BidRequest.Imp.Video.Builder setCompaniontype​(int index,
                                                             OpenRtb.CompanionType value)
         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 to set the value at.
        value - The companiontype to set.
        Returns:
        This builder for chaining.

      • addCompaniontype

        public OpenRtb.BidRequest.Imp.Video.Builder addCompaniontype​(OpenRtb.CompanionType value)
         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:
        value - The companiontype to add.
        Returns:
        This builder for chaining.

      • addAllCompaniontype

        public OpenRtb.BidRequest.Imp.Video.Builder addAllCompaniontype​(Iterable<? extends OpenRtb.CompanionType> values)
         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:
        values - The companiontype to add.
        Returns:
        This builder for chaining.

      • clearCompaniontype

        public OpenRtb.BidRequest.Imp.Video.Builder clearCompaniontype()
         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:
        This builder for chaining.

      • hasProtocol

        @Deprecated
public boolean hasProtocol()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496
         DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>.
 Video bid response protocol.
        optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];
        Specified by:
        hasProtocol in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the protocol field is set.

      • getProtocol

        @Deprecated
public OpenRtb.Protocol getProtocol()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496
         DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>.
 Video bid response protocol.
        optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];
        Specified by:
        getProtocol in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        The protocol.

      • setProtocol

        @Deprecated
public OpenRtb.BidRequest.Imp.Video.Builder setProtocol​(OpenRtb.Protocol value)
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496
         DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>.
 Video bid response protocol.
        optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];
        Parameters:
        value - The protocol to set.
        Returns:
        This builder for chaining.

      • clearProtocol

        @Deprecated
public OpenRtb.BidRequest.Imp.Video.Builder clearProtocol()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Video.protocol is deprecated. See openrtb.proto;l=496
         DEPRECATED in OpenRTB 2.3+. Prefer the field <code>protocols</code>.
 Video bid response protocol.
        optional .com.google.openrtb.Protocol protocol = 5 [deprecated = true];
        Returns:
        This builder for chaining.

      • hasCompanionad21

        @Deprecated
public boolean hasCompanionad21()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Video.companionad_21 is deprecated. See openrtb.proto;l=504
         REMOVED in OpenRTB 2.2+. Prefer the field <code>companionad</code>.
        optional .com.google.openrtb.BidRequest.Imp.Video.CompanionAd companionad_21 = 22 [deprecated = true];
        Specified by:
        hasCompanionad21 in interface OpenRtb.BidRequest.Imp.VideoOrBuilder
        Returns:
        Whether the companionad21 field is set.

      • clearCompanionad21

        @Deprecated
public OpenRtb.BidRequest.Imp.Video.Builder clearCompanionad21()
        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];

      • getCompanionad21Builder

        @Deprecated
public OpenRtb.BidRequest.Imp.Video.CompanionAd.Builder getCompanionad21Builder()
        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];