option java_outer_classname = "OpenRtb"; package com.google.openrtb; // Copyright 2021 Google Inc. All Rights Reserved. // OpenRTB extensions ("ext" fields in the spec & JSON representation) // are represented here by Protocol Buffer extensions. This proto only // reserves the range of IDs 100-9999 at every extensible object. // Reserved ranges: // 100-199: Reserved for Google. // 200-299: Reserved for IAB's formal standard extensions. // 300-999: Free for use with other exchanges or projects. // 1000-1999: Reserved for Google. // 2000-9999: Free for use with other exchanges or projects. // OpenRTB 2.0: The top-level bid request object contains a globally unique // bid request or auction ID. This id attribute is required as is at least one // impression object (Section 3.2.2). Other attributes in this top-level object // establish rules and restrictions that apply to all impressions being offered. // // There are also several subordinate objects that provide detailed data to // potential buyers. Among these are the Site and App objects, which describe // the type of published media in which the impression(s) appear. // These objects are highly recommended, but only one applies to a given // bid request depending on whether the media is browser-based web content // or a non-browser application, respectively. message BidRequest { // Unique ID of the bid request, provided by the exchange. // REQUIRED by the OpenRTB specification. required string id = 1; // Array of Imp objects (Section 3.2.2) representing the impressions offered. // At least 1 Imp object is required. repeated Imp imp = 2; oneof distributionchannel_oneof { // Details via a Site object (Section 3.2.6) about the publisher's website. // Only applicable and recommended for websites. Site site = 3; // Details via an App object (Section 3.2.7) about the publisher's app // (non-browser applications). Only applicable and recommended for apps. App app = 4; } // Details via a Device object (Section 3.2.11) about the user's // device to which the impression will be delivered. optional Device device = 5; // A Regs object (Section 3.2.16) that specifies any industry, legal, // or governmental regulations in force for this request. optional Regs regs = 14; // Details via a User object (Section 3.2.13) about the human // user of the device; the advertising audience. optional User user = 6; // Auction type, where 1 = First Price, 2 = Second Price Plus. // Exchange-specific auction types can be defined using values > 500. optional AuctionType at = 7 [default = SECOND_PRICE]; // Maximum time in milliseconds to submit a bid to avoid timeout. // This value is commonly communicated offline. optional int32 tmax = 8; // Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this // impression. IDs of seats and knowledge of the buyer's customers to which // they refer must be coordinated between bidders and the exchange a priori. // Omission implies no seat restrictions. repeated string wseat = 9; // Flag to indicate if Exchange can verify that the impressions offered // represent all of the impressions available in context (e.g., all on the // web page, all video spots such as pre/mid/post roll) to support // road-blocking. 0 = no or unknown, 1 = yes, the impressions offered // represent all that are available. optional bool allimps = 10 [default = false]; // Array of allowed currencies for bids on this bid request using ISO-4217 // alpha codes. Recommended only if the exchange accepts multiple currencies. repeated string cur = 11; // Blocked advertiser categories using the IAB content categories. // Refer to enum ContentCategory. repeated string bcat = 12; // Block list of advertisers by their domains (e.g., "ford.com"). repeated string badv = 13; // Block list of applications by their platform-specific exchange // independent application identifiers. On Android, these should // be bundle or package names (e.g., com.foo.mygame). // On iOS, these are numeric IDs. repeated string bapp = 16; // Indicator of test mode in which auctions are not billable, // where 0 = live mode, 1 = test mode. optional bool test = 15 [default = false]; // Block list of buyer seats (e.g., advertisers, agencies) restricted // from bidding on this impression. IDs of seats and knowledge // of the buyer's customers to which they refer must be // coordinated between bidders and the exchange a priori. // At most, only one of wseat and bseat should be used in the // same request. Omission of both implies no seat restrictions. repeated string bseat = 17; // Allowlist of languages for creatives using ISO-639-1-alpha-2. // Omission implies no specific restrictions, but buyers would be // advised to consider language attribute in the Device and/or // Content objects if available. repeated string wlang = 18; // A Source object (Section 3.2.2) that provides data about the // inventory source and which entity makes the final decision. optional Source source = 19; // Extensions. extensions 100 to 9999; // 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. // The primary purpose of this object is to define post-auction or upstream // decisioning when the exchange itself does not control the final decision. // A common example of this is header bidding, but it can also apply to // upstream server entities such as another RTB exchange, a mediation // platform, or an ad server combines direct campaigns with 3rd party // demand in decisioning. message Source { // Entity responsible for the final impression sale decision, // where 0 = exchange, 1 = upstream source // RECOMMENDED by the OpenRTB specification. optional bool fd = 1; // Transaction ID that must be common across all participants in // this bid request (e.g., potentially multiple exchanges). // RECOMMENDED by the OpenRTB specification. optional string tid = 2; // Payment ID chain string containing embedded syntax // described in the TAG Payment ID Protocol v1.0. // RECOMMENDED by the OpenRTB specification. optional string pchain = 3; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object describes an ad placement or impression // being auctioned. A single bid request can include multiple Imp objects, // a use case for which might be an exchange that supports selling all // ad positions on a given page. Each Imp object has a required ID so that // bids can reference them individually. // // The presence of Banner (Section 3.2.3), Video (Section 3.2.4), // and/or Native (Section 3.2.5) objects subordinate to the Imp object // indicates the type of impression being offered. The publisher can choose // one such type which is the typical case or mix them at their discretion. // Any given bid for the impression must conform to one of the offered types. message Imp { // A unique identifier for this impression within the context of the bid // request (typically, value starts with 1, and increments up to n // for n impressions). required string id = 1; // A Banner object (Section 3.2.3); required if this impression is // offered as a banner ad opportunity. optional Banner banner = 2; // A Video object (Section 3.2.4); required if this impression is // offered as a video ad opportunity. optional Video video = 3; // An Audio object; required if this impression is offered // as an audio ad opportunity. optional Audio audio = 15; // Name of ad mediation partner, SDK technology, or player responsible // for rendering ad (typically video or mobile). Used by some ad servers // to customize ad code by partner. Recommended for video and/or apps. optional string displaymanager = 4; // Version of ad mediation partner, SDK technology, or player responsible // for rendering ad (typically video or mobile). Used by some ad servers // to customize ad code by partner. Recommended for video and/or apps. optional string displaymanagerver = 5; // 1 = the ad is interstitial or full screen, 0 = not interstitial. optional bool instl = 6; // Identifier for specific ad placement or ad tag that was used to // initiate the auction. This can be useful for debugging of any issues, // or for optimization by the buyer. optional string tagid = 7; // Minimum bid for this impression expressed in CPM. optional double bidfloor = 8 [default = 0]; // Currency specified using ISO-4217 alpha codes. This may be different // from bid currency returned by bidder if this is allowed by the exchange. optional string bidfloorcur = 9 [default = "USD"]; // Indicates the type of browser opened upon clicking the // creative in an app, where 0 = embedded, 1 = native. // Note that the Safari View Controller in iOS 9.x devices is considered // a native browser for purposes of this attribute. optional bool clickbrowser = 16; // Flag to indicate if the impression requires secure HTTPS URL creative // assets and markup, where 0 = non-secure, 1 = secure. If omitted, // the secure state is unknown, but non-secure HTTP support can be assumed. optional bool secure = 12; // Array of exchange-specific names of supported iframe busters. repeated string iframebuster = 10; // A Pmp object (Section 3.2.17) containing any private marketplace deals // in effect for this impression. optional Pmp pmp = 11; // A Native object (Section 3.2.5); required if this impression is // offered as a native ad opportunity. optional Native native = 13; // Advisory as to the number of seconds that may elapse // between the auction and the actual impression. optional int32 exp = 14; // An array of Metric object (Section 3.2.5). repeated Metric metric = 17; // Extensions. extensions 100 to 9999; // OpenRTB 2.5: This object is associated with an impression as // an array of metrics. These metrics can offer insight into // the impression to assist with decisioning such as average recent // viewability, click-through rate, etc. Each metric is identified // by its type, reports the value of the metric, and optionally // identifies the source or vendor measuring the value. message Metric { // Type of metric being presented using exchange curated string // names which should be published to bidders a priori. // REQUIRED by the OpenRTB specification. optional string type = 1; // Number representing the value of the metric. // Probabilities must be in the range 0.0 - 1.0. // REQUIRED by the OpenRTB specification. optional double value = 2; // Source of the value using exchange curated string names // which should be published to bidders a priori. // If the exchange itself is the source versus a third party, // "EXCHANGE" is recommended. // RECOMMENDED by the OpenRTB specification. optional string vendor = 3; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object represents the most general type of // impression. Although the term "banner" may have very specific meaning // in other contexts, here it can be many things including a simple static // image, an expandable ad unit, or even in-banner video (refer to the Video // object in Section 3.2.4 for the more generalized and full featured video // ad units). An array of Banner objects can also appear within the Video // to describe optional companion ads defined in the VAST specification. // // The presence of a Banner as a subordinate of the Imp object indicates // that this impression is offered as a banner type impression. // At the publisher's discretion, that same impression may also be offered // as video and/or native by also including as Imp subordinates the Video // and/or Native objects, respectively. However, any given bid for the // impression must conform to one of the offered types. message Banner { // Width in device independent pixels (DIPS). // If no format objects are specified, this is an exact width // requirement. Otherwise it is a preferred width. optional int32 w = 1; // Height in device independent pixels (DIPS). // If no format objects are specified, this is an exact height // requirement. Otherwise it is a preferred height. optional int32 h = 2; // Array of format objects representing the banner sizes permitted. // If none are specified, then use of the h and w attributes // is highly recommended. repeated Format format = 15; // NOTE: Deprecated in favor of the format array. // Maximum width in device independent pixels (DIPS). optional int32 wmax = 11 [deprecated = true]; // NOTE: Deprecated in favor of the format array. // Maximum height in device independent pixels (DIPS). optional int32 hmax = 12 [deprecated = true]; // NOTE: Deprecated in favor of the format array. // Minimum width in device independent pixels (DIPS). optional int32 wmin = 13 [deprecated = true]; // NOTE: Deprecated in favor of the format array. // Minimum height in device independent pixels (DIPS). optional int32 hmin = 14 [deprecated = true]; // Unique identifier for this banner object. Recommended when Banner // objects are used with a Video object (Section 3.2.4) to represent // an array of companion ads. Values usually start at 1 and increase // with each object; should be unique within an impression. optional string id = 3; // Ad position on screen. optional AdPosition pos = 4; // Blocked banner ad types. repeated BannerAdType btype = 5 [packed = true]; // Blocked creative attributes. repeated CreativeAttribute battr = 6 [packed = true]; // Allowlist of content MIME types supported. Popular MIME types include, // but are not limited to "image/jpg", "image/gif" and // "application/x-shockwave-flash". repeated string mimes = 7; // Specify if the banner is delivered in the top frame (true) // or in an iframe (false). optional bool topframe = 8; // Directions in which the banner may expand. repeated ExpandableDirection expdir = 9 [packed = true]; // List of supported API frameworks for this impression. // If an API is not explicitly listed, it is assumed not to be supported. repeated APIFramework api = 10 [packed = true]; // Relevant only for Banner objects used with a Video object // (Section 3.2.7) in an array of companion ads. Indicates the // companion banner rendering mode relative to the associated // video, where 0 = concurrent, 1 = end-card. optional bool vcm = 16; // Extensions. extensions 100 to 9999; // OpenRTB 2.4: This object represents an allowed size (i.e., // height and width combination) for a banner impression. // These are typically used in an array for an impression where // multiple sizes are permitted. message Format { // Width in device independent pixels (DIPS). optional int32 w = 1; // Height in device independent pixels (DIPS). optional int32 h = 2; // Relative width when expressing size as a ratio. optional int32 wratio = 3; // Relative height when expressing size as a ratio. optional int32 hratio = 4; // The minimum width in device independent pixels (DIPS) at // which the ad will be displayed when the size is expressed as a ratio. optional int32 wmin = 5; // Extensions. extensions 100 to 9999; } } // 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. message Video { // 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; // Indicates if the impression must be linear, nonlinear, etc. // If none specified, assume all are allowed. optional VideoLinearity linearity = 2; // Minimum video ad duration in seconds. // RECOMMENDED by the OpenRTB specification. optional int32 minduration = 3; // Maximum video ad duration in seconds. // RECOMMENDED by the OpenRTB specification. optional int32 maxduration = 4; // Deprecated; use protocols. optional Protocol protocol = 5 [deprecated = true]; // Array of supported video bid response protocols. // At least one supported protocol must be specified. repeated Protocol protocols = 21 [packed = true]; // Width of the video player in device independent pixels (DIPS). // RECOMMENDED by the OpenRTB specification. optional int32 w = 6; // Height of the video player in device independent pixels (DIPS). // RECOMMENDED by the OpenRTB specification. optional int32 h = 7; // 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; // Indicates if the player will allow the video to be skipped, // where 0 = no, 1 = yes. // 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; // Videos of total duration greater than this number of seconds // can be skippable; only applicable if the ad is skippable. optional int32 skipmin = 24; // Number of seconds a video must play before skipping is // enabled; only applicable if the ad is skippable. optional int32 skipafter = 25; // 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]; // Blocked creative attributes. repeated CreativeAttribute battr = 10 [packed = true]; // 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; // Minimum bit rate in Kbps. optional int32 minbitrate = 12; // Maximum bit rate in Kbps. optional int32 maxbitrate = 13; // Indicates if letter-boxing of 4:3 content into a 16:9 window is // allowed, where 0 = no, 1 = yes. optional bool boxingallowed = 14 [default = true]; // 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 PlaybackMethod playbackmethod = 15 [packed = true]; // Supported delivery methods (e.g., streaming, progressive). // If none specified, assume all are supported. repeated ContentDeliveryMethod delivery = 16 [packed = true]; // Ad position on screen. optional AdPosition pos = 17; // Array of Banner objects (Section 3.2.3) if companion ads are available. repeated Banner companionad = 18; // Companion ads in OpenRTB 2.1 format. (Or to be precise, interpretations // based on the buggy sample message in 5.1.4, fixed later in 2.2.) optional CompanionAd companionad_21 = 22 [deprecated = true]; // List of supported API frameworks for this impression. // If an API is not explicitly listed, it is assumed not to be supported. repeated APIFramework api = 19 [packed = true]; // Supported VAST companion ad types. Recommended if companion Banner // objects are included via the companionad array. repeated CompanionType companiontype = 20 [packed = true]; // Placement type for the impression. optional VideoPlacementType placement = 26; // The event that causes playback to end. optional PlaybackCessationMode playbackend = 27; // Extensions. extensions 100 to 9999; // OpenRTB 2.1 compatibility. message CompanionAd { repeated Banner banner = 1; extensions 100 to 9999; } } // This object represents an audio type impression. Many of the fields // are non-essential for minimally viable transactions, but are included // to offer fine control when needed. Audio in OpenRTB generally assumes // compliance with the DAAST standard. As such, the notion of companion // ads is supported by optionally including an array of Banner objects // that define these companion ads. // // The presence of a Audio as a subordinate of the Imp object indicates // that this impression is offered as an audio type impression. // At the publisher's discretion, that same impression may also be offered // as banner, video, and/or native by also including as Imp subordinates // objects of those types. However, any given bid for the impression must // conform to one of the offered types. message Audio { // Content MIME types supported (e.g., "audio/mp4"). // REQUIRED by the OpenRTB specification: at least 1 element. repeated string mimes = 1; // Minimum audio ad duration in seconds. // RECOMMENDED by the OpenRTB specification. optional int32 minduration = 2; // Maximum audio ad duration in seconds. // RECOMMENDED by the OpenRTB specification. optional int32 maxduration = 3; // Array of supported audio protocols. // RECOMMENDED by the OpenRTB specification. repeated Protocol protocols = 4 [packed = true]; // 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 = 5; // 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 = 6 [default = 1]; // Blocked creative attributes. repeated CreativeAttribute battr = 7 [packed = true]; // 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 = 8; // Minimum bit rate in Kbps. optional int32 minbitrate = 9; // Maximum bit rate in Kbps. optional int32 maxbitrate = 10; // Supported delivery methods (e.g., streaming, progressive). // If none specified, assume all are supported. repeated ContentDeliveryMethod delivery = 11 [packed = true]; // Array of Banner objects if companion ads are available. repeated Banner companionad = 12; // List of supported API frameworks for this impression. // If an API is not explicitly listed, it is assumed not to be supported. repeated APIFramework api = 13 [packed = true]; // Supported DAAST companion ad types. Recommended if companion Banner // objects are included via the companionad array. repeated CompanionType companiontype = 20 [packed = true]; // The maximum number of ads that can be played in an ad pod. optional int32 maxseq = 21; // Type of audio feed. optional FeedType feed = 22; // Indicates if the ad is stitched with audio content or delivered // independently, where 0 = no, 1 = yes. optional bool stitched = 23; // Volume normalization mode. optional VolumeNormalizationMode nvol = 24; // Extensions. extensions 100 to 9999; } // OpenRTB 2.3: This object represents a native type impression. // Native ad units are intended to blend seamlessly into the surrounding // content (e.g., a sponsored Twitter or Facebook post). As such, the // response must be well-structured to afford the publisher fine-grained // control over rendering. // // The Native Subcommittee has developed a companion specification to // OpenRTB called the Native Ad Specification. It defines the request // parameters and response markup structure of native ad units. // This object provides the means of transporting request parameters as an // opaque string so that the specific parameters can evolve separately // under the auspices of the Native Ad Specification. Similarly, the // ad markup served will be structured according to that specification. // // The presence of a Native as a subordinate of the Imp object indicates // that this impression is offered as a native type impression. // At the publisher's discretion, that same impression may also be offered // as banner and/or video by also including as Imp subordinates the Banner // and/or Video objects, respectively. However, any given bid for the // impression must conform to one of the offered types. message Native { oneof request_oneof { // Request payload complying with the Native Ad Specification. // Exactly one of {request, request_native} should be used; // this is the OpenRTB-compliant field for JSON serialization. string request = 1; // Request payload complying with the Native Ad Specification. // Exactly one of {request, request_native} should be used; // this is an alternate field preferred for Protobuf serialization. NativeRequest request_native = 50; } // Version of the Native Ad Specification to which request complies. // RECOMMENDED by the OpenRTB specification. optional string ver = 2; // List of supported API frameworks for this impression. // If an API is not explicitly listed, it is assumed not to be supported. repeated APIFramework api = 3 [packed = true]; // Blocked creative attributes. repeated CreativeAttribute battr = 4 [packed = true]; // Extensions. extensions 100 to 9999; } // OpenRTB 2.2: This object is the private marketplace container for // direct deals between buyers and sellers that may pertain to this // impression. The actual deals are represented as a collection of // Deal objects. Refer to Section 7.2 for more details. message Pmp { // Indicator of auction eligibility to seats named in the Direct Deals // object, where 0 = all bids are accepted, 1 = bids are restricted to // the deals specified and the terms thereof. optional bool private_auction = 1 [default = false]; // Array of Deal (Section 3.2.18) objects that convey the specific deals // applicable to this impression. repeated Deal deals = 2; // Extensions. extensions 100 to 9999; // OpenRTB 2.2: This object constitutes a specific deal that was struck // a priori between a buyer and a seller. Its presence with the Pmp // collection indicates that this impression is available under the terms // of that deal. Refer to Section 7.2 for more details. message Deal { // A unique identifier for the direct deal. // REQUIRED by the OpenRTB specification. required string id = 1; // Minimum bid for this impression expressed in CPM. optional double bidfloor = 2 [default = 0]; // Currency specified using ISO-4217 alpha codes. This may be different // from bid currency returned by bidder if this is allowed // by the exchange. optional string bidfloorcur = 3 [default = "USD"]; // Allowlist of buyer seats (e.g., advertisers, agencies) that can bid // on this deal. IDs of seats and knowledge of the buyer's customers to // which they refer must be coordinated between bidders and the exchange // a priori. Omission implies no seat restrictions. repeated string wseat = 4; // Array of advertiser domains (e.g., advertiser.com) allowed to // bid on this deal. Omission implies no advertiser restrictions. repeated string wadomain = 5; // Optional override of the overall auction type of the bid request, // where 1 = First Price, 2 = Second Price Plus, 3 = the value passed // in bidfloor is the agreed upon deal price. Additional auction types // can be defined by the exchange. optional AuctionType at = 6; // Extensions. extensions 100 to 9999; } } } // OpenRTB 2.0: This object should be included if the ad supported content // is a website as opposed to a non-browser application. A bid request must // not contain both a Site and an App object. At a minimum, it is useful to // provide a site ID or page URL, but this is not strictly required. message Site { // Site ID on the exchange. // RECOMMENDED by the OpenRTB specification. optional string id = 1; // Site name (may be masked at publisher's request). optional string name = 2; // Domain of the site, used for advertiser side blocking. // For example, "foo.com". optional string domain = 3; // Array of IAB content categories of the site. // See enum ContentCategory. repeated string cat = 4; // Array of IAB content categories that describe the current section // of the site. // See enum ContentCategory. repeated string sectioncat = 5; // Array of IAB content categories that describe the current page or view // of the site. // See enum ContentCategory. repeated string pagecat = 6; // URL of the page where the impression will be shown. optional string page = 7; // Indicates if the site has a privacy policy, where 0 = no, 1 = yes. optional bool privacypolicy = 8; // Referrer URL that caused navigation to the current page. optional string ref = 9; // Search string that caused navigation to the current page. optional string search = 10; // Details about the Publisher (Section 3.2.8) of the site. optional Publisher publisher = 11; // Details about the Content (Section 3.2.9) within the site. optional Content content = 12; // Comma separated list of keywords about this site. // 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 = 13; // Indicates if the site has been programmed to optimize layout // when viewed on mobile devices, where 0 = no, 1 = yes. optional bool mobile = 15; // Extensions. extensions 100 to 9999; } // 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. // A bid request must not contain both an App and a Site object. // At a minimum, it is useful to provide an App ID or bundle, // but this is not strictly required. message App { // Application ID on the exchange. // RECOMMENDED by the OpenRTB specification. optional string id = 1; // Application name (may be aliased at publisher's request). App names for // SDK-less requests (mostly from connected TVs) can be provided by the // publisher directly in the request. optional string name = 2; // Domain of the application. For example, "mygame.foo.com". optional string domain = 3; // Array of IAB content categories of the app. // See enum ContentCategory. repeated string cat = 4; // Array of IAB content categories that describe the current section // of the app. // See enum ContentCategory. repeated string sectioncat = 5; // Array of IAB content categories that describe the current page or view // of the app. // See enum ContentCategory. repeated string pagecat = 6; // Application version. optional string ver = 7; // A platform-specific application identifier intended to be // unique to the app and independent of the exchange. On Android, // this should be a bundle or package name (e.g., com.foo.mygame). // On iOS, it is a numeric ID. For SDK-less requests (mostly from connected // TVs), it can be provided by the publisher directly in the request. optional string bundle = 8; // Indicates if the app has a privacy policy, where 0 = no, 1 = yes. optional bool privacypolicy = 9; // 0 = app is free, 1 = the app is a paid version. optional bool paid = 10; // Details about the Publisher (Section 3.2.8) of the app. optional Publisher publisher = 11; // Details about the Content (Section 3.2.9) within the app. optional Content content = 12; // Comma separated list of keywords about the app. optional string keywords = 13; // App store URL for an installed app; for QAG 1.5 compliance. optional string storeurl = 16; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object describes the publisher of the media in which // the ad will be displayed. The publisher is typically the seller // in an OpenRTB transaction. message Publisher { // Exchange-specific publisher ID. optional string id = 1; // Publisher name (may be aliased at publisher's request). optional string name = 2; // Array of IAB content categories that describe the publisher. // See enum ContentCategory. repeated string cat = 3; // Highest level domain of the publisher (e.g., "publisher.com"). optional string domain = 4; // Extensions. extensions 100 to 9999; } // 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. message Content { // ID uniquely identifying the content. optional string id = 1; // Content episode number (typically applies to video content). optional int32 episode = 2; // 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; // 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; // Content season; typically for video content (e.g., "Season 3"). optional string season = 5; // Artist credited with the content. optional string artist = 21; // Genre that best describes the content (e.g., rock, pop, etc). optional string genre = 22; // Album to which the content belongs; typically for audio. optional string album = 23; // International Standard Recording Code conforming to ISO-3901. optional string isrc = 24; // URL of the content, for buy-side contextualization or review. optional string url = 6; // Array of IAB content categories that describe the content. // See enum ContentCategory. repeated string cat = 7; // Production quality. optional ProductionQuality prodq = 25; // NOTE: Deprecated in favor of prodq. // Video quality per IAB's classification. optional ProductionQuality videoquality = 8 [deprecated = true]; // 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; // Content rating (e.g., MPAA). optional string contentrating = 10; // User rating of the content (e.g., number of stars, likes, etc.). optional string userrating = 11; // Type of content (game, video, text, etc.). optional ContentContext context = 20; // OpenRTB <= 2.2 compatibility; use context for 2.3+. optional string context_22 = 12; // 0 = not live, 1 = content is live (e.g., stream, live blog). optional bool livestream = 13; // 0 = indirect, 1 = direct. optional bool sourcerelationship = 14; // Details about the content Producer (Section 3.2.10). optional Producer producer = 15; // Length of content in seconds; appropriate for video or audio. optional int32 len = 16; // Media rating per QAG guidelines. optional QAGMediaRating qagmediarating = 17; // Indicator of whether or not the content is embeddable (e.g., an // embeddable video player), where 0 = no, 1 = yes. optional bool embeddable = 18; // Content language using ISO-639-1-alpha-2. optional string language = 19; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object defines the producer of the content in which // the ad will be shown. This is particularly useful when the content is // syndicated and may be distributed through different publishers and thus // when the producer and publisher are not necessarily the same entity. message Producer { // Content producer or originator ID. Useful if content is syndicated, // and may be posted on a site using embed tags. optional string id = 1; // Content producer or originator name (e.g., "Warner Bros"). optional string name = 2; // Array of IAB content categories that describe the content producer. // See enum ContentCategory. repeated string cat = 3; // Highest level domain of the content producer (e.g., "producer.com"). optional string domain = 4; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object provides information pertaining to the device // through which the user is interacting. Device information includes its // hardware, platform, location, and carrier data. The device can refer to a // mobile handset, a desktop computer, set top box, or other digital device. message Device { // Standard "Do Not Track" flag as set in the header by the browser, // where 0 = tracking is unrestricted, 1 = do not track. // RECOMMENDED by the OpenRTB specification. optional bool dnt = 1; // Browser user agent string. Certain data may be redacted or replaced. // RECOMMENDED by the OpenRTB specification. optional string ua = 2; // IPv4 address closest to device. // RECOMMENDED by the OpenRTB specification. optional string ip = 3; // Location of the device assumed to be the user's current location defined // by a Geo object (Section 3.2.12). // RECOMMENDED by the OpenRTB specification. optional Geo geo = 4; // Hardware device ID (e.g., IMEI); hashed via SHA1. optional string didsha1 = 5; // Hardware device ID (e.g., IMEI); hashed via MD5. optional string didmd5 = 6; // Platform device ID (e.g., Android ID); hashed via SHA1. optional string dpidsha1 = 7; // Platform device ID (e.g., Android ID); hashed via MD5. optional string dpidmd5 = 8; // IPv6 address closest to device. optional string ipv6 = 9; // Carrier or ISP (e.g., "VERIZON") using exchange curated string // names which should be published to bidders a priori. optional string carrier = 10; // Browser language using ISO-639-1-alpha-2. optional string language = 11; // Device make (e.g., "Apple"). optional string make = 12; // Device model (e.g., "iPhone"). optional string model = 13; // Device operating system (e.g., "iOS"). optional string os = 14; // Device operating system version (e.g., "3.1.2"). optional string osv = 15; // Hardware version of the device (e.g., "5S" for iPhone 5S). optional string hwv = 24; // Physical width of the screen in pixels. optional int32 w = 25; // Physical height of the screen in pixels. optional int32 h = 26; // Screen size as pixels per linear inch. optional int32 ppi = 27; // The ratio of physical pixels to device independent pixels. optional double pxratio = 28; // Support for JavaScript, where 0 = no, 1 = yes. optional bool js = 16; // Indicates if the geolocation API will be available to JavaScript // code running in the banner, where 0 = no, 1 = yes. optional bool geofetch = 29; // Network connection type. optional ConnectionType connectiontype = 17; // The general type of device. optional DeviceType devicetype = 18; // Version of Flash supported by the browser. optional string flashver = 19; // ID sanctioned for advertiser use in the clear (i.e., not hashed). optional string ifa = 20; // MAC address of the device; hashed via SHA1. optional string macsha1 = 21; // MAC address of the device; hashed via MD5. optional string macmd5 = 22; // "Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android), // where 0 = tracking is unrestricted, 1 = tracking must be limited per // commercial guidelines. // RECOMMENDED by the OpenRTB specification. optional bool lmt = 23; // Mobile carrier as the concatenated MCC-MNC code (e.g., // "310-005" identifies Verizon Wireless CDMA in the USA). // Refer to https://en.wikipedia.org/wiki/Mobile_country_code // for further examples. Note that the dash between the MCC // and MNC parts is required to remove parsing ambiguity. optional string mccmnc = 30; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object encapsulates various methods for specifying a // geographic location. When subordinate to a Device object, it indicates the // location of the device which can also be interpreted as the user's current // location. When subordinate to a User object, it indicates the location of // the user's home base (i.e., not necessarily their current location). // // The lat/lon attributes should only be passed if they conform to the // accuracy depicted in the type attribute. For example, the centroid of a // geographic region such as postal code should not be passed. message Geo { // Latitude from -90.0 to +90.0, where negative is south. optional double lat = 1; // Longitude from -180.0 to +180.0, where negative is west. optional double lon = 2; // Country using ISO-3166-1 Alpha-3. optional string country = 3; // Region code using ISO-3166-2; 2-letter state code if USA. optional string region = 4; // Region of a country using FIPS 10-4 notation. While OpenRTB supports // this attribute, it has been withdrawn by NIST in 2008. optional string regionfips104 = 5; // Google metro code; similar to but not exactly Nielsen DMAs. // See Appendix A for a link to the codes. // (http://code.google.com/apis/adwords/docs/appendix/metrocodes.html). optional string metro = 6; // City using United Nations Code for Trade & Transport Locations. // See Appendix A for a link to the codes. // (http://www.unece.org/cefact/locode/service/location.htm). optional string city = 7; // Zip/postal code. optional string zip = 8; // Source of location data; recommended when passing lat/lon. optional LocationType type = 9; // Estimated location accuracy in meters; recommended when lat/lon // are specified and derived from a device's location services // (i.e., type = 1). Note that this is the accuracy as reported // from the device. Consult OS specific documentation // (e.g., Android, iOS) for exact interpretation. optional int32 accuracy = 11; // Number of seconds since this geolocation fix was established. // Note that devices may cache location data across multiple fetches. // Ideally, this value should be from the time the actual fix was taken. optional int32 lastfix = 12; // Service or provider used to determine geolocation from IP // address if applicable (i.e., type = 2). optional LocationService ipservice = 13; // Local time as the number +/- of minutes from UTC. optional int32 utcoffset = 10; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: This object contains information known or derived about // the human user of the device (i.e., the audience for advertising). // The user id is an exchange artifact and may be subject to rotation or other // privacy policies. However, this user ID must be stable long enough to serve // reasonably as the basis for frequency capping and retargeting. message User { // Exchange-specific ID for the user. At least one of id or buyeruid // is recommended. optional string id = 1; // Buyer-specific ID for the user as mapped by the exchange for the buyer. // At least one of buyeruid or id is recommended. optional string buyeruid = 2; // Year of birth as a 4-digit integer. optional int32 yob = 3; // Gender as "M" male, "F" female, "O" Other. (Null indicates unknown) optional string gender = 4; // Comma separated list of keywords, interests, or intent. // 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 = 5; // Optional feature to pass bidder data set in the exchange's cookie. // The string must be in base85 cookie safe characters and be in any format. // Proper JSON encoding must be used to include "escaped" quotation marks. optional string customdata = 6; // Location of the user's home base defined by a Geo object // (Section 3.2.12). This is not necessarily their current location. optional Geo geo = 7; // Additional user data. Each Data object (Section 3.2.14) represents a // different data source. repeated Data data = 8; // Extensions. extensions 100 to 9999; } // OpenRTB 2.0: The data and segment objects together allow additional data // about the user to be specified. This data may be from multiple sources // whether from the exchange itself or third party providers as specified by // the id field. A bid request can mix data objects from multiple providers or // can have multiple data objects. // The specific data providers in use should be published by the exchange // a priori to its bidders. // This is used to send detected verticals to the buyer. // For exchange bidding, this is also used to send key // value pairs from the publisher to the buyer. // https://support.google.com/admanager/answer/177381 message Data { // Exchange-specific ID for the data provider. optional string id = 1; // Exchange-specific name for the data provider. optional string name = 2; // Array of Segment (Section 3.2.15) objects that contain the actual // data values. repeated Segment segment = 3; // Extensions. extensions 100 to 9999; // OpenRTB 2.0: Segment objects are essentially key-value pairs that // convey specific units of data about the user. The parent Data object // is a collection of such values from a given data provider. // The specific segment names and value options must be published by the // exchange a priori to its bidders. message Segment { // ID of the data segment specific to the data provider. optional string id = 1; // Name of the data segment specific to the data provider. optional string name = 2; // String representation of the data segment value. optional string value = 3; // Extensions. extensions 100 to 9999; } } // OpenRTB 2.2: This object contains any legal, governmental, or industry // regulations that apply to the request. The coppa flag signals whether // or not the request falls under the United States Federal Trade Commission's // regulations for the United States Children's Online Privacy Protection Act // ("COPPA"). Refer to Section 7.1 for more information. message Regs { // Flag indicating if this request is subject to the COPPA regulations // established by the USA FTC, where 0 = no, 1 = yes. optional bool coppa = 1; // Extensions. extensions 100 to 9999; } } // OpenRTB 2.0: This object is the top-level bid response object (i.e., the // unnamed outer JSON object). The id attribute is a reflection of the bid // request ID for logging purposes. Similarly, bidid is an optional response // tracking ID for bidders. If specified, it can be included in the subsequent // win notice call if the bidder wins. At least one seatbid object is required, // which contains at least one bid for an impression. Other attributes are // optional. To express a "no-bid", the options are to return an empty response // with HTTP 204. Alternately if the bidder wishes to convey to the exchange a // reason for not bidding, just a BidResponse object is returned with a // reason code in the nbr attribute. message BidResponse { // ID of the bid request to which this is a response. // REQUIRED by the OpenRTB specification. required string id = 1; // Array of seatbid objects; 1+ required if a bid is to be made. repeated SeatBid seatbid = 2; // Bidder generated response ID to assist with logging/tracking. optional string bidid = 3; // Bid currency using ISO-4217 alpha codes. optional string cur = 4; // Optional feature to allow a bidder to set data in the exchange's cookie. // The string must be in base85 cookie safe characters and be in any format. // Proper JSON encoding must be used to include "escaped" quotation marks. optional string customdata = 5; // Reason for not bidding. optional NoBidReason nbr = 6; // Extensions. extensions 100 to 9999; // 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. If multiple impressions are presented in the request, the // group attribute can be used to specify if a seat is willing to accept any // impressions that it can win (default) or if it is only interested in // winning any if it can win them all as a group. message SeatBid { // Array of 1+ Bid objects (Section 4.2.3) each related to an impression. // Multiple bids can relate to the same impression. repeated Bid bid = 1; // ID of the buyer seat (e.g., advertiser, agency) on whose behalf // this bid is made. // // This ID will be used to breakdown spend and invalid traffic metrics in // IVT transparency reporting, given that it is no longer than 64 bytes. optional string seat = 2; // 0 = impressions can be won individually; 1 = impressions must be won or // lost as a group. optional bool group = 3 [default = false]; // Extensions. extensions 100 to 9999; // 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. message Bid { // Bidder generated bid ID to assist with logging/tracking. // REQUIRED by the OpenRTB specification. required string id = 1; // ID of the Imp object in the related bid request. // REQUIRED by the OpenRTB specification. required string impid = 2; // Bid price expressed as CPM although the actual transaction is for a // unit impression only. Note that while the type indicates float, integer // math is highly recommended when handling currencies // (e.g., BigDecimal in Java). // REQUIRED by the OpenRTB specification. required double price = 3; // ID of a preloaded ad to be served if the bid wins. optional string adid = 4; // Win notice URL called by the exchange if the bid wins; optional means // of serving ad markup. optional string nurl = 5; oneof adm_oneof { // Optional means of conveying ad markup in case the bid wins; // supersedes the win notice if markup is included in both. // For native ad bids, exactly one of {adm, adm_native} should be used; // this is the OpenRTB-compliant field for JSON serialization. string adm = 6; // Native ad response. // For native ad bids, exactly one of {adm, adm_native} should be used; // this is the field used for Protobuf serialization. NativeResponse adm_native = 50; } // Advertiser domain for block list checking (e.g., "ford.com"). This can // be an array of for the case of rotating creatives. Exchanges can // mandate that only one domain is allowed. repeated string adomain = 7; // A platform-specific application identifier intended to be // unique to the app and independent of the exchange. On Android, // this should be a bundle or package name (e.g., com.foo.mygame). // On iOS, it is a numeric ID. optional string bundle = 14; // URL without cache-busting to an image that is representative of the // content of the campaign for ad quality/safety checking. optional string iurl = 8; // Campaign ID to assist with ad quality checking; the collection of // creatives for which iurl should be representative. optional string cid = 9; // Creative ID to assist with ad quality checking. optional string crid = 10; // IAB content categories of the creative. repeated string cat = 15; // Set of attributes describing the creative. repeated CreativeAttribute attr = 11 [packed = true]; // API required by the markup if applicable. optional APIFramework api = 18; // Video response protocol of the markup if applicable. optional Protocol protocol = 19; // Creative media rating per QAG guidelines. optional QAGMediaRating qagmediarating = 20; // Reference to the deal.id from the bid request if this bid pertains to a // private marketplace direct deal. optional string dealid = 13; // Width of the creative in device independent pixels (DIPS). optional int32 w = 16; // Height of the creative in device independent pixels (DIPS). optional int32 h = 17; // Advisory as to the number of seconds the bidder is willing to // wait between the auction and the actual impression. optional int32 exp = 21; // Billing notice URL called by the exchange when a winning bid // becomes billable based on exchange-specific business policy // (e.g., typically delivered, viewed, etc.). Substitution macros // (Section 4.4) may be included. optional string burl = 22; // Loss notice URL called by the exchange when a bid is known to // have been lost. Substitution macros (Section 4.4) may be // included. Exchange-specific policy may preclude support for // loss notices or the disclosure of winning clearing prices // resulting in ${AUCTION_PRICE} macros being removed (i.e., // replaced with a zero-length string). optional string lurl = 23; // Tactic ID to enable buyers to label bids for reporting to the // exchange the tactic through which their bid was submitted. // The specific usage and meaning of the tactic ID should be // communicated between buyer and exchanges a priori. optional string tactic = 24; // Language of the creative using ISO-639-1-alpha-2. The nonstandard // code "xx" may also be used if the creative has no // linguistic content (e.g., a banner with just a company logo). optional string language = 25; // Relative width of the creative when expressing size as a ratio. // Required for Flex Ads. optional int32 wratio = 26; // Relative height of the creative when expressing size as a ratio. // Required for Flex Ads. optional int32 hratio = 27; // Extensions. extensions 100 to 9999; } } } // OpenRTB Native 1.0: The Native Object defines the native advertising // opportunity available for bid via this bid request. It must be included // directly in the impression object if the impression offered for auction // is a native ad format. // Note: Prior to VERSION 1.1, the specification could be interpreted as // requiring the native request to have a root node with a single field "native" // that would contain the NativeRequest as its value. // In 1.2 The NativeRequest Object specified here is now the root object. message NativeRequest { // Version of the Native Markup version in use. optional string ver = 1; // The Layout ID of the native ad unit. // RECOMMENDED by OpenRTB Native 1.0; optional in 1.1, DEPRECATED in 1.2. optional LayoutId layout = 2; // The Ad unit ID of the native ad unit. // This corresponds to one of IAB Core-6 native ad units. // RECOMMENDED by OpenRTB Native 1.0; optional in 1.1, DEPRECATED in 1.2. optional AdUnitId adunit = 3; // The context in which the ad appears. // RECOMMENDED in 1.2. optional ContextType context = 7; // A more detailed context in which the ad appears. optional ContextSubtype contextsubtype = 8; // The design/format/layout of the ad unit being offered. // RECOMMENDED by the OpenRTB Native specification. optional PlacementType plcmttype = 9; // The number of identical placements in this Layout. optional int32 plcmtcnt = 4 [default = 1]; // 0 for the first ad, 1 for the second ad, and so on. Note this would // generally NOT be used in combination with plcmtcnt - either you are // auctioning multiple identical placements (in which case // plcmtcnt>1, seq=0) or you are holding separate auctions for distinct // items in the feed (in which case plcmtcnt=1, seq>=1). optional int32 seq = 5 [default = 0]; // Any bid must comply with the array of elements expressed by the Exchange. // REQUIRED by the OpenRTB Native specification: at least 1 element. repeated Asset assets = 6; // Whether the supply source / impression supports returning an assetsurl // instead of an asset object. 0 or the absence of the field indicates no such // support. // Implemented in 1.2 optional bool aurlsupport = 11; // Whether the supply source / impression supports returning a DCO URL // instead of an asset object. 0 or the absence of the field indicates no such // support. // Implemented in 1.2 // Beta feature. optional bool durlsupport = 12; // Specifies what type of event tracking is supported. // Implemented in 1.2 repeated EventTrackers eventtrackers = 13; // Set to 1 when the native ad supports buyer-specific privacy notice. // Set to 0 (or field absent) when the native ad doesn't support custom // privacy links or if support is unknown. // RECOMMENDED and implemented in 1.2 optional bool privacy = 14; // Extensions. extensions 100 to 9999; // OpenRTB Native 1.0: The main container object for each asset requested or // supported by Exchange on behalf of the rendering client. // Any object that is required is to be flagged as such. Only one of the // {title,img,video,data} objects should be present in each object. // All others should be null/absent. The id is to be unique within the // Asset array so that the response can be aligned. message Asset { // Unique asset ID, assigned by exchange. Typically a counter for the array. // REQUIRED by the OpenRTB Native specification. required int32 id = 1; // Set to true if asset is required // (exchange will not accept a bid without it). optional bool required = 2 [default = false]; // RECOMMENDED by the OpenRTB Native specification. oneof asset_oneof { // Title object for title assets. Title title = 3; // Image object for image assets. Image img = 4; // Video object for video assets. // Note that in-stream video ads are not part of Native. // Native ads may contain a video as the ad creative itself. BidRequest.Imp.Video video = 5; // Data object for brand name, description, ratings, prices etc. Data data = 6; } // Extensions. extensions 100 to 9999; // OpenRTB Native 1.0: The Title object is to be used for title element // of the Native ad. message Title { // Maximum length of the text in the title element. // RECOMMENDED that the value be either of: 25, 90, 140. // REQUIRED by the OpenRTB Native specification. required int32 len = 1; // Extensions. extensions 100 to 9999; } // OpenRTB Native 1.0: The Image object to be used for all image elements // of the Native ad such as Icons, Main Image, etc. // RECOMMENDED sizes and aspect ratios are included in ImageAssetType. message Image { // Type ID of the image element supported by the publisher. // The publisher can display this information in an appropriate format. optional ImageAssetType type = 1; // Width of the image in pixels. optional int32 w = 2; // Height of the image in pixels. optional int32 h = 3; // The minimum requested width of the image in pixels. This option should // be used for any rescaling of images by the client. Either w or wmin // should be transmitted. If only w is included, it should be considered // an exact requirement. // RECOMMENDED by the OpenRTB Native specification. optional int32 wmin = 4; // The minimum requested height of the image in pixels. This option should // be used for any rescaling of images by the client. Either h or hmin // should be transmitted. If only h is included, it should be considered // an exact requirement. // RECOMMENDED by the OpenRTB Native specification. optional int32 hmin = 5; // Allowlist of content MIME types supported. Popular MIME types include, // but are not limited to "image/jpg" and "image/gif". Each implementing // Exchange should have their own list of supported types in the // integration docs. See Wikipedia's MIME page for more information and // links to all IETF RFCs. If blank, assume all types are allowed. repeated string mimes = 6; // Extensions. extensions 100 to 9999; } // 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. It is also generic for future of Native // elements not contemplated at the time of the writing of this document. message Data { // Type ID of the element supported by the publisher. The publisher can // display this information in an appropriate format. // REQUIRED by the OpenRTB Native specification. required DataAssetType type = 1; // Maximum length of the text in the element's response. Longer strings // may be truncated and ellipsized by Ad Exchange or the publisher during // rendering. optional int32 len = 2; // Extensions. extensions 100 to 9999; } } // 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. message EventTrackers { // Type of event available for tracking. // REQUIRED by the OpenRTB Native specification. required EventType event = 1; // Array of types of tracking available for the given event. // REQUIRED by the OpenRTB Native specification. repeated EventTrackingMethod methods = 2; // Extensions. extensions 100 to 9999; } } // OpenRTB Native 1.0: The native response object is the top level JSON object // which identifies an native response. // Note: Prior to VERSION 1.1, the native response's root node was an object // with a single field "native" that would contain the object above as its // value. // In 1.2 The NativeResponse Object specified here is now the root object. message NativeResponse { // Version of the Native Markup version in use. // RECOMMENDED in 1.2 optional string ver = 1; // List of native ad's assets. // RECOMMENDED in 1.0, 1.1, or in 1.2 as a fallback if assetsurl is provided. // REQUIRED in 1.2, if not assetsurl is provided. repeated Asset assets = 2; // URL of alternate source for the assets object. The expected response is a // JSON object mirroring the asset object in the bid response, subject to // certain requirements as specified in the individual objects. // Where present, overrides the assets object in the response. // Implemented in 1.2 optional string assetsurl = 6; // URL where a dynamic creative specification may be found for populating this // ad, per the Dynamic Content Ads Specification. // Note this is a beta option as the interpretation of the Dynamic Content Ads // Specification and how to assign those elementes into a native ad is outside // the scope of this spec and must be agreed offline between parties or as may // be specified in a future revision of the Dynamic Content Ads spec. // Where present, overrides the assets object in the response. // Implemented in 1.2 optional string dcourl = 7; // Destination Link. This is default link object for the ad. // Individual assets can also have a link object which applies if the asset is // activated (clicked). If the asset doesn't have a link object, the parent // link object applies. // See ResponseLink definition. // REQUIRED by the OpenRTB Native specification. required Link link = 3; // Array of impression tracking URLs, expected to return a 1x1 image or // 204 response - typically only passed when using 3rd party trackers. // To be deprecated in 1.2 - Replaced with EventTracker. repeated string imptrackers = 4; // Optional javascript impression tracker. Contains