Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 21 additions & 22 deletions dev-docs/bidders/ttd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <OpenPathPublishers@thetradedesk.com> 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 <https://docs.prebid.org/dev-docs/modules/gpt-pre-auction.html>. 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`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see why this line should be removed.
https://github.com/prebid/Prebid.js/blob/1d8b5fe28c16b1965252839e27fcb9a9afc15312/modules/ttdBidAdapter.js#L284 still switches to a different endpoint when you set that param to true

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@robin-crazygames All of our endpoints support HTTP/2 now. So we no longer need to send traffic to some special endpoint for that. We don't want to break backwards compatibility for anyone who may be using this flag, but have no need for it anymore. So we figure just remove it from docs so nobody net new starts using it.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### 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 <https://docs.prebid.org/dev-docs/modules/gpt-pre-auction.html>. 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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
Loading