@ParametersAreNonnullByDefault
Package com.google.openrtb
OpenRTB model.
-
Class Summary Class Description OpenRtb OpenRtb.BidRequest OpenRTB 2.0: The top-level bid request object contains a globally unique bid request or auction ID.OpenRtb.BidRequest.App OpenRTB 2.0: This object should be included if the ad supported content is a non-browser application (typically in mobile) as opposed to a website.OpenRtb.BidRequest.App.Builder OpenRTB 2.0: This object should be included if the ad supported content is a non-browser application (typically in mobile) as opposed to a website.OpenRtb.BidRequest.Builder OpenRTB 2.0: The top-level bid request object contains a globally unique bid request or auction ID.OpenRtb.BidRequest.Content OpenRTB 2.0: This object describes the content in which the impression will appear, which may be syndicated or non-syndicated content.OpenRtb.BidRequest.Content.Builder OpenRTB 2.0: This object describes the content in which the impression will appear, which may be syndicated or non-syndicated content.OpenRtb.BidRequest.Data OpenRTB 2.0: The data and segment objects together allow additional data about the user to be specified.OpenRtb.BidRequest.Data.Builder OpenRTB 2.0: The data and segment objects together allow additional data about the user to be specified.OpenRtb.BidRequest.Data.Segment OpenRTB 2.0: Segment objects are essentially key-value pairs that convey specific units of data about the user.OpenRtb.BidRequest.Data.Segment.Builder OpenRTB 2.0: Segment objects are essentially key-value pairs that convey specific units of data about the user.OpenRtb.BidRequest.Device OpenRTB 2.0: This object provides information pertaining to the device through which the user is interacting.OpenRtb.BidRequest.Device.Builder OpenRTB 2.0: This object provides information pertaining to the device through which the user is interacting.OpenRtb.BidRequest.Geo OpenRTB 2.0: This object encapsulates various methods for specifying a geographic location.OpenRtb.BidRequest.Geo.Builder OpenRTB 2.0: This object encapsulates various methods for specifying a geographic location.OpenRtb.BidRequest.Imp OpenRTB 2.0: This object describes an ad placement or impression being auctioned.OpenRtb.BidRequest.Imp.Audio This object represents an audio type impression.OpenRtb.BidRequest.Imp.Audio.Builder This object represents an audio type impression.OpenRtb.BidRequest.Imp.Banner OpenRTB 2.0: This object represents the most general type of impression.OpenRtb.BidRequest.Imp.Banner.Builder OpenRTB 2.0: This object represents the most general type of impression.OpenRtb.BidRequest.Imp.Banner.Format OpenRTB 2.4: This object represents an allowed size (i.e., height and width combination) for a banner impression.OpenRtb.BidRequest.Imp.Banner.Format.Builder OpenRTB 2.4: This object represents an allowed size (i.e., height and width combination) for a banner impression.OpenRtb.BidRequest.Imp.Builder OpenRTB 2.0: This object describes an ad placement or impression being auctioned.OpenRtb.BidRequest.Imp.Metric OpenRTB 2.5: This object is associated with an impression as an array of metrics.OpenRtb.BidRequest.Imp.Metric.Builder OpenRTB 2.5: This object is associated with an impression as an array of metrics.OpenRtb.BidRequest.Imp.Native OpenRTB 2.3: This object represents a native type impression.OpenRtb.BidRequest.Imp.Native.Builder OpenRTB 2.3: This object represents a native type impression.OpenRtb.BidRequest.Imp.Pmp OpenRTB 2.2: This object is the private marketplace container for direct deals between buyers and sellers that may pertain to this impression.OpenRtb.BidRequest.Imp.Pmp.Builder OpenRTB 2.2: This object is the private marketplace container for direct deals between buyers and sellers that may pertain to this impression.OpenRtb.BidRequest.Imp.Pmp.Deal OpenRTB 2.2: This object constitutes a specific deal that was struck a priori between a buyer and a seller.OpenRtb.BidRequest.Imp.Pmp.Deal.Builder OpenRTB 2.2: This object constitutes a specific deal that was struck a priori between a buyer and a seller.OpenRtb.BidRequest.Imp.Video OpenRTB 2.0: This object represents an in-stream video impression.OpenRtb.BidRequest.Imp.Video.Builder OpenRTB 2.0: This object represents an in-stream video impression.OpenRtb.BidRequest.Imp.Video.CompanionAd OpenRTB 2.1 compatibility.OpenRtb.BidRequest.Imp.Video.CompanionAd.Builder OpenRTB 2.1 compatibility.OpenRtb.BidRequest.Producer OpenRTB 2.0: This object defines the producer of the content in which the ad will be shown.OpenRtb.BidRequest.Producer.Builder OpenRTB 2.0: This object defines the producer of the content in which the ad will be shown.OpenRtb.BidRequest.Publisher OpenRTB 2.0: This object describes the publisher of the media in which the ad will be displayed.OpenRtb.BidRequest.Publisher.Builder OpenRTB 2.0: This object describes the publisher of the media in which the ad will be displayed.OpenRtb.BidRequest.Regs OpenRTB 2.2: This object contains any legal, governmental, or industry regulations that apply to the request.OpenRtb.BidRequest.Regs.Builder OpenRTB 2.2: This object contains any legal, governmental, or industry regulations that apply to the request.OpenRtb.BidRequest.Site OpenRTB 2.0: This object should be included if the ad supported content is a website as opposed to a non-browser application.OpenRtb.BidRequest.Site.Builder OpenRTB 2.0: This object should be included if the ad supported content is a website as opposed to a non-browser application.OpenRtb.BidRequest.Source OpenRTB 2.5: This object describes the nature and behavior of the entity that is the source of the bid request upstream from the exchange.OpenRtb.BidRequest.Source.Builder OpenRTB 2.5: This object describes the nature and behavior of the entity that is the source of the bid request upstream from the exchange.OpenRtb.BidRequest.User OpenRTB 2.0: This object contains information known or derived about the human user of the device (i.e., the audience for advertising).OpenRtb.BidRequest.User.Builder OpenRTB 2.0: This object contains information known or derived about the human user of the device (i.e., the audience for advertising).OpenRtb.BidResponse OpenRTB 2.0: This object is the top-level bid response object (i.e., the unnamed outer JSON object).OpenRtb.BidResponse.Builder OpenRTB 2.0: This object is the top-level bid response object (i.e., the unnamed outer JSON object).OpenRtb.BidResponse.SeatBid OpenRTB 2.0: A bid response can contain multiple SeatBid objects, each on behalf of a different bidder seat and each containing one or more individual bids.OpenRtb.BidResponse.SeatBid.Bid OpenRTB 2.0: A SeatBid object contains one or more Bid objects, each of which relates to a specific impression in the bid request via the impid attribute and constitutes an offer to buy that impression for a given price.OpenRtb.BidResponse.SeatBid.Bid.Builder OpenRTB 2.0: A SeatBid object contains one or more Bid objects, each of which relates to a specific impression in the bid request via the impid attribute and constitutes an offer to buy that impression for a given price.OpenRtb.BidResponse.SeatBid.Builder OpenRTB 2.0: A bid response can contain multiple SeatBid objects, each on behalf of a different bidder seat and each containing one or more individual bids.OpenRtb.NativeRequest OpenRTB Native 1.0: The Native Object defines the native advertising opportunity available for bid via this bid request.OpenRtb.NativeRequest.Asset OpenRTB Native 1.0: The main container object for each asset requested or supported by Exchange on behalf of the rendering client.OpenRtb.NativeRequest.Asset.Builder OpenRTB Native 1.0: The main container object for each asset requested or supported by Exchange on behalf of the rendering client.OpenRtb.NativeRequest.Asset.Data OpenRTB Native 1.0: The Data Object is to be used for all non-core elements of the native unit such as Ratings, Review Count, Stars, Download count, descriptions etc.OpenRtb.NativeRequest.Asset.Data.Builder OpenRTB Native 1.0: The Data Object is to be used for all non-core elements of the native unit such as Ratings, Review Count, Stars, Download count, descriptions etc.OpenRtb.NativeRequest.Asset.Image OpenRTB Native 1.0: The Image object to be used for all image elements of the Native ad such as Icons, Main Image, etc.OpenRtb.NativeRequest.Asset.Image.Builder OpenRTB Native 1.0: The Image object to be used for all image elements of the Native ad such as Icons, Main Image, etc.OpenRtb.NativeRequest.Asset.Title OpenRTB Native 1.0: The Title object is to be used for title element of the Native ad.OpenRtb.NativeRequest.Asset.Title.Builder OpenRTB Native 1.0: The Title object is to be used for title element of the Native ad.OpenRtb.NativeRequest.Builder OpenRTB Native 1.0: The Native Object defines the native advertising opportunity available for bid via this bid request.OpenRtb.NativeRequest.EventTrackers OpenRTB Native 1.2: The EventTrackers object specifies the type of events the bidder can request to be tracked in the bid response, and which types of tracking are available for each event type, and is included as an array in the request.OpenRtb.NativeRequest.EventTrackers.Builder OpenRTB Native 1.2: The EventTrackers object specifies the type of events the bidder can request to be tracked in the bid response, and which types of tracking are available for each event type, and is included as an array in the request.OpenRtb.NativeResponse OpenRTB Native 1.0: The native response object is the top level JSON object which identifies an native response.OpenRtb.NativeResponse.Asset OpenRTB Native 1.0: Corresponds to the Asset Object in the request.OpenRtb.NativeResponse.Asset.Builder OpenRTB Native 1.0: Corresponds to the Asset Object in the request.OpenRtb.NativeResponse.Asset.Data OpenRTB Native 1.0: Corresponds to the Data Object in the request, with the value filled in.OpenRtb.NativeResponse.Asset.Data.Builder OpenRTB Native 1.0: Corresponds to the Data Object in the request, with the value filled in.OpenRtb.NativeResponse.Asset.Image OpenRTB Native 1.0: Corresponds to the Image Object in the request.OpenRtb.NativeResponse.Asset.Image.Builder OpenRTB Native 1.0: Corresponds to the Image Object in the request.OpenRtb.NativeResponse.Asset.Title OpenRTB Native 1.0: Corresponds to the Title Object in the request, with the value filled in.OpenRtb.NativeResponse.Asset.Title.Builder OpenRTB Native 1.0: Corresponds to the Title Object in the request, with the value filled in.OpenRtb.NativeResponse.Asset.Video OpenRTB Native 1.0: Corresponds to the Video Object in the request, yet containing a value of a conforming VAST tag as a value.OpenRtb.NativeResponse.Asset.Video.Builder OpenRTB Native 1.0: Corresponds to the Video Object in the request, yet containing a value of a conforming VAST tag as a value.OpenRtb.NativeResponse.Builder OpenRTB Native 1.0: The native response object is the top level JSON object which identifies an native response.OpenRtb.NativeResponse.EventTracker OpenRTB Native 1.2: The event trackers response is an array of objects and specifies the types of events the bidder wishes to track and the URLs/information to track them.OpenRtb.NativeResponse.EventTracker.Builder OpenRTB Native 1.2: The event trackers response is an array of objects and specifies the types of events the bidder wishes to track and the URLs/information to track them.OpenRtb.NativeResponse.Link OpenRTB Native 1.0: Used for "call to action" assets, or other links from the Native ad.OpenRtb.NativeResponse.Link.Builder OpenRTB Native 1.0: Used for "call to action" assets, or other links from the Native ad. -
Enum Summary Enum Description Gender Gender.OpenRtb.AdPosition OpenRTB 2.0: The following table specifies the position of the ad as a relative measure of visibility or prominence.OpenRtb.AdUnitId DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.OpenRtb.APIFramework OpenRTB 2.0: The following table is a list of API frameworks supported by the publisher.OpenRtb.AuctionType Protobuf enumcom.google.openrtb.AuctionTypeOpenRtb.BannerAdType OpenRTB 2.0: types of ads that can be accepted by the exchange unless restricted by publisher site settings.OpenRtb.BidRequest.DistributionchannelOneofCase OpenRtb.BidRequest.Imp.Native.RequestOneofCase OpenRtb.BidResponse.SeatBid.Bid.AdmOneofCase OpenRtb.CompanionType OpenRTB 2.1: The following table lists the options for the video quality.OpenRtb.ConnectionType OpenRTB 2.0: The following table lists the various options for the type of device connectivity.OpenRtb.ContentCategory OpenRTB 2.0: The following list represents the IAB's contextual taxonomy for categorization.OpenRtb.ContentContext OpenRTB 2.0: The following table lists the various options for indicating the type of content in which the impression will appear.OpenRtb.ContentDeliveryMethod OpenRTB 2.0: The following table lists the various options for the delivery of video content.OpenRtb.ContextSubtype OpenRTB Native 1.1: Next-level context in which the ad appears.OpenRtb.ContextType OpenRTB Native 1.1: The context in which the ad appears - what type of content is surrounding the ad on the page at a high level.OpenRtb.CreativeAttribute OpenRTB 2.0: The following table specifies a standard list of creative attributes that can describe an ad being served or serve as restrictions of thereof.OpenRtb.DataAssetType OpenRTB Native 1.0: Common asset element types of native advertising.OpenRtb.DeviceType OpenRTB 2.0: The following table lists the type of device from which the impression originated.OpenRtb.EventTrackingMethod OpenRTB Native 1.2.OpenRtb.EventType OpenRTB Native 1.2.OpenRtb.ExpandableDirection OpenRTB 2.0: The following table lists the directions in which an expandable ad may expand, given the positioning of the ad unit on the page and constraints imposed by the content.OpenRtb.FeedType OpenRTB 2.4: The following table lists the types of feeds, typically for audio.OpenRtb.ImageAssetType OpenRTB Native 1.0: Common image asset element types of native advertising at the time of writing this spec.OpenRtb.LayoutId DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.OpenRtb.LocationService OpenRTB 2.4: The following table lists the services and/or vendors used for resolving IP addresses to geolocations.OpenRtb.LocationType OpenRTB 2.0: The following table lists the options to indicate how the geographic information was determined.OpenRtb.LossReason OpenRTB 2.5: The following table lists the options for an exchange to inform a bidder as to the reason why they did not win an impression.OpenRtb.NativeRequest.Asset.AssetOneofCase OpenRtb.NativeResponse.Asset.AssetOneofCase OpenRtb.NoBidReason OpenRTB 2.2: The following table lists the options for a bidder to signal the exchange as to why it did not offer a bid for the impression.OpenRtb.PlacementType OpenRTB Native 1.1: The FORMAT of the ad you are purchasing, separate from the surrounding context.OpenRtb.PlaybackCessationMode OpenRTB 2.5: The various modes for when playback terminates.OpenRtb.PlaybackMethod OpenRTB 2.0: The following table lists the various playback methods.OpenRtb.ProductionQuality OpenRTB 2.0: The following table lists the options for content quality.OpenRtb.Protocol OpenRTB 2.0: The following table lists the options for the various bid response protocols that could be supported by an exchange.OpenRtb.QAGMediaRating OpenRTB 2.1: The following table lists the media ratings used in describing content based on the QAG categorization.OpenRtb.StartDelay OpenRTB 2.0: The following table lists the various options for the audio/video start delay.OpenRtb.VideoLinearity OpenRTB 2.0: The following table indicates the options for video linearity.OpenRtb.VideoPlacementType OpenRTB 2.5: The following table lists the various types of video placements derived largely from the IAB Digital Video Guidelines.OpenRtb.VolumeNormalizationMode OpenRTB 2.4: The following table lists the types of volume normalization modes, typically for audio.