| Class | Description |
|---|---|
| Extension | |
| Extension.AdvertiserInfo |
Next available tag: 5
Refer to the documentation of BuyerPricingRule in adx.proto
to understand the meaning of these fields.
|
| Extension.AdvertiserInfo.Builder |
Next available tag: 5
Refer to the documentation of BuyerPricingRule in adx.proto
to understand the meaning of these fields.
|
| Extension.AdxBidRequestExtension |
Exchange specific extensions.
|
| Extension.AdxBidRequestExtension.Builder |
Exchange specific extensions.
|
| Extension.AdxGeoExtension |
Protobuf type
openrtb.AdxGeoExtension |
| Extension.AdxGeoExtension.Builder |
Protobuf type
openrtb.AdxGeoExtension |
| Extension.AdxImpressionExtension |
Protobuf type
openrtb.AdxImpressionExtension |
| Extension.AdxImpressionExtension.Builder |
Protobuf type
openrtb.AdxImpressionExtension |
| Extension.AppExtensions |
Protobuf type
openrtb.AppExtensions |
| Extension.AppExtensions.Builder |
Protobuf type
openrtb.AppExtensions |
| Extension.AppNexusBidRequestExtension |
2.
|
| Extension.AppNexusBidRequestExtension.Builder |
2.
|
| Extension.BannerExtensions |
Next available tag: 5
|
| Extension.BannerExtensions.Builder |
Next available tag: 5
|
| Extension.BidExtensions |
Next available tag: 11
|
| Extension.BidExtensions.Builder |
Next available tag: 11
|
| Extension.BidRequestExtensions |
Next available tag: 10
|
| Extension.BidRequestExtensions.AugmentorData |
Next available tag: 3
|
| Extension.BidRequestExtensions.AugmentorData.Builder |
Next available tag: 3
|
| Extension.BidRequestExtensions.AugmentorData.Segment |
Next available tag: 3
Segment along with augmentor's ID allows augmentor based targeting
|
| Extension.BidRequestExtensions.AugmentorData.Segment.Builder |
Next available tag: 3
Segment along with augmentor's ID allows augmentor based targeting
|
| Extension.BidRequestExtensions.Builder |
Next available tag: 10
|
| Extension.BidResponseExtensions |
Protobuf type
openrtb.BidResponseExtensions |
| Extension.BidResponseExtensions.Builder |
Protobuf type
openrtb.BidResponseExtensions |
| Extension.ContentExtensions |
Protobuf type
openrtb.ContentExtensions |
| Extension.ContentExtensions.Builder |
Protobuf type
openrtb.ContentExtensions |
| Extension.DataExtensions |
Next available tag: 2
|
| Extension.DataExtensions.Builder |
Next available tag: 2
|
| Extension.DeviceExtensions |
Next available tag: 5
Tag 1: idfa - Deprecated.
|
| Extension.DeviceExtensions.Builder |
Next available tag: 5
Tag 1: idfa - Deprecated.
|
| Extension.Dimension |
Next available tag: 3
Used to represent <w,h> at various places in the
extensions.
|
| Extension.Dimension.Builder |
Next available tag: 3
Used to represent <w,h> at various places in the
extensions.
|
| Extension.DirectDealExtensions |
Protobuf type
openrtb.DirectDealExtensions |
| Extension.DirectDealExtensions.Builder |
Protobuf type
openrtb.DirectDealExtensions |
| Extension.GeoExtensions |
Next available tag: 2
|
| Extension.GeoExtensions.Builder |
Next available tag: 2
|
| Extension.ImpressionExtensions |
Next available tag: 9
|
| Extension.ImpressionExtensions.Builder |
Next available tag: 9
|
| Extension.NativeExtensions |
Protobuf type
openrtb.NativeExtensions |
| Extension.NativeExtensions.Builder |
Protobuf type
openrtb.NativeExtensions |
| Extension.PMPExtensions |
Protobuf type
openrtb.PMPExtensions |
| Extension.PMPExtensions.Builder |
Protobuf type
openrtb.PMPExtensions |
| Extension.ProducerExtensions |
Protobuf type
openrtb.ProducerExtensions |
| Extension.ProducerExtensions.Builder |
Protobuf type
openrtb.ProducerExtensions |
| Extension.PublisherExtensions |
Protobuf type
openrtb.PublisherExtensions |
| Extension.PublisherExtensions.Builder |
Protobuf type
openrtb.PublisherExtensions |
| Extension.RegulationsExtensions |
Protobuf type
openrtb.RegulationsExtensions |
| Extension.RegulationsExtensions.Builder |
Protobuf type
openrtb.RegulationsExtensions |
| Extension.SeatBidExtensions |
Protobuf type
openrtb.SeatBidExtensions |
| Extension.SeatBidExtensions.Builder |
Protobuf type
openrtb.SeatBidExtensions |
| Extension.SegmentExtensions |
Protobuf type
openrtb.SegmentExtensions |
| Extension.SegmentExtensions.Builder |
Protobuf type
openrtb.SegmentExtensions |
| Extension.SiteExtensions |
Protobuf type
openrtb.SiteExtensions |
| Extension.SiteExtensions.Builder |
Protobuf type
openrtb.SiteExtensions |
| Extension.TargetingGeoExtension |
This field is used for Geo targeting.
|
| Extension.TargetingGeoExtension.Builder |
This field is used for Geo targeting.
|
| Extension.UserExtensions |
Next available tag: 3
|
| Extension.UserExtensions.Builder |
Next available tag: 3
|
| Extension.VideoExtensions |
Next available tag: 6
|
| Extension.VideoExtensions.Builder |
Next available tag: 6
|
| Extension.ViewabilityExtensions |
Viewability.predicted_viewability is populated by FES LocalAugmentor
and used for targeting in Matcher
|
| Extension.ViewabilityExtensions.Builder |
Viewability.predicted_viewability is populated by FES LocalAugmentor
and used for targeting in Matcher
|
| Openrtb | |
| Openrtb.BidRequest |
OpenRTB 3.3.1: The top-level bid request object.
|
| Openrtb.BidRequest.App |
OpenRTB 3.3.6: should be included if the ad supported content is part of a mobile application
(as opposed to a mobile website).
|
| Openrtb.BidRequest.App.Builder |
OpenRTB 3.3.6: should be included if the ad supported content is part of a mobile application
(as opposed to a mobile website).
|
| Openrtb.BidRequest.Builder |
OpenRTB 3.3.1: The top-level bid request object.
|
| Openrtb.BidRequest.Content |
OpenRTB 3.3.7: describes the content of a site or app.
|
| Openrtb.BidRequest.Content.Builder |
OpenRTB 3.3.7: describes the content of a site or app.
|
| Openrtb.BidRequest.Data |
OpenRTB 3.3.13: The data and segment objects together allow data about the user to be passed
to bidders in the bid request.
|
| Openrtb.BidRequest.Data.Builder |
OpenRTB 3.3.13: The data and segment objects together allow data about the user to be passed
to bidders in the bid request.
|
| Openrtb.BidRequest.Data.Segment |
OpenRTB 3.3.14: convey specific units of information from the provider identified
in the parent data object.
|
| Openrtb.BidRequest.Data.Segment.Builder |
OpenRTB 3.3.14: convey specific units of information from the provider identified
in the parent data object.
|
| Openrtb.BidRequest.Device |
OpenRTB 3.3.10: Provides information pertaining to the device including its hardware,
platform, location, and carrier.
|
| Openrtb.BidRequest.Device.Builder |
OpenRTB 3.3.10: Provides information pertaining to the device including its hardware,
platform, location, and carrier.
|
| Openrtb.BidRequest.Geo |
OpenRTB 3.3.11: describes the current geographic location of the Device (e.g., based on IP
address or GPS), or the home geo of the User (e.g., based on registration data).
|
| Openrtb.BidRequest.Geo.Builder |
OpenRTB 3.3.11: describes the current geographic location of the Device (e.g., based on IP
address or GPS), or the home geo of the User (e.g., based on registration data).
|
| Openrtb.BidRequest.Impression |
OpenRTB 3.3.2: describes the ad position or impression being auctioned.
|
| Openrtb.BidRequest.Impression.Banner |
OpenRTB 3.3.3: A banner object typically describes an ad impressions opportunity for banner,
rich media or in-banner video inventory.
|
| Openrtb.BidRequest.Impression.Banner.Builder |
OpenRTB 3.3.3: A banner object typically describes an ad impressions opportunity for banner,
rich media or in-banner video inventory.
|
| Openrtb.BidRequest.Impression.Builder |
OpenRTB 3.3.2: describes the ad position or impression being auctioned.
|
| Openrtb.BidRequest.Impression.Native |
OpenRTB 3.2.5: This object represents a native type impression.
|
| Openrtb.BidRequest.Impression.Native.Builder |
OpenRTB 3.2.5: This object represents a native type impression.
|
| Openrtb.BidRequest.Impression.PMP |
OpenRTB 3.3.16: contains a parent object for usage within the context of private
marketplaces and the use of the RTB protocol to execute Direct Deals.
|
| Openrtb.BidRequest.Impression.PMP.Builder |
OpenRTB 3.3.16: contains a parent object for usage within the context of private
marketplaces and the use of the RTB protocol to execute Direct Deals.
|
| Openrtb.BidRequest.Impression.PMP.DirectDeal |
OpenRTB 3.3.17: constitutes a deal struck a priori between a buyer and a seller and
indicates that this impression is available under the terms of that deal.
|
| Openrtb.BidRequest.Impression.PMP.DirectDeal.Builder |
OpenRTB 3.3.17: constitutes a deal struck a priori between a buyer and a seller and
indicates that this impression is available under the terms of that deal.
|
| Openrtb.BidRequest.Impression.Video |
OpenRTB 3.3.4: A video object typically describes an ad opportunity for in-stream video
inventory (including linear pre-roll, mid-roll and post-roll, and non-linear overlays).
|
| Openrtb.BidRequest.Impression.Video.Builder |
OpenRTB 3.3.4: A video object typically describes an ad opportunity for in-stream video
inventory (including linear pre-roll, mid-roll and post-roll, and non-linear overlays).
|
| Openrtb.BidRequest.Producer |
OpenRTB 3.3.9: describes the producer of content object, which might be different from the
publisher of the content of the page.
|
| Openrtb.BidRequest.Producer.Builder |
OpenRTB 3.3.9: describes the producer of content object, which might be different from the
publisher of the content of the page.
|
| Openrtb.BidRequest.Publisher |
OpenRTB 3.3.8: describes the publisher of a site or app.
|
| Openrtb.BidRequest.Publisher.Builder |
OpenRTB 3.3.8: describes the publisher of a site or app.
|
| Openrtb.BidRequest.Regulations |
OpenRTB 3.3.15: Legal, governmental, or industry regulations that apply to the request.
|
| Openrtb.BidRequest.Regulations.Builder |
OpenRTB 3.3.15: Legal, governmental, or industry regulations that apply to the request.
|
| Openrtb.BidRequest.Site |
OpenRTB 3.3.5: should be included if the ad supported content is part of a website
(as opposed to an application).
|
| Openrtb.BidRequest.Site.Builder |
OpenRTB 3.3.5: should be included if the ad supported content is part of a website
(as opposed to an application).
|
| Openrtb.BidRequest.User |
OpenRTB 3.3.12: contains information known or derived about the human user of the device.
|
| Openrtb.BidRequest.User.Builder |
OpenRTB 3.3.12: contains information known or derived about the human user of the device.
|
| Openrtb.BidResponse |
OpenRTB 4.3.1: top-level bid response object.
|
| Openrtb.BidResponse.Builder |
OpenRTB 4.3.1: top-level bid response object.
|
| Openrtb.BidResponse.SeatBid |
OpenRTB 4.3.2: A bid response can contain multiple “seatbid” objects, each on behalf of a
different bidder seat.
|
| Openrtb.BidResponse.SeatBid.Bid |
OpenRTB 4.3.3: For each bid, the “nurl” attribute contains the win notice URL.
|
| Openrtb.BidResponse.SeatBid.Bid.Builder |
OpenRTB 4.3.3: For each bid, the “nurl” attribute contains the win notice URL.
|
| Openrtb.BidResponse.SeatBid.Builder |
OpenRTB 4.3.2: A bid response can contain multiple “seatbid” objects, each on behalf of a
different bidder seat.
|
| Openrtb.NativeRequest |
OpenRTB Native 4.1: The Native Object defines the native advertising opportunity
available for bid via this bid request.
|
| Openrtb.NativeRequest.Asset |
OpenRTB Native 4.2: The main container object for each asset requested or supported by
Exchange on behalf of the rendering client.
|
| Openrtb.NativeRequest.Asset.Builder |
OpenRTB Native 4.2: The main container object for each asset requested or supported by
Exchange on behalf of the rendering client.
|
| Openrtb.NativeRequest.Asset.Data |
OpenRT Native 4.6: 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 |
OpenRT Native 4.6: 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 4.4: 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 4.4: 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 4.3: The Title object is to be used for title element of the Native ad.
|
| Openrtb.NativeRequest.Asset.Title.Builder |
OpenRTB Native 4.3: The Title object is to be used for title element of the Native ad.
|
| Openrtb.NativeRequest.Builder |
OpenRTB Native 4.1: The Native Object defines the native advertising opportunity
available for bid via this bid request.
|
| Openrtb.NativeResponse |
OpenRTB Native 5.2: The native response object is the top level JSON object which identifies
an native response.
|
| Openrtb.NativeResponse.Asset |
OpenRTB Native 5.3: Corresponds to the Asset Object in the request.
|
| Openrtb.NativeResponse.Asset.Builder |
OpenRTB Native 5.3: Corresponds to the Asset Object in the request.
|
| Openrtb.NativeResponse.Asset.Data |
OpenRTB Native 5.6: Corresponds to the Data Object in the request, with the value filled in.
|
| Openrtb.NativeResponse.Asset.Data.Builder |
OpenRTB Native 5.6: Corresponds to the Data Object in the request, with the value filled in.
|
| Openrtb.NativeResponse.Asset.Image |
OpenRTB Native 5.5: Corresponds to the Image Object in the request.
|
| Openrtb.NativeResponse.Asset.Image.Builder |
OpenRTB Native 5.5: Corresponds to the Image Object in the request.
|
| Openrtb.NativeResponse.Asset.Title |
OpenRTB Native 5.4: Corresponds to the Title Object in the request, with the value filled in.
|
| Openrtb.NativeResponse.Asset.Title.Builder |
OpenRTB Native 5.4: Corresponds to the Title Object in the request, with the value filled in.
|
| Openrtb.NativeResponse.Asset.Video |
OpenRTB Native 5.7: 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 5.7: 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 5.2: The native response object is the top level JSON object which identifies
an native response.
|
| Openrtb.NativeResponse.Link |
OpenRTB Native 5.8: Used for "call to action" assets, or other links from the Native ad.
|
| Openrtb.NativeResponse.Link.Builder |
OpenRTB Native 5.8: Used for "call to action" assets, or other links from the Native ad.
|
| OpenrtbCommon | |
| OpenrtbCommon.Enums |
Protobuf type
openrtb.Enums |
| OpenrtbCommon.Enums.BidRequest |
Protobuf type
openrtb.Enums.BidRequest |
| OpenrtbCommon.Enums.BidRequest.Builder |
Protobuf type
openrtb.Enums.BidRequest |
| OpenrtbCommon.Enums.BidRequest.Content |
Protobuf type
openrtb.Enums.BidRequest.Content |
| OpenrtbCommon.Enums.BidRequest.Content.Builder |
Protobuf type
openrtb.Enums.BidRequest.Content |
| OpenrtbCommon.Enums.BidRequest.Device |
Protobuf type
openrtb.Enums.BidRequest.Device |
| OpenrtbCommon.Enums.BidRequest.Device.Builder |
Protobuf type
openrtb.Enums.BidRequest.Device |
| OpenrtbCommon.Enums.BidRequest.Geo |
Protobuf type
openrtb.Enums.BidRequest.Geo |
| OpenrtbCommon.Enums.BidRequest.Geo.Builder |
Protobuf type
openrtb.Enums.BidRequest.Geo |
| OpenrtbCommon.Enums.BidRequest.Impression |
Protobuf type
openrtb.Enums.BidRequest.Impression |
| OpenrtbCommon.Enums.BidRequest.Impression.Banner |
Protobuf type
openrtb.Enums.BidRequest.Impression.Banner |
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.BannerExtensions |
Protobuf type
openrtb.Enums.BidRequest.Impression.Banner.BannerExtensions |
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.BannerExtensions.Builder |
Protobuf type
openrtb.Enums.BidRequest.Impression.Banner.BannerExtensions |
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.Builder |
Protobuf type
openrtb.Enums.BidRequest.Impression.Banner |
| OpenrtbCommon.Enums.BidRequest.Impression.Builder |
Protobuf type
openrtb.Enums.BidRequest.Impression |
| OpenrtbCommon.Enums.BidRequest.Impression.Video |
Protobuf type
openrtb.Enums.BidRequest.Impression.Video |
| OpenrtbCommon.Enums.BidRequest.Impression.Video.Builder |
Protobuf type
openrtb.Enums.BidRequest.Impression.Video |
| OpenrtbCommon.Enums.BidRequest.Impression.Video.VideoExtensions |
Protobuf type
openrtb.Enums.BidRequest.Impression.Video.VideoExtensions |
| OpenrtbCommon.Enums.BidRequest.Impression.Video.VideoExtensions.Builder |
Protobuf type
openrtb.Enums.BidRequest.Impression.Video.VideoExtensions |
| OpenrtbCommon.Enums.BidRequest.User |
Protobuf type
openrtb.Enums.BidRequest.User |
| OpenrtbCommon.Enums.BidRequest.User.Builder |
Protobuf type
openrtb.Enums.BidRequest.User |
| OpenrtbCommon.Enums.BidResponse |
Protobuf type
openrtb.Enums.BidResponse |
| OpenrtbCommon.Enums.BidResponse.Builder |
Protobuf type
openrtb.Enums.BidResponse |
| OpenrtbCommon.Enums.Builder |
Protobuf type
openrtb.Enums |
| OpenrtbCommon.Enums.Inventory |
Following constants are defined by Beeswax and are not a part of the
Openrtb standard.
|
| OpenrtbCommon.Enums.Inventory.Builder |
Following constants are defined by Beeswax and are not a part of the
Openrtb standard.
|
| Enum | Description |
|---|---|
| Extension.VideoExtensions.PlacementType |
Protobuf enum
openrtb.VideoExtensions.PlacementType |
| Openrtb.NativeRequest.AdUnitId |
OpenRTB Native 7.2: Below is a list of the core ad unit ids described by IAB here:
http://www.iab.net/media/file/IABNativeAdvertisingPlaybook120413.pdf
In feed unit is essentially a layout, it has been removed from the list.
|
| Openrtb.NativeRequest.Asset.Data.DataAssetType |
OpenRTB Native 7.3: Common asset element types of native advertising.
|
| Openrtb.NativeRequest.Asset.Image.ImageAssetType |
OpenRTB Native 7.4: Common image asset element types of native advertising at
the time of writing this spec.
|
| Openrtb.NativeRequest.LayoutId |
OpenRTB Native 7.1: Core layouts.
|
| OpenrtbCommon.ContentCategory |
OpenRTB 6.1: IAB contextual taxonomy for categorization.
|
| OpenrtbCommon.CreativeAttribute |
creative attributes that can describe an ad being served
or serve as restrictions of thereof.
|
| OpenrtbCommon.Enums.BidRequest.Content.Context |
OpenRTB 6.13: Options for the content context; what type of content is it.
|
| OpenrtbCommon.Enums.BidRequest.Content.QAGMediaRating |
OpenRTB 6.18: media ratings using the QAG categorization.
|
| OpenrtbCommon.Enums.BidRequest.Content.SourceRelationship |
Protobuf enum
openrtb.Enums.BidRequest.Content.SourceRelationship |
| OpenrtbCommon.Enums.BidRequest.Content.VideoQuality |
OpenRTB 6.14: video quality.
|
| OpenrtbCommon.Enums.BidRequest.Device.ConnectionType |
OpenRTB 6.10: connection type.
|
| OpenrtbCommon.Enums.BidRequest.Device.DeviceType |
The type of device from which the impression originated.
|
| OpenrtbCommon.Enums.BidRequest.Geo.LocationType |
OpenRTB 6.15: how the geographic information was determined.
|
| OpenrtbCommon.Enums.BidRequest.Impression.AdPosition |
OpenRTB 6.5: the position of the ad as a relative measure of visibility or
prominence.
|
| OpenrtbCommon.Enums.BidRequest.Impression.ApiFramework |
OpenRTB 6.4: API frameworks.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.AdType |
OpenRTB 6.2: types of ads that can be accepted by the exchange unless
restricted by publisher site settings.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.BannerExtensions.BannerType |
Some exchanges support a "bannertype=rewarded" field for banners.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Banner.ExpandableDirection |
OpenRTB 6.11: 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.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.CompanionType |
OpenRTB 6.17: markup types allowed for video companion ads.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.ContentDelivery |
OpenRTB 6.12: delivery of video content.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.Linearity |
OpenRTB 6.6: "In-stream" or "linear" video refers to pre-roll, post-roll, or
mid-roll
video ads where the user is forced to watch ad in order to see the video
content.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.PlaybackMethod |
OpenRTB 6.8: video playback methods.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.Protocol |
OpenRTB 6.7: video bid response protocols that could be supported by an
exchange.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.VideoExtensions.VideoType |
Some exchanges support a "videotype=rewarded" field for videos.
|
| OpenrtbCommon.Enums.BidRequest.Impression.Video.VideoStartDelay |
OpenRTB 6.9: Various options for the video start delay.
|
| OpenrtbCommon.Enums.BidRequest.User.UserIdType |
UserID types.
|
| OpenrtbCommon.Enums.BidResponse.NoBidReason |
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.
|
| OpenrtbCommon.Enums.Inventory.Continent |
Continents are nonoverlapping geographic areas.
|
| OpenrtbCommon.Enums.Inventory.DataCenter |
DataCenter, a.k.a.
|
| OpenrtbCommon.Enums.Inventory.EnvironmentType |
Environment type of the bid request.
|
| OpenrtbCommon.Enums.Inventory.PlacementType |
Placement Type of the OpenRTB Bid Request
|
| OpenrtbCommon.Enums.Inventory.Source |
Exchange Id.
|
| OpenrtbCommon.Flag |
Boolean-like enumeration used in various attributes.
|
Copyright © 2017. All rights reserved.