diff --git a/dev-docs/bidders/ttd.md b/dev-docs/bidders/ttd.md index 5226d955a5..adc903af42 100644 --- a/dev-docs/bidders/ttd.md +++ b/dev-docs/bidders/ttd.md @@ -26,36 +26,35 @@ gpp_sids: false fpd_supported: false --- -### Disclosure - -This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing. +## Disclosure {: .alert.alert-danger :} Note: The Trade Desk Header Bidding adapter requires setup and approval before beginning. Please reach out to for more details. -### Bid Params +## Bid Params {: .table .table-bordered .table-striped } -Name | Scope | Description | Example | Type ---- | --- | --- | --- | ---- -`supplySourceId` | required | The TTD-provided supply source name. | `'supplier'` | `String` -`publisherId` | required | The publisher ID. If there is a sellers.json, this should be the same as the seller_id in the sellers.json for the site being trafficked. If there is no sellers.json, this should be hardcoded to "1". | `'1427ab10f2e448057ed3b422'` | `String` -`placementId` | optional | This field is optional if GPID is passed through the GPT module . If that module isn't used, the GPID value should be passed in this field. | `'/1111/home#header'` | `String` -`banner` | optional | Display banner targeting parameters. See the banner section below. | `{}` | `object` -`bidfloor` | optional | Sets a bid floor price | `0.95` | `Float` -`customBidderEndpoint` | optional | Only set if TTD has provided a custom endpoint. If set the custom endpoint will take precedent over the hard-coded endpoints | `https://customBidderEndpoint/bid/bidder/` | `String` -`useHttp2` | optional | When true, the adapter will use an endpoint that supports HTTP2. | `true` | `boolean` - -### Banner Object + +| Name | Scope | Description | Example | Type | +| --- | --- | --- | --- | --- | +| `supplySourceId` | required | The TTD-provided supply source name. | `'supplier'` | `String` | +| `publisherId` | required | The publisher ID. If there is a sellers.json, this should be the same as the seller_id in the sellers.json for the site being trafficked. If there is no sellers.json, this should be hardcoded to "1". | `'1427ab10f2e448057ed3b422'` | `String` | +| `placementId` | optional | This field is optional if GPID is passed through the GPT module . If that module isn't used, the GPID value should be passed in this field. | `'/1111/home#header'` | `String` | +| `banner` | optional | Display banner targeting parameters. See the banner section below. | `{}` | `object` | +| `bidfloor` | optional | Sets a bid floor price | `0.95` | `Float` | +| `customBidderEndpoint` | optional | Only set if TTD has provided a custom endpoint. If set the custom endpoint will take precedent over the hard-coded endpoints | `https://customBidderEndpoint/bid/bidder/` | `String` | + +## Banner Object The following banner parameters are supported: {: .table .table-bordered .table-striped } -Name | Scope | Description | Example | Type ---- | --- | --- | --- | ---- -`expdir` | optional | Directions in which the banner may expand. See "Expandable Direction" in the [OpenRTB 2.5 docs](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) for possible values. | `[1, 3]` | `Array[integer]` -#### `mediaTypes.banner` Parameters +| Name | Scope | Description | Example | Type | +| --- | --- | --- | --- | --- | +| `expdir` | optional | Directions in which the banner may expand. See "Expandable Direction" in the [OpenRTB 2.5 docs](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) for possible values. | `[1, 3]` | `Array[integer]` | + +## `mediaTypes.banner` Parameters The TTD adapter for banner uses certain parameters in the AdUnit's [mediaTypes.banner](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.banner) definition. Specifically, `sizes` is required for banner ad units. `pos` is recommended. @@ -89,9 +88,9 @@ var bannerAdUnit = { } ``` -### Video +## Video -#### `mediaTypes.video` Parameters +## `mediaTypes.video` Parameters The TTD adapter for video requires certain parameters in the AdUnit's [mediaTypes.video](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.video) definition. Specifically, `maxduration`, `api`, `mimes`, `plcmt`, and `protocols` are all required for video ad units. `playerSize`, `startdelay`, `playbackmethod`, and `pos` are recommended. `minduration`, `minbitrate`, `maxbitrate`, `skip`, `skipmin`, and `skipafter` are optional. @@ -192,7 +191,7 @@ Lists of `api`, `playbackmethod`, `protocols`, `pos`, and `expdir` potential val - `4` : Down - `5` : Full Screen -### First Party Data (Supported starting prebid v7.49) +## First Party Data (Supported starting prebid v7.49) Publishers should set [First Party Data](https://docs.prebid.org/features/firstPartyData.html) in the `ortb2` and `ortb2Imp` objects. These fields are supported: