> For the complete documentation index, see [llms.txt](https://adagio-io.gitbook.io/adagio-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://adagio-io.gitbook.io/adagio-documentation/openrtb-s2s-endpoint/all-supported-openrtb-parameters/bid-request-objects-and-parameters.md).

# Bid Request objects and parameters

The `BidRequest` object is the root of an OpenRTB request. It contains all the attributes required to describe the ad opportunity, the environment, the user, and any additional context needed for bidding.

## 1. `bidrequest` object

<table data-full-width="true"><thead><tr><th width="92.98046875">Attribute</th><th width="100">Type</th><th width="142.7734375">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td><strong>ID of the bid request, assigned by the exchange</strong>, and unique for the exchange’s subsequent tracking of the responses. The exchange may use different values for different recipients.</td></tr><tr><td><code>imp</code></td><td><a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-3.4-imp-object">object array</a></td><td><mark style="color:red;">Required</mark></td><td>Array of <a href="#id-4.-imp-object"><code>Imp</code> objects </a>representing the impressions offered. <mark style="color:$danger;">At least 1 <code>Imp</code> object is required</mark>.</td></tr><tr><td><code>site</code></td><td><a href="#id-9.-site-object">object</a></td><td><mark style="color:red;">Required</mark></td><td>Details via <a href="#id-9.-site-object">Site object</a> about the publisher’s website. <mark style="color:$warning;">Only applicable and required for websites.</mark></td></tr><tr><td><code>app</code></td><td><a href="#id-9.-app-object">object</a></td><td><mark style="color:red;">Required</mark></td><td>Details via <a href="#id-9.-app-object"><code>App</code> object</a> about the publisher’s app (i.e., non-browser applications). <mark style="color:$warning;">Only applicable and required for apps.</mark></td></tr><tr><td><code>device</code></td><td><a href="#id-12.-device-object">object</a></td><td><mark style="color:red;">Required</mark></td><td>Details via a <a href="#id-12.-device-object"><code>Device</code> object </a>about the user’s device to which the impression will be delivered.</td></tr><tr><td><code>user</code></td><td><a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-3.14-user-object">object</a></td><td><mark style="color:red;">Required</mark></td><td>Details via a <a href="#id-14.-user-object"><code>User</code> object</a> about the human user of the device; the advertising audience.</td></tr><tr><td><code>test</code></td><td>integer;<br>default 0</td><td>Optional</td><td><strong>Indicator of test mode</strong> in which auctions are not billable, where 0 = live mode, 1 = test mode.</td></tr><tr><td><code>at</code></td><td>integer;<br>default 2</td><td>Optional</td><td><strong>Auction type</strong>, where 1 = First Price, 2 = Second Price. <mark style="color:$warning;">We only support 2 = Second Price (other values are overridden before broadcasting to demand partners).</mark></td></tr><tr><td><code>tmax</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Maximum time in milliseconds the exchange allows</strong> for bids to be received including Internet latency to avoid timeout. This value supersedes any <em>a priori</em> guidance from the exchange. <mark style="color:$warning;"><code>tmax</code> > 470 ms is recommended for optimal monetization.</mark></td></tr><tr><td><code>cur</code></td><td>string array</td><td>Optional</td><td><strong>Array of allowed currencies</strong> for bids on this bid request <mark style="color:$warning;">(refer to</mark> <a data-mention href="/adagio-documentation/operations-and-support/standards-and-compliance/supported-currencies.md">Supported Currencies</a><mark style="color:$warning;">).</mark> If no currency is specified, default is USD.</td></tr><tr><td><code>acat</code></td><td>string array</td><td>Optional</td><td><strong>Allowed advertiser categories</strong> using the specified category taxonomy.<br>The taxonomy to be used is defined by the <code>cattax</code> field. <strong>If no <code>cattax</code> field is supplied IAB Content Taxonomy 1.0 is assumed</strong>. <mark style="color:$warning;">Only one of <code>acat</code> or <code>bcat</code> should be present.</mark></td></tr><tr><td><code>bcat</code></td><td>string array</td><td>Optional</td><td><strong>Blocked advertiser categories</strong> using the specified category taxonomy.<br>The taxonomy to be used is defined by the <code>cattax</code> field. <strong>If no <code>cattax</code> field is supplied IAB Content Taxonomy 1.0 is assumed</strong>. <mark style="color:$warning;">Only one of <code>acat</code> or <code>bcat</code> should be present.</mark></td></tr><tr><td><code>cattax</code></td><td>integer;<br>default 1</td><td>Optional</td><td><strong>The taxonomy in use for bcat</strong>. Refer to the AdCOM 1.0 list <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies">List: Category Taxonomies</a> for values. <mark style="color:$warning;">Values other than 1 are strongly discouraged, please contact</mark> <a href="mailto:csm@adagio.io"><mark style="color:$warning;">your CSM</mark></a> <mark style="color:$warning;">if you use them.</mark></td></tr><tr><td><code>badv</code></td><td>string array</td><td>Optional</td><td><strong>Block list of advertisers by their domains</strong> (e.g., “ford.com”). <mark style="color:$warning;">A maximum of 50 domains can be blocked.</mark></td></tr><tr><td><code>bapp</code></td><td>string array</td><td>Optional <em>(App only)</em></td><td><strong>Block list of applications by their app store IDs</strong>. For mobile apps in Google Play Store, these should be bundle or package names (e.g. <code>com.foo.mygame</code>). For apps in Apple App Store, these should be a numeric ID.</td></tr><tr><td><code>source</code></td><td><a href="#id-2.-source-object">object</a></td><td><mark style="color:purple;">Recommended</mark></td><td>A <a href="#id-2.-source-object"><code>source</code> object</a> that <strong>provides data about the inventory source</strong> and which entity makes the final decision.</td></tr><tr><td><code>regs</code></td><td><a href="#id-3.-regs-object">object</a></td><td><mark style="color:red;">Required</mark>, if applicable</td><td>A <a href="#id-3.-regs-object"><code>regs</code> object</a> that <strong>specifies any industry, legal, or governmental regulations</strong> in force for this request.</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.placementtype</code></td><td>string</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, when set to "rewarded". <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr></tbody></table>

## 2. `source` object

<table data-full-width="true"><thead><tr><th width="147.7421875">Field</th><th width="89.875">Type</th><th width="147.00433349609375">Req</th><th>Description</th></tr></thead><tbody><tr><td><code>fd</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Denotes <strong>who makes the final sell decision</strong>: <code>0 = exchange</code>, <code>1 = upstream platform (e.g., header bidding)</code>. <mark style="color:$warning;">Usually this should be set to 1.</mark></td></tr><tr><td><code>tid</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Transaction ID</strong> shared across all participants in the bid request.</td></tr><tr><td><code>schain</code></td><td>object</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>IAB SupplyChain object</strong> outlining the full supply path and completeness. <mark style="color:$warning;">Refer to</mark> <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#3225---object-supplychain-"><mark style="color:$warning;">official documentation</mark></a> <mark style="color:$warning;">for more information</mark></td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.omidpn</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Identifier of the OM SDK integration. This is the same as the “name” parameter of the OMID Partner object.</td></tr><tr><td><code>ext.omidpv</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Version of the OM SDK integration. This is the same as the “versionString” parameter of the OMID Partner object.</td></tr></tbody></table>

## 3. `regs` object

<table data-full-width="true"><thead><tr><th width="176.9991455078125">Field</th><th width="84.4366455078125">Type</th><th width="139.59722900390625">Req</th><th width="754.6575927734375">Description</th></tr></thead><tbody><tr><td><code>coppa</code></td><td>integer</td><td><mark style="color:red;">Required</mark>, if applicable</td><td><code>1</code> <strong>if COPPA applies</strong> (for children under 13), <code>0</code> otherwise. Refer <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/implementation.md#75---regs-resources-">to section 7.5 in official documentation</a>.</td></tr><tr><td><code>gdpr</code> or <code>ext.gdpr</code></td><td>integer</td><td><mark style="color:red;">Required</mark>, if applicable</td><td><code>1</code> <strong>if GDPR applies</strong> (EU/UK user), <code>0</code> if not. <mark style="color:$warning;">If 1, do fill <code>user.consent</code> (refer to</mark> <a data-mention href="#id-15.-user-object">#id-15.-user-object</a><mark style="color:$warning;">).</mark></td></tr><tr><td><code>us_privacy</code> or <code>ext.us_privacy</code></td><td>string</td><td><mark style="color:red;">Required</mark>, if applicable</td><td><strong>CCPA/US-privacy consent string</strong>. See<a href="https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/master/CCPA/US%20Privacy%20String.md"> IAB US Privacy String specifications</a>.</td></tr><tr><td><code>gpp</code></td><td>string</td><td><mark style="color:red;">Required</mark>, if applicable</td><td>Contains the <strong>Global Privacy Platform’s consent string</strong>. See the <a href="https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform">Global Privacy Platform specification</a> for more details.</td></tr><tr><td><code>gpp_sid</code></td><td>integer array</td><td>Optional</td><td><strong>Array of the section(s) of the string which should be applied for this transaction</strong>. Generally will contain one and only one value, but there are edge cases where more than one may apply. See the <a href="https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Sections/Section%20Information.md">GPP Section Information</a> for more details.</td></tr></tbody></table>

## 4. `imp` object

<table data-full-width="true"><thead><tr><th width="182">Field</th><th width="121.98828125">Type</th><th width="154.3046875">Required</th><th width="788.2890625">Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td>A <strong>unique identifier for this impression</strong> within the content of the bid request (typically, starts with 1 and increments).</td></tr><tr><td><code>tagid</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td><strong>Identifier for specific ad placement</strong> or ad tag that was used to initiate the auction. <mark style="color:$danger;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/review-your-technical-integration/tagid-limits-and-guidelines.md">TagID Limits and Guidelines</a> <mark style="color:$danger;">for constraints.</mark></td></tr><tr><td><code>metric</code></td><td>object array</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>An array of <code>Metric</code> object</strong>. These metrics can <strong>offer insight into the impression</strong> to assist with decisioning such as average recent viewability, click-through rate, etc. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectmetric">official documentation</a> for more information</td></tr><tr><td><code>banner</code></td><td>object</td><td><mark style="color:red;">Required</mark><br>if banner ad</td><td>A <a href="#id-5.-banner-object"><code>banner</code> object </a>is required if this impression is offered as a banner ad opportunity.</td></tr><tr><td><code>video</code></td><td>object</td><td><mark style="color:red;">Required</mark><br>if video ad</td><td>A <a href="#id-6.-video-object"><code>video</code> object</a> is required if this impression is offered as a video ad opportunity.</td></tr><tr><td><code>native</code></td><td>object</td><td><mark style="color:red;">Required</mark><br>if native ad</td><td>A <a href="#id-7.-native-object"><code>native</code> object</a> is required if this impression is offered as a native ad opportunity.</td></tr><tr><td><code>displaymanager</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Name of ad mediation partner</strong>, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner.<br>Recommended for video and/or apps.</td></tr><tr><td><code>displaymanagerver</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Version of ad mediation partner, SDK technology, or player responsible for rendering ad</strong> (typically video or mobile). Used by some ad servers to customize ad code by partner.<br>Recommended for video and/or apps.</td></tr><tr><td><code>instl</code></td><td>integer;<br>default 0</td><td><mark style="color:purple;">Recommended</mark></td><td>1 = the <strong>ad is interstitial or full screen</strong>, 0 = not interstitial. For video mediatype, if <code>instl</code> = 1, <code>plcmt</code> should be equal to 3</td></tr><tr><td><code>bidfloor</code></td><td>float;<br>default 0</td><td>Optional</td><td><strong>Minimum bid</strong> for this impression expressed in CPM.</td></tr><tr><td><code>bidfloorcur</code></td><td>string;<br>default "USD"</td><td>Optional</td><td><strong>Currency specified</strong> using ISO-4217 alpha codes. This may be different from bid currency returned by bidder if this is allowed by the exchange. This currency sets the default for all floors specified in the <code>Imp</code> object. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/operations-and-support/standards-and-compliance/supported-currencies.md">Supported Currencies</a>.</td></tr><tr><td><code>clickbrowser</code></td><td>integer</td><td>Optional</td><td>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.</td></tr><tr><td><code>secure</code></td><td>integer</td><td>Optional</td><td><strong>Flag to indicate if the impression requires secure HTTPS</strong> 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.</td></tr><tr><td><code>rwdd</code></td><td>integer;<br>default 0</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, where 0 = no, 1 = yes. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ssai</code></td><td>integer;<br>default 0</td><td>Optional</td><td><strong>Indicates if server-side ad insertion</strong> (e.g., stitching an ad into an audio or video stream) is in use and the impact of this on asset and tracker retrieval, where 0 = status unknown, 1 = all client-side (i.e., not server-side), 2 = assets stitched server-side but tracking pixels fired client-side, 3 = all server-side.</td></tr><tr><td><code>exp</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Advisory as to the number of seconds that may <strong>elapse between the auction and the actual impression.</strong></td></tr><tr><td><code>dt</code></td><td>float</td><td>Optional</td><td><strong>Timestamp when the item is estimated to be fulfilled</strong> (e.g. when a DOOH impression will be displayed) in Unix format (i.e., milliseconds since the epoch).</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.gpid</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Global Placement ID</strong> (cf. <a href="https://partner.thetradedesk.com/v3/portal/ssp/doc/GlobalPlacementID">The TradeDesk's doc</a>)<strong>.</strong></td></tr><tr><td><code>ext.rewarded</code></td><td>integer</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, where 0 = no, 1 = yes. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ext.is_rewarded_inventory</code></td><td>integer</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, where 0 = no, 1 = yes. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a> <mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ext.skadn</code></td><td>object</td><td><mark style="color:purple;">Recommended</mark><br><em>(for iOS App only)</em></td><td>If a <strong>DSP has at least one SKAdNetworkItem in the publisher app’s</strong> <code>Info.plist</code> we would include a new object in the bid request that provides the necessary information to create a signature. Object would only be present if the OS version (iOS 14.0+) supports SKAdNetwork. <a href="https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/skadnetwork.md">Refer to IAB Community Extensions docs for more information</a> and <a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-4.5-skadnetwork-for-apple-apps">our section below</a>.</td></tr></tbody></table>

## 5. `banner` object

<table data-full-width="true"><thead><tr><th width="156.15625">Field</th><th width="152">Type</th><th width="146.12109375">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>format</code></td><td><a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-3.8-format-object">object array</a></td><td><mark style="color:purple;">Recommended</mark></td><td>Array of <a href="#id-8.-format-object"><code>format</code> objects</a> representing the banner sizes permitted. <mark style="color:$warning;">If none are specified, then use of the <code>h</code> and <code>w</code> attributes is highly recommended.</mark></td></tr><tr><td><code>w</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark> if no format</td><td><strong>Exact width</strong> in device-independent pixels (DIPS); <mark style="color:$warning;">recommended if no <code>Format</code> objects are specified.</mark></td></tr><tr><td><code>h</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark> if no format</td><td><strong>Exact height</strong> in device-independent pixels (DIPS); <mark style="color:$warning;">recommended if no <code>Format</code> objects are specified.</mark></td></tr><tr><td><code>btype</code></td><td>integer array</td><td>Optional</td><td><strong>Blocked banner ad types.</strong><br>Values:<br>1 = XHTML Text Ad,<br>2 = XHTML Banner Ad,<br>3 = JavaScript Ad,<br>4 = iframe.</td></tr><tr><td><code>battr</code></td><td>integer array</td><td>Optional</td><td><strong>Blocked creative attributes</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-attributes-">List: Creative Attributes</a> in AdCOM 1.0. <mark style="color:$warning;">A maximum of 50 attributes can be specified.</mark></td></tr><tr><td><code>pos</code></td><td>integer</td><td>Optional</td><td><strong>Ad position on screen</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--placement-positions-">List: Placement Positions</a> in AdCOM 1.0.</td></tr><tr><td><code>mimes</code></td><td>string array</td><td>Optional</td><td><strong>Content MIME types supported</strong>. Popular MIME types may include <code>“image/jpeg”</code> and <code>“image/gif”</code>.</td></tr><tr><td><code>topframe</code></td><td>integer</td><td>Optional</td><td><strong>Indicates if the banner is in the top frame</strong> as opposed to an iframe, where 0 = no, 1 = yes.</td></tr><tr><td><code>expdir</code></td><td>integer array</td><td>Optional</td><td><strong>Directions in which the banner may expand</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--expandable-directions-">List: Expandable Directions</a> in AdCOM 1.0.</td></tr><tr><td><code>api</code></td><td>integer array</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>List of supported API frameworks for this impression</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-">List: API Frameworks</a> in AdCOM 1.0. <strong>If an API is not explicitly listed, it is assumed not to be supported.</strong> <mark style="color:$warning;">Defaults to <code>[1.0]</code> unless both <code>imp.ext.omidpn</code> and <code>imp.ext.omidpv</code> are missing, in which case <code>api</code> is removed (cf.</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/open-measurement-omid.md">Open Measurement (OMID)</a><mark style="color:$warning;">)</mark></td></tr><tr><td><code>id</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark><br>if used with video as companion</td><td><strong>Unique identifier for this banner object</strong>. <mark style="color:purple;">Recommended when <code>Banner</code> objects are used with a <code>Video</code> object</mark> (Section <a data-mention href="#id-6.-video-object">#id-6.-video-object</a>) to represent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression.</td></tr><tr><td><code>vcm</code></td><td>integer</td><td>Optional</td><td>Relevant only for <code>Banner</code> objects used with a <code>Video</code> object (Section <a data-mention href="#id-6.-video-object">#id-6.-video-object</a>) in an array of companion ads. Indicates the companion banner rendering mode relative to the associated video, where 0 = concurrent, 1 = end-card.</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## 6. `video` object

<table data-full-width="true"><thead><tr><th width="179.26953125">Attribute</th><th width="181.65625">Type</th><th width="156.3046875">Required</th><th width="744.87109375">Description</th></tr></thead><tbody><tr><td><code>mimes</code></td><td>string array</td><td><mark style="color:red;">Required</mark></td><td><strong>Content MIME types supported</strong> (e.g., <code>"video/mp4"</code>). <mark style="color:$warning;">When omitted, Adagio will fallback to <code>["video/mp4","video/webm"]</code>.</mark></td></tr><tr><td><code>minduration</code></td><td>integer;<br>default 1</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Minimum video ad duration in seconds</strong>. <mark style="color:$warning;">This field is mutually exclusive with <code>rqddurs</code></mark>; only one of <code>minduration</code> and <code>rqddurs</code> may be in a bid request.</td></tr><tr><td><code>maxduration</code></td><td>integer; default 100</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Maximum video ad duration in seconds</strong>. This field is mutually exclusive with <code>rqddurs</code>; only one of <code>maxduration</code> and <code>rqddurs</code> may be in a bid request.</td></tr><tr><td><code>startdelay</code></td><td>integer; default 0</td><td><mark style="color:purple;">Recommended</mark></td><td>Indicates the <strong>start delay in seconds for pre-roll, mid-roll, or post-roll ad placements</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--start-delay-modes-">List: Start Delay Modes</a> in AdCOM 1.0.</td></tr><tr><td><code>protocols</code></td><td>integer array</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Array of supported video protocols</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-subtypes---audiovideo-">List: Creative Substypes - Audio/Video</a> in AdCOM 1.0.</td></tr><tr><td><code>w</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Width of the video player</strong> in device-independent pixels (DIPS).</td></tr><tr><td><code>h</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Height of the video player</strong> in device-independent pixels (DIPS).</td></tr><tr><td><code>placement</code></td><td>integer; DEPRECATED</td><td><mark style="color:orange;">Deprecated</mark></td><td><strong>Video placement type for the impression.</strong> Refer to Section <a href="https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf">5.9 of oRTB 2.5 specs</a><strong>.</strong> <mark style="color:$warning;">Deprecated as of OpenRTB 2.6-202303. Use <code>plcmt</code> instead.</mark></td></tr><tr><td><code>plcmt</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Video placement type for the impression. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/develop/AdCOM%20v1.0%20FINAL.md#list_plcmtsubtypesvideo">List: Plcmt Subtypes - Video</a> in AdCOM 1.0.</td></tr><tr><td><code>linearity</code></td><td>integer</td><td>Optional (<mark style="color:purple;">Recommended</mark> if <code>plcmt</code> = 1)</td><td><strong>Indicates if the impression must be linear, nonlinear, etc.</strong> If <strong>none specified, assume all are allowed.</strong> Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--linearity-modes-">List: Linearity Modes</a> in AdCOM 1.0. <mark style="color:$warning;">Note that this field describes the expected VAST response</mark> and not whether a placement is in-stream, out-stream, etc. For that, see <code>plcmt</code>.</td></tr><tr><td><code>skip</code></td><td>integer</td><td>Optional</td><td><strong>Indicates if the player will allow the video to be skipped</strong>, where 0 = no, 1 = yes.<br>If a bidder sends markup/creative that is itself skippable, the <code>Bid</code> object should include the <code>attr</code> array with an element of 16 indicating skippable video. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-attributes-">List: Creative Attributes</a> in AdCOM 1.0.</td></tr><tr><td><code>skipmin</code></td><td>integer;<br>default 0</td><td>Optional</td><td><strong>Videos of total duration greater than this number of seconds can be skippable</strong>; only applicable if the ad is skippable.</td></tr><tr><td><code>skipafter</code></td><td>integer;<br>default 0</td><td>Optional</td><td><strong>Number of seconds a video must play before skipping is enabled;</strong> only applicable if the ad is skippable.</td></tr><tr><td><code>sequence</code></td><td>integer;<br>default 0<br>DEPRECATED</td><td><mark style="color:orange;">Deprecated</mark></td><td>Deprecated as of OpenRTB 2.6. Use <code>slotinpod</code></td></tr><tr><td><code>battr</code></td><td>integer array</td><td>Optional</td><td><strong>Blocked creative attributes</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-attributes-">List: Creative Attributes</a> in AdCOM 1.0.</td></tr><tr><td><code>maxextended</code></td><td>integer</td><td>Optional</td><td><strong>Maximum extended ad duration</strong> 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 <code>maxduration</code> value.</td></tr><tr><td><code>minbitrate</code></td><td>integer</td><td>Optional</td><td><strong>Minimum bit rate</strong> in Kbps (kilobits per second). Default is 10 if not defined in the request.</td></tr><tr><td><code>maxbitrate</code></td><td>integer</td><td>Optional</td><td><strong>Maximum bit rate</strong> in Kbps (kilobits per second). Default is 3000 is not defined in the request</td></tr><tr><td><code>boxingallowed</code></td><td>integer;<br>default 1</td><td>Optional</td><td>Indicates if <strong>letter-boxing</strong> of 4:3 content into a 16:9 window is allowed, where 0=no, 1=yes.</td></tr><tr><td><code>playbackmethod</code></td><td>integer array</td><td>Optional</td><td><strong>Playback methods that may be in use</strong>. If <strong>none are specified, any method may be used.</strong> Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--playback-methods-">List: Playback Methods</a> in AdCOM 1.0. 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.</td></tr><tr><td><code>playbackend</code></td><td>integer</td><td>Optional</td><td>The <strong>event that causes playback to end</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--playback-cessation-modes-">List: Playback Cessation Modes</a> in AdCOM 1.0.</td></tr><tr><td><code>delivery</code></td><td>integer array</td><td>Optional</td><td><strong>Supported delivery methods</strong> (e.g., streaming, progressive). If none specified, assume all are supported. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--delivery-methods-">List: Delivery Methods</a> in AdCOM 1.0.</td></tr><tr><td><code>pos</code></td><td>integer</td><td>Optional</td><td><strong>Ad position on screen</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--placement-positions-">List: Placement Positions</a> in AdCOM 1.0.</td></tr><tr><td><code>companionad</code></td><td>object array</td><td>Optional</td><td>Array of <a href="#id-5.-banner-object"><code>banner</code> objects </a>if <strong>companion ads</strong> are available.</td></tr><tr><td><code>api</code></td><td>integer array</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>List of supported API frameworks for this impressio</strong>n. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-">List: API Frameworks</a> in AdCOM 1.0. <strong>If an API is not explicitly listed, it is assumed not to be supported.</strong> <mark style="color:$warning;">Defaults to <code>[1.0]</code> unless both <code>imp.ext.omidpn</code> and <code>imp.ext.omidpv</code> are missing, in which case <code>api</code> is removed (cf.</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/open-measurement-omid.md">Open Measurement (OMID)</a><mark style="color:$warning;">)</mark></td></tr><tr><td><code>companiontype</code></td><td>integer array</td><td><mark style="color:purple;">Recommended</mark><br>if <code>companionad</code> not empty</td><td><strong>Supported VAST companion ad types</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--companion-types-">List: Companion Types</a> in AdCOM 1.0. Recommended if companion <code>Banner</code> objects are included via the <code>companionad</code> array. If one of these banners will be rendered as an end-card, this can be specified using the <code>vcm</code> attribute with the particular banner (Section 3.2.6).</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.rewarded</code></td><td>integer</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, where 0 = no, 1 = yes. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ext.is_rewarded</code></td><td>integer</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, where 0 = no, 1 = yes. <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ext.videotype</code></td><td>string</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, when set to "rewarded". <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr><tr><td><code>ext.placementtype</code></td><td>string</td><td>Optional</td><td><strong>Indicates whether the user receives a reward for viewing the ad</strong>, when set to "rewarded". <mark style="color:$warning;">Refer to</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/rewarded-ads.md">Rewarded Ads</a><mark style="color:$warning;">for all means to signal rewarded inventory.</mark></td></tr></tbody></table>

## 7. `native` object

<table data-full-width="true"><thead><tr><th width="165.796875">FIeld</th><th width="155.8359375">Type</th><th width="147.30078125">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>request</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td><strong>Request payload</strong> complying with the <a href="https://iabtechlab.com/standards/openrtb-native/">Native Ad Specification</a>. The root node of the payload, "native", was dropped in the Native Ads Specification 1.1.<br>For Native 1.0, this is a JSON-encoded string consisting of a unnamed root object, with a single subordinate object named 'native', which is the Native Markup Request object, section 4.1 of OpenRTB Native 1.0 specification.<br>For Native 1.1 and higher, this is a JSON-encoded string consisting of an unnamed root object which is itself the Native Markup Request Object, section 4.1 of OpenRTB Native 1.1+ .</td></tr><tr><td><code>ver</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Version of the Dynamic Native Ads API</strong> to which <code>request</code> complies; <mark style="color:purple;">highly recommended for efficient parsing.</mark></td></tr><tr><td><code>api</code></td><td>integer array</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>List of supported API frameworks</strong> for this impression. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--api-frameworks-">List: API Frameworks</a> in AdCOM. If an API is not explicitly listed, it is assumed not to be supported. <mark style="color:$warning;">Defaults to <code>[1.0]</code> unless both <code>imp.ext.omidpn</code> and <code>imp.ext.omidpv</code> are missing, in which case <code>api</code> is removed (cf.</mark> <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/open-measurement-omid.md">Open Measurement (OMID)</a>)<mark style="color:$warning;">.</mark></td></tr><tr><td><code>battr</code></td><td>integer array</td><td>Optional</td><td><strong>Blocked creative attributes</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--creative-attributes-">List: Creative Attributes</a> in AdCOM.</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## 8. `format` object

