Package com.google.openrtb

Class OpenRtb.BidRequest.Content

  • All Implemented Interfaces:
    OpenRtb.BidRequest.ContentOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Content>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest
    public static final class OpenRtb.BidRequest.Content
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Content>
implements OpenRtb.BidRequest.ContentOrBuilder
     OpenRTB 2.0: This object describes the content in which the impression
 will appear, which may be syndicated or non-syndicated content.
 This object may be useful when syndicated content contains impressions and
 does not necessarily match the publisher's general content.
 The exchange might or might not have knowledge of the page where the
 content is running, as a result of the syndication method.
 For example might be a video impression embedded in an iframe on an
 unknown web property or device.
    Protobuf type com.google.openrtb.BidRequest.Content
    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

      • hasId

        public boolean hasId()
         ID uniquely identifying the content.
        optional string id = 1;
        Specified by:
        hasId in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the id field is set.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         ID uniquely identifying the content.
        optional string id = 1;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for id.

      • hasEpisode

        public boolean hasEpisode()
         Content episode number (typically applies to video content).
        optional int32 episode = 2;
        Specified by:
        hasEpisode in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the episode field is set.

      • getEpisode

        public int getEpisode()
         Content episode number (typically applies to video content).
        optional int32 episode = 2;
        Specified by:
        getEpisode in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The episode.

      • hasTitle

        public boolean hasTitle()
         Content title.
 Video Examples: "Search Committee" (television), "A New Hope" (movie),
 or "Endgame" (made for web).
 Non-Video Example: "Why an Antarctic Glacier Is Melting So Quickly"
 (Time magazine article).
        optional string title = 3;
        Specified by:
        hasTitle in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the title field is set.

      • getTitle

        public String getTitle()
         Content title.
 Video Examples: "Search Committee" (television), "A New Hope" (movie),
 or "Endgame" (made for web).
 Non-Video Example: "Why an Antarctic Glacier Is Melting So Quickly"
 (Time magazine article).
        optional string title = 3;
        Specified by:
        getTitle in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The title.

      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         Content title.
 Video Examples: "Search Committee" (television), "A New Hope" (movie),
 or "Endgame" (made for web).
 Non-Video Example: "Why an Antarctic Glacier Is Melting So Quickly"
 (Time magazine article).
        optional string title = 3;
        Specified by:
        getTitleBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for title.

      • hasSeries

        public boolean hasSeries()
         Content series.
 Video Examples: "The Office" (television), "Star Wars" (movie),
 or "Arby 'N' The Chief" (made for web).
 Non-Video Example: "Ecocentric" (Time Magazine blog).
        optional string series = 4;
        Specified by:
        hasSeries in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the series field is set.

      • getSeries

        public String getSeries()
         Content series.
 Video Examples: "The Office" (television), "Star Wars" (movie),
 or "Arby 'N' The Chief" (made for web).
 Non-Video Example: "Ecocentric" (Time Magazine blog).
        optional string series = 4;
        Specified by:
        getSeries in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The series.

      • getSeriesBytes

        public com.google.protobuf.ByteString getSeriesBytes()
         Content series.
 Video Examples: "The Office" (television), "Star Wars" (movie),
 or "Arby 'N' The Chief" (made for web).
 Non-Video Example: "Ecocentric" (Time Magazine blog).
        optional string series = 4;
        Specified by:
        getSeriesBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for series.

      • hasSeason

        public boolean hasSeason()
         Content season; typically for video content (e.g., "Season 3").
        optional string season = 5;
        Specified by:
        hasSeason in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the season field is set.

      • getSeasonBytes

        public com.google.protobuf.ByteString getSeasonBytes()
         Content season; typically for video content (e.g., "Season 3").
        optional string season = 5;
        Specified by:
        getSeasonBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for season.

      • hasArtist

        public boolean hasArtist()
         Artist credited with the content.
        optional string artist = 21;
        Specified by:
        hasArtist in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the artist field is set.

      • getArtistBytes

        public com.google.protobuf.ByteString getArtistBytes()
         Artist credited with the content.
        optional string artist = 21;
        Specified by:
        getArtistBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for artist.

      • hasGenre

        public boolean hasGenre()
         Genre that best describes the content (e.g., rock, pop, etc).
        optional string genre = 22;
        Specified by:
        hasGenre in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the genre field is set.

      • getGenreBytes

        public com.google.protobuf.ByteString getGenreBytes()
         Genre that best describes the content (e.g., rock, pop, etc).
        optional string genre = 22;
        Specified by:
        getGenreBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for genre.

      • hasAlbum

        public boolean hasAlbum()
         Album to which the content belongs; typically for audio.
        optional string album = 23;
        Specified by:
        hasAlbum in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the album field is set.

      • getAlbumBytes

        public com.google.protobuf.ByteString getAlbumBytes()
         Album to which the content belongs; typically for audio.
        optional string album = 23;
        Specified by:
        getAlbumBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for album.

      • hasIsrc

        public boolean hasIsrc()
         International Standard Recording Code conforming to ISO-3901.
        optional string isrc = 24;
        Specified by:
        hasIsrc in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the isrc field is set.

      • getIsrcBytes

        public com.google.protobuf.ByteString getIsrcBytes()
         International Standard Recording Code conforming to ISO-3901.
        optional string isrc = 24;
        Specified by:
        getIsrcBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for isrc.

      • hasProducer

        public boolean hasProducer()
         Details about the content Producer (Section 3.2.10).
        optional .com.google.openrtb.BidRequest.Producer producer = 15;
        Specified by:
        hasProducer in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the producer field is set.

      • hasUrl

        public boolean hasUrl()
         URL of the content, for buy-side contextualization or review.
        optional string url = 6;
        Specified by:
        hasUrl in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the url field is set.

      • getUrlBytes

        public com.google.protobuf.ByteString getUrlBytes()
         URL of the content, for buy-side contextualization or review.
        optional string url = 6;
        Specified by:
        getUrlBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for url.

      • getCatList

        public com.google.protobuf.ProtocolStringList getCatList()
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Specified by:
        getCatList in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        A list containing the cat.

      • getCatCount

        public int getCatCount()
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Specified by:
        getCatCount in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The count of cat.

      • getCat

        public String getCat​(int index)
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Specified by:
        getCat in interface OpenRtb.BidRequest.ContentOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The cat at the given index.

      • getCatBytes

        public com.google.protobuf.ByteString getCatBytes​(int index)
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Specified by:
        getCatBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the cat at the given index.

      • hasProdq

        public boolean hasProdq()
         Production quality.
        optional .com.google.openrtb.ProductionQuality prodq = 25;
        Specified by:
        hasProdq in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the prodq field is set.

      • hasContext

        public boolean hasContext()
         Type of content (game, video, text, etc.).
        optional .com.google.openrtb.ContentContext context = 20;
        Specified by:
        hasContext in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the context field is set.

      • hasUserrating

        public boolean hasUserrating()
         User rating of the content (e.g., number of stars, likes, etc.).
        optional string userrating = 11;
        Specified by:
        hasUserrating in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the userrating field is set.

      • getUserratingBytes

        public com.google.protobuf.ByteString getUserratingBytes()
         User rating of the content (e.g., number of stars, likes, etc.).
        optional string userrating = 11;
        Specified by:
        getUserratingBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for userrating.

      • hasQagmediarating

        public boolean hasQagmediarating()
         Media rating per QAG guidelines.
        optional .com.google.openrtb.QAGMediaRating qagmediarating = 17;
        Specified by:
        hasQagmediarating in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the qagmediarating field is set.

      • hasKeywords

        public boolean hasKeywords()
         Comma separated list of keywords describing the content.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 9;
        Specified by:
        hasKeywords in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the keywords field is set.

      • getKeywords

        public String getKeywords()
         Comma separated list of keywords describing the content.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 9;
        Specified by:
        getKeywords in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The keywords.

      • getKeywordsBytes

        public com.google.protobuf.ByteString getKeywordsBytes()
         Comma separated list of keywords describing the content.
 Note: OpenRTB 2.2 allowed an array-of-strings as alternate implementation
 but this was fixed in 2.3+ where it's definitely a single string with CSV
 content again. Compatibility with some OpenRTB 2.2 exchanges that adopted
 the alternate representation may require custom handling of the JSON.
        optional string keywords = 9;
        Specified by:
        getKeywordsBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for keywords.

      • hasLivestream

        public boolean hasLivestream()
         false = not live, true = content is live (e.g., stream, live blog).
        optional bool livestream = 13;
        Specified by:
        hasLivestream in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the livestream field is set.

      • getLivestream

        public boolean getLivestream()
         false = not live, true = content is live (e.g., stream, live blog).
        optional bool livestream = 13;
        Specified by:
        getLivestream in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The livestream.

      • hasLen

        public boolean hasLen()
         Length of content in seconds; appropriate for video or audio.
        optional int32 len = 16;
        Specified by:
        hasLen in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the len field is set.

      • getLen

        public int getLen()
         Length of content in seconds; appropriate for video or audio.
        optional int32 len = 16;
        Specified by:
        getLen in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The len.

      • hasLanguage

        public boolean hasLanguage()
         Content language using ISO-639-1-alpha-2.
        optional string language = 19;
        Specified by:
        hasLanguage in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the language field is set.

      • getLanguageBytes

        public com.google.protobuf.ByteString getLanguageBytes()
         Content language using ISO-639-1-alpha-2.
        optional string language = 19;
        Specified by:
        getLanguageBytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for language.

      • hasEmbeddable

        public boolean hasEmbeddable()
         Indicator of whether or not the content is embeddable (e.g., an
 embeddable video player).
        optional bool embeddable = 18;
        Specified by:
        hasEmbeddable in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the embeddable field is set.

      • getEmbeddable

        public boolean getEmbeddable()
         Indicator of whether or not the content is embeddable (e.g., an
 embeddable video player).
        optional bool embeddable = 18;
        Specified by:
        getEmbeddable in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The embeddable.

      • getDataCount

        public int getDataCount()
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;
        Specified by:
        getDataCount in interface OpenRtb.BidRequest.ContentOrBuilder

      • hasVideoquality

        @Deprecated
