Package com.google.openrtb

Interface OpenRtb.BidRequest.ContentOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getAlbum()
      Album to which the content belongs; typically for audio.
      com.google.protobuf.ByteString getAlbumBytes()
      Album to which the content belongs; typically for audio.
      String getArtist()
      Artist credited with the content.
      com.google.protobuf.ByteString getArtistBytes()
      Artist credited with the content.
      String getCat​(int index)
      Array of IAB content categories that describe the content.
      com.google.protobuf.ByteString getCatBytes​(int index)
      Array of IAB content categories that describe the content.
      int getCatCount()
      Array of IAB content categories that describe the content.
      List<String> getCatList()
      Array of IAB content categories that describe the content.
      String getContentrating()
      Content rating (e.g., MPAA).
      com.google.protobuf.ByteString getContentratingBytes()
      Content rating (e.g., MPAA).
      OpenRtb.ContentContext getContext()
      Type of content (game, video, text, etc.).
      String getContext22()
      Deprecated.
      com.google.openrtb.BidRequest.Content.context_22 is deprecated.
      com.google.protobuf.ByteString getContext22Bytes()
      Deprecated.
      com.google.openrtb.BidRequest.Content.context_22 is deprecated.
      OpenRtb.BidRequest.Data getData​(int index)
      Additional content data.
      int getDataCount()
      Additional content data.
      List<OpenRtb.BidRequest.Data> getDataList()
      Additional content data.
      OpenRtb.BidRequest.DataOrBuilder getDataOrBuilder​(int index)
      Additional content data.
      List<? extends OpenRtb.BidRequest.DataOrBuilder> getDataOrBuilderList()
      Additional content data.
      boolean getEmbeddable()
      Indicator of whether or not the content is embeddable (e.g., an embeddable video player).
      int getEpisode()
      Content episode number (typically applies to video content).
      String getGenre()
      Genre that best describes the content (e.g., rock, pop, etc).
      com.google.protobuf.ByteString getGenreBytes()
      Genre that best describes the content (e.g., rock, pop, etc).
      String getId()
      ID uniquely identifying the content.
      com.google.protobuf.ByteString getIdBytes()
      ID uniquely identifying the content.
      String getIsrc()
      International Standard Recording Code conforming to ISO-3901.
      com.google.protobuf.ByteString getIsrcBytes()
      International Standard Recording Code conforming to ISO-3901.
      String getKeywords()
      Comma separated list of keywords describing the content.
      com.google.protobuf.ByteString getKeywordsBytes()
      Comma separated list of keywords describing the content.
      String getLanguage()
      Content language using ISO-639-1-alpha-2.
      com.google.protobuf.ByteString getLanguageBytes()
      Content language using ISO-639-1-alpha-2.
      int getLen()
      Length of content in seconds; appropriate for video or audio.
      boolean getLivestream()
      false = not live, true = content is live (e.g., stream, live blog).
      OpenRtb.ProductionQuality getProdq()
      Production quality.
      OpenRtb.BidRequest.Producer getProducer()
      Details about the content Producer (Section 3.2.10).
      OpenRtb.BidRequest.ProducerOrBuilder getProducerOrBuilder()
      Details about the content Producer (Section 3.2.10).
      OpenRtb.QAGMediaRating getQagmediarating()
      Media rating per QAG guidelines.
      String getSeason()
      Content season; typically for video content (e.g., "Season 3").
      com.google.protobuf.ByteString getSeasonBytes()
      Content season; typically for video content (e.g., "Season 3").
      String getSeries()
      Content series.
      com.google.protobuf.ByteString getSeriesBytes()
      Content series.
      boolean getSourcerelationship()
      false = indirect, true = direct.
      String getTitle()
      Content title.
      com.google.protobuf.ByteString getTitleBytes()
      Content title.
      String getUrl()
      URL of the content, for buy-side contextualization or review.
      com.google.protobuf.ByteString getUrlBytes()
      URL of the content, for buy-side contextualization or review.
      String getUserrating()
      User rating of the content (e.g., number of stars, likes, etc.).
      com.google.protobuf.ByteString getUserratingBytes()
      User rating of the content (e.g., number of stars, likes, etc.).
      OpenRtb.ProductionQuality getVideoquality()
      Deprecated.
      com.google.openrtb.BidRequest.Content.videoquality is deprecated.
      boolean hasAlbum()
      Album to which the content belongs; typically for audio.
      boolean hasArtist()
      Artist credited with the content.
      boolean hasContentrating()
      Content rating (e.g., MPAA).
      boolean hasContext()
      Type of content (game, video, text, etc.).
      boolean hasContext22()
      Deprecated.
      com.google.openrtb.BidRequest.Content.context_22 is deprecated.
      boolean hasEmbeddable()
      Indicator of whether or not the content is embeddable (e.g., an embeddable video player).
      boolean hasEpisode()
      Content episode number (typically applies to video content).
      boolean hasGenre()
      Genre that best describes the content (e.g., rock, pop, etc).
      boolean hasId()
      ID uniquely identifying the content.
      boolean hasIsrc()
      International Standard Recording Code conforming to ISO-3901.
      boolean hasKeywords()
      Comma separated list of keywords describing the content.
      boolean hasLanguage()
      Content language using ISO-639-1-alpha-2.
      boolean hasLen()
      Length of content in seconds; appropriate for video or audio.
      boolean hasLivestream()
      false = not live, true = content is live (e.g., stream, live blog).
      boolean hasProdq()
      Production quality.
      boolean hasProducer()
      Details about the content Producer (Section 3.2.10).
      boolean hasQagmediarating()
      Media rating per QAG guidelines.
      boolean hasSeason()
      Content season; typically for video content (e.g., "Season 3").
      boolean hasSeries()
      Content series.
      boolean hasSourcerelationship()
      false = indirect, true = direct.
      boolean hasTitle()
      Content title.
      boolean hasUrl()
      URL of the content, for buy-side contextualization or review.
      boolean hasUserrating()
      User rating of the content (e.g., number of stars, likes, etc.).
      boolean hasVideoquality()
      Deprecated.
      com.google.openrtb.BidRequest.Content.videoquality is deprecated.

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasId

        boolean hasId()
         ID uniquely identifying the content.
        optional string id = 1;
        Returns:
        Whether the id field is set.

      • getId

        String getId()
         ID uniquely identifying the content.
        optional string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         ID uniquely identifying the content.
        optional string id = 1;
        Returns:
        The bytes for id.

      • hasEpisode

        boolean hasEpisode()
         Content episode number (typically applies to video content).
        optional int32 episode = 2;
        Returns:
        Whether the episode field is set.

      • getEpisode

        int getEpisode()
         Content episode number (typically applies to video content).
        optional int32 episode = 2;
        Returns:
        The episode.

      • hasTitle

        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;
        Returns:
        Whether the title field is set.

      • getTitle

        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;
        Returns:
        The title.

      • getTitleBytes

        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;
        Returns:
        The bytes for title.

      • hasSeries

        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;
        Returns:
        Whether the series field is set.

      • getSeries

        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;
        Returns:
        The series.

      • getSeriesBytes

        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;
        Returns:
        The bytes for series.

      • hasSeason

        boolean hasSeason()
         Content season; typically for video content (e.g., "Season 3").
        optional string season = 5;
        Returns:
        Whether the season field is set.

      • getSeason

        String getSeason()
         Content season; typically for video content (e.g., "Season 3").
        optional string season = 5;
        Returns:
        The season.

      • getSeasonBytes

        com.google.protobuf.ByteString getSeasonBytes()
         Content season; typically for video content (e.g., "Season 3").
        optional string season = 5;
        Returns:
        The bytes for season.

      • hasArtist

        boolean hasArtist()
         Artist credited with the content.
        optional string artist = 21;
        Returns:
        Whether the artist field is set.

      • getArtist

        String getArtist()
         Artist credited with the content.
        optional string artist = 21;
        Returns:
        The artist.

      • getArtistBytes

        com.google.protobuf.ByteString getArtistBytes()
         Artist credited with the content.
        optional string artist = 21;
        Returns:
        The bytes for artist.

      • hasGenre

        boolean hasGenre()
         Genre that best describes the content (e.g., rock, pop, etc).
        optional string genre = 22;
        Returns:
        Whether the genre field is set.

      • getGenre

        String getGenre()
         Genre that best describes the content (e.g., rock, pop, etc).
        optional string genre = 22;
        Returns:
        The genre.

      • getGenreBytes

        com.google.protobuf.ByteString getGenreBytes()
         Genre that best describes the content (e.g., rock, pop, etc).
        optional string genre = 22;
        Returns:
        The bytes for genre.

      • hasAlbum

        boolean hasAlbum()
         Album to which the content belongs; typically for audio.
        optional string album = 23;
        Returns:
        Whether the album field is set.

      • getAlbum

        String getAlbum()
         Album to which the content belongs; typically for audio.
        optional string album = 23;
        Returns:
        The album.

      • getAlbumBytes

        com.google.protobuf.ByteString getAlbumBytes()
         Album to which the content belongs; typically for audio.
        optional string album = 23;
        Returns:
        The bytes for album.

      • hasIsrc

        boolean hasIsrc()
         International Standard Recording Code conforming to ISO-3901.
        optional string isrc = 24;
        Returns:
        Whether the isrc field is set.

      • getIsrc

        String getIsrc()
         International Standard Recording Code conforming to ISO-3901.
        optional string isrc = 24;
        Returns:
        The isrc.

      • getIsrcBytes

        com.google.protobuf.ByteString getIsrcBytes()
         International Standard Recording Code conforming to ISO-3901.
        optional string isrc = 24;
        Returns:
        The bytes for isrc.

      • hasProducer

        boolean hasProducer()
         Details about the content Producer (Section 3.2.10).
        optional .com.google.openrtb.BidRequest.Producer producer = 15;
        Returns:
        Whether the producer field is set.

      • getProducer

        OpenRtb.BidRequest.Producer getProducer()
         Details about the content Producer (Section 3.2.10).
        optional .com.google.openrtb.BidRequest.Producer producer = 15;
        Returns:
        The producer.

      • getProducerOrBuilder

        OpenRtb.BidRequest.ProducerOrBuilder getProducerOrBuilder()
         Details about the content Producer (Section 3.2.10).
        optional .com.google.openrtb.BidRequest.Producer producer = 15;

      • hasUrl

        boolean hasUrl()
         URL of the content, for buy-side contextualization or review.
        optional string url = 6;
        Returns:
        Whether the url field is set.

      • getUrl

        String getUrl()
         URL of the content, for buy-side contextualization or review.
        optional string url = 6;
        Returns:
        The url.

      • getUrlBytes

        com.google.protobuf.ByteString getUrlBytes()
         URL of the content, for buy-side contextualization or review.
        optional string url = 6;
        Returns:
        The bytes for url.

      • getCatList

        List<String> getCatList()
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Returns:
        A list containing the cat.

      • getCatCount

        int getCatCount()
         Array of IAB content categories that describe the content.
 See enum ContentCategory.
        repeated string cat = 7;
        Returns:
        The count of cat.

      • getCat

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

      • getCatBytes

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

      • hasProdq

        boolean hasProdq()
         Production quality.
        optional .com.google.openrtb.ProductionQuality prodq = 25;
        Returns:
        Whether the prodq field is set.

      • getProdq

        OpenRtb.ProductionQuality getProdq()
         Production quality.
        optional .com.google.openrtb.ProductionQuality prodq = 25;
        Returns:
        The prodq.

      • hasContext

        boolean hasContext()
         Type of content (game, video, text, etc.).
        optional .com.google.openrtb.ContentContext context = 20;
        Returns:
        Whether the context field is set.

      • getContext

        OpenRtb.ContentContext getContext()
         Type of content (game, video, text, etc.).
        optional .com.google.openrtb.ContentContext context = 20;
        Returns:
        The context.

      • hasContentrating

        boolean hasContentrating()
         Content rating (e.g., MPAA).
        optional string contentrating = 10;
        Returns:
        Whether the contentrating field is set.

      • getContentrating

        String getContentrating()
         Content rating (e.g., MPAA).
        optional string contentrating = 10;
        Returns:
        The contentrating.

      • getContentratingBytes

        com.google.protobuf.ByteString getContentratingBytes()
         Content rating (e.g., MPAA).
        optional string contentrating = 10;
        Returns:
        The bytes for contentrating.

      • hasUserrating

        boolean hasUserrating()
         User rating of the content (e.g., number of stars, likes, etc.).
        optional string userrating = 11;
        Returns:
        Whether the userrating field is set.

      • getUserrating

        String getUserrating()
         User rating of the content (e.g., number of stars, likes, etc.).
        optional string userrating = 11;
        Returns:
        The userrating.

      • getUserratingBytes

        com.google.protobuf.ByteString getUserratingBytes()
         User rating of the content (e.g., number of stars, likes, etc.).
        optional string userrating = 11;
        Returns:
        The bytes for userrating.

      • hasQagmediarating

        boolean hasQagmediarating()
         Media rating per QAG guidelines.
        optional .com.google.openrtb.QAGMediaRating qagmediarating = 17;
        Returns:
        Whether the qagmediarating field is set.

      • getQagmediarating

        OpenRtb.QAGMediaRating getQagmediarating()
         Media rating per QAG guidelines.
        optional .com.google.openrtb.QAGMediaRating qagmediarating = 17;
        Returns:
        The qagmediarating.

      • hasKeywords

        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;
        Returns:
        Whether the keywords field is set.

      • getKeywords

        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;
        Returns:
        The keywords.

      • getKeywordsBytes

        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;
        Returns:
        The bytes for keywords.

      • hasLivestream

        boolean hasLivestream()
         false = not live, true = content is live (e.g., stream, live blog).
        optional bool livestream = 13;
        Returns:
        Whether the livestream field is set.

      • getLivestream

        boolean getLivestream()
         false = not live, true = content is live (e.g., stream, live blog).
        optional bool livestream = 13;
        Returns:
        The livestream.

      • hasSourcerelationship

        boolean hasSourcerelationship()
         false = indirect, true = direct.
        optional bool sourcerelationship = 14;
        Returns:
        Whether the sourcerelationship field is set.

      • getSourcerelationship

        boolean getSourcerelationship()
         false = indirect, true = direct.
        optional bool sourcerelationship = 14;
        Returns:
        The sourcerelationship.

      • hasLen

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

      • getLen

        int getLen()
         Length of content in seconds; appropriate for video or audio.
        optional int32 len = 16;
        Returns:
        The len.

      • hasLanguage

        boolean hasLanguage()
         Content language using ISO-639-1-alpha-2.
        optional string language = 19;
        Returns:
        Whether the language field is set.

      • getLanguage

        String getLanguage()
         Content language using ISO-639-1-alpha-2.
        optional string language = 19;
        Returns:
        The language.

      • getLanguageBytes

        com.google.protobuf.ByteString getLanguageBytes()
         Content language using ISO-639-1-alpha-2.
        optional string language = 19;
        Returns:
        The bytes for language.

      • hasEmbeddable

        boolean hasEmbeddable()
         Indicator of whether or not the content is embeddable (e.g., an
 embeddable video player).
        optional bool embeddable = 18;
        Returns:
        Whether the embeddable field is set.

      • getEmbeddable

        boolean getEmbeddable()
         Indicator of whether or not the content is embeddable (e.g., an
 embeddable video player).
        optional bool embeddable = 18;
        Returns:
        The embeddable.

      • getDataList

        List<OpenRtb.BidRequest.Data> getDataList()
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;

      • getData

        OpenRtb.BidRequest.Data getData​(int index)
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;

      • getDataCount

        int getDataCount()
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;

      • getDataOrBuilderList

        List<? extends OpenRtb.BidRequest.DataOrBuilder> getDataOrBuilderList()
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;

      • getDataOrBuilder

        OpenRtb.BidRequest.DataOrBuilder getDataOrBuilder​(int index)
         Additional content data. Each object represents a different data source.
        repeated .com.google.openrtb.BidRequest.Data data = 28;

      • hasVideoquality

        @Deprecated
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];
        Returns:
        Whether the videoquality field is set.

      • getVideoquality

        @Deprecated
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];
        Returns:
        The videoquality.

      • hasContext22

        @Deprecated
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];
        Returns:
        Whether the context22 field is set.

      • getContext22

        @Deprecated
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];
        Returns:
        The context22.

      • getContext22Bytes

        @Deprecated
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];
        Returns:
        The bytes for context22.