{% hint style="warning" %}
It is recommended that either the `w`/`h` pair or the `wratio`/`hratio`/`wmin` set (i.e., for Flex Ads) be specified.
{% endhint %}

<table data-full-width="true"><thead><tr><th width="167.125">Field</th><th width="137.546875">Type</th><th width="171.953125">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>w</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Width</strong> in device-independent pixels (DIPS).</td></tr><tr><td><code>h</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Height</strong> in device-independent pixels (DIPS).</td></tr><tr><td><code>wratio</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Relative width</strong> when expressing size as a ratio.</td></tr><tr><td><code>hratio</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Relative height</strong> when expressing size as a ratio.</td></tr><tr><td><code>wmin</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>The minimum width</strong> in device-independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## 9. `site` object

This object should be included if the ad supported content is a website.

<table><thead><tr><th width="177.265625">Attribute</th><th width="143.12109375">Type</th><th width="147.890625">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Exchange-specific site ID</td></tr><tr><td><code>name</code></td><td>string</td><td>Optional</td><td>Site name (may be aliased at the publisher's request).</td></tr><tr><td><code>domain</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td>Domain of the site (e.g., "mysite.foo.com").</td></tr><tr><td><code>cat</code></td><td>string array</td><td><mark style="color:purple;">Recommended</mark></td><td>Array of IAB Tech Lab content categories of the site. The taxonomy to be used is defined by the cattax field.</td></tr><tr><td><code>sectioncat</code></td><td>string array</td><td>Optional</td><td>Array of IAB Tech Lab content categories that describe the current section of the site. The taxonomy to be used is defined by the cattax field.</td></tr><tr><td><code>pagecat</code></td><td>string array</td><td>Optional</td><td>Array of IAB Tech Lab content categories that describe the current page or view of the site. The taxonomy to be used is definied by the cattax field.</td></tr><tr><td><code>page</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>URL of the page where the impression will be shown.</td></tr><tr><td><code>ref</code></td><td>string</td><td>Optional</td><td>Referrer URL that caused navigation to the current page.</td></tr><tr><td><code>search</code></td><td>string</td><td>Optional</td><td>Search string that caused navigation to the current page.</td></tr><tr><td><code>mobile</code></td><td>integer</td><td>Optional</td><td>Indicates if the site has been programmed to optimize layout when viewed on mobile devices, <strong>where 0=no, 1=yes.</strong></td></tr><tr><td><code>privacypolicy</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><p>Indicates if the <strong>site has a privacy policy, where 0 = no, 1 = yes.</strong></p><p><br></p></td></tr><tr><td><code>publisher</code></td><td><a href="#id-10.-publisher-object">object</a></td><td><mark style="color:red;">Required</mark></td><td><strong>Details about the Publisher</strong> of the site. See <a href="#id-10.-publisher-object"><code>publisher</code> object.</a></td></tr><tr><td><code>content</code></td><td><a href="#id-11.-content-object">object</a></td><td>Optional</td><td><strong>Details about the Content</strong> within the site. See <a href="#id-11.-content-object"><code>content</code> object.</a></td></tr><tr><td><code>keywords</code></td><td>string</td><td>Optional</td><td><p><strong>Comma separated list of keywords</strong> about the site. Only one of <code>keywords</code> or <code>kwarray</code> may be present.</p><p><br></p></td></tr><tr><td><code>kwarray</code></td><td>string array</td><td>Optional</td><td>Array of keywords about the site. Only one of <code>keywords</code> or <code>kwarray</code> may be present.</td></tr><tr><td>inventorypartnerdomain</td><td>string</td><td>Optional</td><td>A domain to be used for inventory authorization in the case of inventory sharing arrangements between a site owner and content owner. This field is typically used by authorization crawlers to establish the domain of the content owner, who has the right to monetize some portion of ad inventory within the site. The content owner's domain should be listed in the site owner's ads.txt file as an <code>inventorypartnerdomain</code>. Authorization for supply from the <code>inventorypartnerdomain</code> will be published in the ads.txt file on the root of that domain. Refer to <a href="https://iabtechlab.com/wp-content/uploads/2022/04/Ads.txt-1.1.pdf">the ads.txt 1.1 spec</a> for more details.</td></tr><tr><td><code>site.ext.pagetype</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Describes what kind of content will be present in the page</strong>. - max length: 30 - max distinctive values: 50</td></tr><tr><td><code>site.ext.category</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Category of the content displayed in the page</strong>. - max length: 30 - max distinctive values: 50</td></tr><tr><td><code>ext</code></td><td>object</td><td><mark style="color:purple;">Recommended</mark><br>cf. above <code>pagetype</code> and <code>category</code></td><td><p>Placeholder for exchange-specific extensions to OpenRTB</p><p><br></p></td></tr></tbody></table>

## 10. `app` object

This object should be included if the ad supported content is a non-browser application

<table data-full-width="true"><thead><tr><th width="176.125">Attribute</th><th width="151.81640625">Type</th><th width="198.21484375">Required</th><th width="742.71484375">Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Exchange-specific app ID</strong>.</td></tr><tr><td><code>name</code></td><td>string</td><td>Optional</td><td><strong>App name</strong>.</td></tr><tr><td><code>bundle</code></td><td>string</td><td><mark style="color:red;">Required</mark></td><td>The <strong>store ID of the app in an app store</strong>. For mobile apps in Google Play Store, these should be bundle or package names (e.g. <code>com.foo.mygame</code>). For apps in Apple App Store, these should be a numeric ID (e.g. <code>324684580)</code>.</td></tr><tr><td><code>domain</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Domain of the app</strong> developer (e.g., "mygame.foo.com") on which the app-ads.txt can be found.</td></tr><tr><td><code>storeurl</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>App store URL for an installed app; for IQG 2.1 compliance.</td></tr><tr><td><code>content.url</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Specific </strong><em><strong>web URL</strong></em><strong> corresponding to viewed content</strong> <mark style="color:$warning;">(not a deep link or app store URL)</mark>, <strong>accessible</strong> by <code>AmazonAdBot</code> <mark style="color:$warning;">(even for paywalled content)</mark>.<br><br>Check <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/amazon-dsp-contenturl-and-amazonadbot.md">Amazon DSP: ContentURL &amp; AmazonAdBot</a> for more information</td></tr><tr><td><code>cattax</code></td><td>integer;<br>default 1</td><td>Optional</td><td>The taxonomy in use. Refer to the AdCOM <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies">List: Category Taxonomies</a> for values. <mark style="color:$danger;">Values other than 1 are strongly discouraged, please contact</mark> <a href="mailto:csm@adagio.io"><mark style="color:$danger;">your CSM</mark></a> <mark style="color:$danger;">if you use them.</mark></td></tr><tr><td><code>cat</code></td><td>string array</td><td><mark style="color:purple;">Recommended</mark></td><td>Array of IAB Tech Lab <strong>content categories of the app</strong>. The taxonomy to be used is defined by the <code>cattax</code> field. If no <code>cattax</code> field is supplied Content Category Taxonomy 1.0 is assumed.</td></tr><tr><td><code>sectioncat</code></td><td>string array</td><td>Optional</td><td>Array of IAB Tech Lab <strong>content categories that describe the current section of the app</strong>. The taxonomy to be used is defined by the <code>cattax</code> field.</td></tr><tr><td><code>pagecat</code></td><td>string array</td><td>Optional</td><td>Array of IAB Tech Lab <strong>content categories that describe the current page or view of the app</strong>. The taxonomy to be used is defined by the <code>cattax</code> field.</td></tr><tr><td><code>ver</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Application <strong>version</strong>.</td></tr><tr><td><code>privacypolicy</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Indicates if the <strong>app has a privacy policy</strong>, where 0 = no, 1 = yes.</td></tr><tr><td><code>paid</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>0 = app is free, 1 = the app is <strong>a paid version.</strong></td></tr><tr><td><code>publisher</code></td><td>object</td><td><mark style="color:red;">Required</mark></td><td><strong>Details about the Publisher</strong> of the app. See <a href="#id-10.-publisher-object"><code>publisher</code> object.</a></td></tr><tr><td><code>content</code></td><td>object</td><td>Optional</td><td><strong>Details about the Content</strong> within the app. See <a href="#id-11.-content-object"><code>content</code> object.</a></td></tr><tr><td><code>keywords</code></td><td>string</td><td>Optional</td><td><strong>Comma separated list of keywords</strong> about the app. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>kwarray</code></td><td>string array</td><td>Optional</td><td><strong>Array of keywords</strong> about the app. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>inventorypartnerdomain</code></td><td>string</td><td>Optional</td><td><strong>A domain to be used for inventory authorization in the case of inventory sharing arrangements between an app owner and content owner</strong>. This field is typically used by authorization crawlers to establish the domain of the content owner, who has the right to monetize some portion of ad inventory within the app. The content owner's domain should be listed in the app owner's app-ads.txt file as an <code>inventorypartnerdomain</code>. Authorization for supply from the <code>inventorypartnerdomain</code> will be published in the ads.txt file on the root of that domain. Refer to <a href="https://iabtechlab.com/wp-content/uploads/2022/04/Ads.txt-1.1.pdf">the ads.txt 1.1 spec</a> for more details.</td></tr><tr><td><code>ext</code></td><td>object</td><td><mark style="color:purple;">Recommended</mark></td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.category</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Category of the content displayed in the page.</td></tr><tr><td><code>ext.pagetype</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Describes what kind of content will be present in the page.</td></tr></tbody></table>

## **11. `publisher` object**

<table data-full-width="true"><thead><tr><th width="180.7265625">FIeld</th><th width="147.21875">Type</th><th width="116.94921875">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Exchange-specific seller ID. Every ID must map to only a single entity that is paid for inventory transacted via that ID. <strong>Corresponds to a <code>seller_id</code></strong> of a seller in the exchange’s sellers.json file.</td></tr><tr><td><code>name</code></td><td>string</td><td>Optional</td><td><strong>Seller name</strong></td></tr><tr><td><code>cattax</code></td><td>integer;<br>default 1</td><td>Optional</td><td>The taxonomy in use. Refer to the AdCOM <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies">List: Category Taxonomies</a> for values.</td></tr><tr><td><code>cat</code></td><td>string array</td><td>Optional</td><td>Array of IAB Tech Lab <strong>content categories of the publisher</strong>. The taxonomy to be used is defined by the <code>cattax</code> field. If no <code>cattax</code> field is supplied Content Category Taxonomy 1.0 is assumed.</td></tr><tr><td><code>domain</code></td><td>string</td><td>Optional</td><td><strong>Highest level domain</strong> of the seller (e.g., "seller.com").</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td><strong>Placeholder</strong> for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## **12. `content` object**

<table data-full-width="true"><thead><tr><th width="184.05859375">field</th><th width="213.74609375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>id</code></td><td>string</td><td><strong>Publisher-provided ID uniquely identifying the content.</strong></td></tr><tr><td><code>episode</code></td><td>integer</td><td><strong>Episode number</strong>.</td></tr><tr><td><code>title</code></td><td>string</td><td><strong>Content title</strong>.<br><em>Video Examples:</em> “Search Committee” (television), “A New Hope” (movie), or “Endgame” (made for web).<br><em>Non-Video Example:</em> “Why an Antarctic Glacier Is Melting So Quickly” (Time magazine article).</td></tr><tr><td><code>series</code></td><td>string</td><td><strong>Content series</strong>.<br><em>Video Examples:</em> “The Office” (television), “Star Wars” (movie), or “Arby ‘N’ The Chief” (made for web).<br><em>Non-Video Example:</em> “Ecocentric” (Time Magazine blog).</td></tr><tr><td><code>season</code></td><td>string</td><td><strong>Content season</strong> (e.g., “Season 3”).</td></tr><tr><td><code>artist</code></td><td>string</td><td><strong>Artist credited</strong> with the content.</td></tr><tr><td><code>genre</code></td><td>string</td><td><strong>Genre</strong> that best describes the content (e.g., rock, pop, etc).</td></tr><tr><td><code>gtax</code></td><td>int;<br>default 9</td><td>The <strong>taxonomy in use</strong>. Refer to list <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies">List: Category Taxonomies</a> in AdCOM 1.0 for values.<br><br>If no <code>gtax</code> field is supplied rows listed, Content Category Taxonomy 3.1 is assumed</td></tr><tr><td><code>genres</code></td><td>string array</td><td><strong>Unique ID(s) for the genre</strong> of the content as listed in the taxonomy defined by the gtax field. If no gtax field is supplied, subset of rows listed in <a href="https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Taxonomy%20Mappings/CTV%20Genre%20Mapping.tsv">CTV Genre Mapping</a> of <a href="https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%203.1.tsv">Content Category Taxonomy 3.1</a> are assumed.<br><br>See <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/implementation.md#genre">Section 7.13 of Implementation Guidance</a> for additional detail.</td></tr><tr><td><code>album</code></td><td>string</td><td><strong>Album to which the content belongs</strong>; typically for audio.</td></tr><tr><td><code>isrc</code></td><td>string</td><td><strong>International Standard Recording Code</strong> conforming to ISO- 3901.</td></tr><tr><td><code>producer</code></td><td>object</td><td>Refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#3217---object-producer-">official documentation</a> for more information</td></tr><tr><td><code>url</code></td><td>string</td><td><strong>URL of the content,</strong> for buy-side contextualization or review.</td></tr><tr><td><code>cattax</code></td><td>integer;<br>default 1</td><td>The <strong>taxonomy</strong> in use. Refer to list <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies">List: Category Taxonomies</a> in AdCOM 1.0 for values.</td></tr><tr><td><code>cat</code></td><td>string array</td><td>Array of IAB Tech Lab <strong>content categories that describe the content</strong>. The taxonomy to be used is defined by the cattax field. If no cattax field is supplied Content Category Taxonomy 1.0 is assumed.</td></tr><tr><td><code>prodq</code></td><td>integer</td><td><strong>Production quality</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--production-qualities-">List: Production Qualities</a> in AdCOM 1.0.</td></tr><tr><td><code>context</code></td><td>integer</td><td><strong>Type of content</strong> (game, video, text, etc.). Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--content-contexts-">List: Content Contexts</a> in AdCOM 1.0.</td></tr><tr><td><code>contentrating</code></td><td>string</td><td><strong>Content rating</strong> (e.g., MPAA).</td></tr><tr><td><code>userrating</code></td><td>string</td><td><strong>User rating of the content</strong> (e.g., number of stars, likes, etc.).</td></tr><tr><td><code>qagmediarating</code></td><td>integer</td><td><strong>Media rating per IQG guidelines</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--media-ratings-">List: Media Ratings</a> in AdCOM 1.0.</td></tr><tr><td><code>keywords</code></td><td>string</td><td><strong>Comma separated list of keywords describing the content</strong>. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>kwarray</code></td><td>string array</td><td><strong>Array of keywords</strong> about the content. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>livestream</code></td><td>integer</td><td>0 = not live, 1 = content is live (e.g., stream, live blog).</td></tr><tr><td><code>sourcerelationship</code></td><td>integer</td><td>0 = indirect, 1 = direct.</td></tr><tr><td><code>len</code></td><td>integer</td><td><strong>Length of content in seconds</strong>; appropriate for video or audio.</td></tr><tr><td><code>language</code></td><td>string</td><td><strong>Content language</strong> using ISO-639-1-alpha-2. <mark style="color:$warning;">Only one of <code>language</code> or <code>langb</code> should be present</mark>.</td></tr><tr><td><code>langb</code></td><td>string</td><td><strong>Content language</strong> using IETF BCP 47. <mark style="color:$warning;">Only one of <code>language</code> or <code>langb</code> should be present.</mark></td></tr><tr><td><code>embeddable</code></td><td>integer</td><td>Indicator of whether the <strong>content is embeddable</strong> (e.g., an embeddable video player), where 0 = no, 1 = yes.</td></tr><tr><td><code>data</code></td><td>object array</td><td><strong>Additional content data</strong>. Each <code>Data</code> object (refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectdata">IAB Section 3.2.21</a>) represents a different data source.</td></tr><tr><td><code>network</code></td><td>object</td><td>Details about the <strong>network</strong> (refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectnetwork">IAB Section 3.2.23</a>) the content is on.</td></tr><tr><td><code>channel</code></td><td>object</td><td>Details about the <strong>channel</strong> (refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectchannel">IAB Section 3.2.24</a>) the content is on.</td></tr><tr><td><code>ext</code></td><td>object</td><td><strong>Placeholder</strong> for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## 13. `device` object

<table data-full-width="true"><thead><tr><th width="154.6171875">Field</th><th width="140.12109375">Type</th><th width="163.44921875">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>geo</code></td><td><a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-3.13-geo-object">object</a></td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Location of the device</strong> assumed to be the user’s current location defined<a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-3.13-geo-object"> by a <code>Geo</code> object</a></td></tr><tr><td><code>dnt</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Standard “Do Not Track” flag as set in the header by the browser</strong>, where 0 = tracking is unrestricted, 1 = do not track.</td></tr><tr><td><code>lmt</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>“Limit Ad Tracking” signal commercially endorsed</strong> (e.g., iOS, Android), where 0 = tracking is unrestricted, 1 = tracking must be limited per commercial guidelines.</td></tr><tr><td><code>ua</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Browser user agent string.</strong> This field represents a raw user agent string from the browser. <mark style="color:$warning;">If present, <code>sua</code> will be preferred by bidders.</mark></td></tr><tr><td><code>sua</code></td><td>object</td><td><mark style="color:purple;">Recommended</mark></td><td>Structured user agent information defined by a <code>UserAgent</code> object. <mark style="color:$warning;">If both <code>ua</code> and <code>sua</code> are present in the bid request, <code>sua</code> should be considered the more accurate representation of the device attributes.</mark> Refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#objectuseragent">official documentation </a>for more information.</td></tr><tr><td><code>ip</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>IPv4 address</strong> closest to device.</td></tr><tr><td><code>ipv6</code></td><td>string</td><td></td><td><strong>IPv6 address</strong> closest to device.</td></tr><tr><td><code>devicetype</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>The <strong>general type of device</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--device-types-">List: Device Types</a> in AdCOM 1.0.</td></tr><tr><td><code>make</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Device <strong>make</strong> (e.g., “Apple”).</td></tr><tr><td><code>model</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Device <strong>model</strong> (e.g., “iPhone”).</td></tr><tr><td><code>os</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Device <strong>operating system</strong> (e.g., “iOS”).</td></tr><tr><td><code>osv</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td>Device <strong>operating system version</strong> (e.g., “3.1.2”).</td></tr><tr><td><code>hwv</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Hardware</strong> version of the device (e.g., “5S” for iPhone 5S).</td></tr><tr><td><code>h</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Physical height</strong> of the screen in pixels.</td></tr><tr><td><code>w</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Physical width of the screen in pixels.</td></tr><tr><td><code>ppi</code></td><td>integer</td><td></td><td>Screen size as pixels per linear inch.</td></tr><tr><td><code>pxratio</code></td><td>float</td><td><mark style="color:purple;">Recommended</mark></td><td>The ratio of physical pixels to device-independent pixels (DIPS).</td></tr><tr><td><code>js</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td>Support for JavaScript, where 0 = no, 1 = yes.</td></tr><tr><td><code>geofetch</code></td><td>integer</td><td>Optional</td><td>Indicates if the <strong>geolocation API will be available to JavaScript</strong> code running in the banner, where 0 = no, 1 = yes.</td></tr><tr><td><code>flashver</code></td><td>string</td><td>Optional</td><td><strong>Version of Flash supported</strong> by the browser.</td></tr><tr><td><code>language</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Browser language</strong> using ISO-639-1-alpha-2. <mark style="color:$warning;">Only one of <code>language</code> or <code>langb</code> should be present.</mark></td></tr><tr><td><code>langb</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Browser language</strong> using IETF BCP 47. <mark style="color:$warning;">Only one of <code>language</code> or <code>langb</code> should be present.</mark></td></tr><tr><td><code>carrier</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Carrier or ISP</strong> (e.g., “VERIZON”) using exchange curated string names which should be published to bidders <em>a priori</em>.</td></tr><tr><td><code>mccmnc</code></td><td>string</td><td>Optional</td><td><strong>Mobile carrier</strong> as the concatenated MCC-MNC code (e.g., “310-005” identifies Verizon Wireless CDMA in the USA). Refer to <a href="https://en.wikipedia.org/wiki/Mobile_country_code">https://en.wikipedia.org/wiki/Mobile_country_code</a> for further examples. Note that the dash between the MCC and MNC parts is required to remove parsing ambiguity. The MCC-MNC values represent the SIM installed on the device and do not change when a device is roaming. Roaming may be inferred by a combination of the MCC-MNC, geo, IP and other data signals.</td></tr><tr><td><code>connectiontype</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Network connection type</strong>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--connection-types-">List: Connection Types</a> in AdCOM 1.0.</td></tr><tr><td><code>ifa</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>ID sanctioned for advertiser use</strong> in the clear (i.e., not hashed) and must never be (or be based on) a hardware-specific ID but rather obtained from a call to an advertising API provided by the device's OS.</td></tr><tr><td><code>ext</code></td><td>object</td><td><mark style="color:red;"><strong>Required</strong></mark><br>See <code>ext.ifa_type</code></td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr><tr><td><code>ext.ifa_type</code></td><td>string</td><td><mark style="color:red;"><strong>Required</strong></mark><br>if <code>ifa</code> present</td><td><strong>Identify the source</strong> of the IFA (cf. <a href="https://github.com/InteractiveAdvertisingBureau/openrtb/blob/main/extensions/community_extensions/ifa_type.md#list--ifa-types-">oRTB docs for possible values</a>)</td></tr></tbody></table>

## 14. `geo` object

<table data-full-width="true"><thead><tr><th width="160.5">Attribute</th><th width="123.48046875">Type</th><th width="182.85546875">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>lat</code></td><td>float</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Latitude</strong> from -90.0 to +90.0, where negative is south.</td></tr><tr><td><code>lon</code></td><td>float</td><td><mark style="color:purple;">Recommended</mark></td><td><strong>Longitude</strong> from -180.0 to +180.0, where negative is west.</td></tr><tr><td><code>type</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> present</td><td><strong>Source of location data</strong>; recommended when passing <code>lat</code>/<code>lon</code>. Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--location-types-">List: Location Types</a> in AdCOM 1.0. <mark style="color:$warning;">When type = 2, it's highly recommended to also set <code>ipservice</code>.</mark></td></tr><tr><td><code>accuracy</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> present and <code>type = 1</code></td><td>Estimated location accuracy in meters. Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation.</td></tr><tr><td><code>lastfix</code></td><td>integer</td><td>Optional</td><td>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.</td></tr><tr><td><code>ipservice</code></td><td>integer</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> present and <code>type = 2</code></td><td>Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2). Refer to <a href="https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/master/AdCOM%20v1.0%20FINAL.md#list--ip-location-services-">List: IP Location Services</a> in AdCOM 1.0.</td></tr><tr><td><code>country</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> omitted</td><td><strong>Country code</strong> using ISO-3166-1-alpha-3.</td></tr><tr><td><code>region</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> omitted</td><td><strong>Region code</strong> using ISO-3166-2; 2-letter state code if USA.</td></tr><tr><td><code>regionfips104</code></td><td>string</td><td>Optional</td><td><strong>Region of a country</strong> using FIPS 10-4 notation. While OpenRTB supports this attribute, it was withdrawn by NIST in 2008.</td></tr><tr><td><code>metro</code></td><td>string</td><td>Optional</td><td><strong>Google metro cod</strong>e; similar to but not exactly Nielsen DMAs.</td></tr><tr><td><code>city</code></td><td>string</td><td><mark style="color:purple;">Recommended</mark><br>if <code>lat</code>/<code>long</code> omitted</td><td><strong>City</strong> using United Nations Code for Trade &#x26; Transport Locations. Refer to <a href="https://unece.org/trade/cefact/unlocode-code-list-country-and-territory">UNECE documentation</a>.</td></tr><tr><td><code>zip</code></td><td>string</td><td>Optional</td><td><strong>ZIP</strong> or <strong>postal code.</strong></td></tr><tr><td><code>utcoffset</code></td><td>integer</td><td>Optional</td><td>Local time as the number <strong>+/- of minutes from UTC</strong>.</td></tr><tr><td><code>ext</code></td><td>object</td><td>Optional</td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## 15. `user` object

<table data-full-width="true"><thead><tr><th width="182.06640625">Field</th><th width="218.96484375">Type</th><th width="203.33203125">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>buyeruid</code></td><td>string</td><td>Optional</td><td><strong>Buyer-specific ID for the user</strong> as mapped by the exchange for the buyer.<br><mark style="color:$warning;">Shouldn't be applicable to App traffic given the absence of cookie based userID syncs.</mark></td></tr><tr><td><code>keywords</code></td><td>string</td><td>Optional</td><td><strong>Comma separated list of keywords</strong>, interests, or intent. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>kwarray</code></td><td>string array</td><td>Optional</td><td><strong>Array of keywords about the user</strong>. <mark style="color:$warning;">Only one of <code>keywords</code> or <code>kwarray</code> may be present.</mark></td></tr><tr><td><code>customdata</code></td><td>string</td><td>Optional</td><td><strong>Optional feature to pass bidder data</strong> that was set in the exchange’s cookie. <mark style="color:$warning;">Shouldn't be applicable to App traffic given the absence of cookie based userID syncs.</mark></td></tr><tr><td><code>geo</code></td><td>object</td><td>Optional</td><td>Location of the <strong>user’s home base</strong> defined by a <code>Geo</code> object (Section 3.2.19). This is not necessarily their current location.</td></tr><tr><td><code>data</code></td><td>object array</td><td>Optional</td><td><strong>Additional user data</strong>. Each <code>Data</code> object (Refer to <a href="https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md#3221---object-data-">IAB Section 3.2.21</a>) represents a different data source.</td></tr><tr><td><code>consent</code> or <code>ext.consent</code></td><td>string</td><td><mark style="color:red;"><strong>Required</strong></mark><br>if <code>regs.gdpr</code> or <code>regs.ext.gdpr</code> = <code>1</code></td><td>When GDPR regulations are in effect this attribute contains the Transparency and Consent Framework’s <a href="https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md">Consent String</a> data structure.</td></tr><tr><td><code>eids</code> or <code>ext.eids</code></td><td><a href="/pages/Q1HXKf6s7dwLszfcw7xw#id-4.1-external-ids-eids">object array</a></td><td><mark style="color:purple;">Recommended</mark></td><td>Standardized way to carry external identity signals across the ad ecosystem. Refer to <a data-mention href="/adagio-documentation/openrtb-s2s-endpoint/supported-extensions/external-ids-eids.md">External IDs (EIDs)</a></td></tr><tr><td><code>ext</code></td><td>object</td><td>cf. above <code>consent</code> and <code>eids</code></td><td>Placeholder for exchange-specific extensions to OpenRTB.</td></tr></tbody></table>

## References

* [OpenRTB 2.6 Spec](https://github.com/InteractiveAdvertisingBureau/openrtb2.x/blob/main/2.6.md)
* [OpenRTB 2.6 Community extensions](https://github.com/InteractiveAdvertisingBureau/openrtb/tree/main/extensions/community_extensions)
* [OpenRTB 2.6 Official extensio](https://github.com/InteractiveAdvertisingBureau/openrtb/tree/main/extensions/2.x_official_extensions)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://adagio-io.gitbook.io/adagio-documentation/openrtb-s2s-endpoint/all-supported-openrtb-parameters/bid-request-objects-and-parameters.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.