public boolean hasVideoquality()
        Deprecated.
        com.google.openrtb.BidRequest.Content.videoquality is deprecated. See openrtb.proto;l=947
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>prodq</code>.
 Video quality per IAB's classification.
        optional .com.google.openrtb.ProductionQuality videoquality = 8 [deprecated = true];
        Specified by:
        hasVideoquality in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the videoquality field is set.

      • getVideoquality

        @Deprecated
public OpenRtb.ProductionQuality getVideoquality()
        Deprecated.
        com.google.openrtb.BidRequest.Content.videoquality is deprecated. See openrtb.proto;l=947
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>prodq</code>.
 Video quality per IAB's classification.
        optional .com.google.openrtb.ProductionQuality videoquality = 8 [deprecated = true];
        Specified by:
        getVideoquality in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The videoquality.

      • hasContext22

        @Deprecated
public boolean hasContext22()
        Deprecated.
        com.google.openrtb.BidRequest.Content.context_22 is deprecated. See openrtb.proto;l=950
         REMOVED in OpenRTB 2.3+. Prefer the field <code>context</code>.
        optional string context_22 = 12 [deprecated = true];
        Specified by:
        hasContext22 in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        Whether the context22 field is set.

      • getContext22

        @Deprecated
public String getContext22()
        Deprecated.
        com.google.openrtb.BidRequest.Content.context_22 is deprecated. See openrtb.proto;l=950
         REMOVED in OpenRTB 2.3+. Prefer the field <code>context</code>.
        optional string context_22 = 12 [deprecated = true];
        Specified by:
        getContext22 in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The context22.

      • getContext22Bytes

        @Deprecated
public com.google.protobuf.ByteString getContext22Bytes()
        Deprecated.
        com.google.openrtb.BidRequest.Content.context_22 is deprecated. See openrtb.proto;l=950
         REMOVED in OpenRTB 2.3+. Prefer the field <code>context</code>.
        optional string context_22 = 12 [deprecated = true];
        Specified by:
        getContext22Bytes in interface OpenRtb.BidRequest.ContentOrBuilder
        Returns:
        The bytes for context22.

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

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

        public OpenRtb.BidRequest.Content.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OpenRtb.BidRequest.Content.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

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