From 304bca96f4bcc98d91652de4b6327169c2a71578 Mon Sep 17 00:00:00 2001 From: Rob Hazan Date: Tue, 15 Sep 2020 11:09:07 -0400 Subject: [PATCH] Update indexExchange.md to include Prebid Server details (#1) (#2331) * Update indexExchange.md * minor spelling fix * Fixed minor grammatical errors (#2) * Changed timeout example to 50ms Co-authored-by: rimaburder-index <55195208+rimaburder-index@users.noreply.github.com> Co-authored-by: rimaburder-index <55195208+rimaburder-index@users.noreply.github.com> --- dev-docs/bidders/indexExchange.md | 61 +++++++++++++++++++++++++------ 1 file changed, 50 insertions(+), 11 deletions(-) diff --git a/dev-docs/bidders/indexExchange.md b/dev-docs/bidders/indexExchange.md index c724f18be0..5ed73f868a 100644 --- a/dev-docs/bidders/indexExchange.md +++ b/dev-docs/bidders/indexExchange.md @@ -24,16 +24,18 @@ Maintainer: prebid.support@indexexchange.com ## Description -This module connects publishers to Index Exchange's (IX) network of demand -sources through Prebid.js. This module is GDPR and CCPA compliant. +Publishers may access Index Exchange's (IX) network of demand +sources through our Prebid.js and Prebid Server adapters. Both of these modules are GDPR and CCPA compliant. -It is compatible with both the older ad unit format where the `sizes` and +### IX Prebid.js Adapter + +Our Prebid.js adapter is compatible with both the older ad unit format where the `sizes` and `mediaType` properties are placed at the top-level of the ad unit, and the newer format where this information is encapsulated within the `mediaTypes` object. We recommend that you use the newer format when possible as it will be better able to accommodate new feature additions. -If a mix of properties from both formats are present within an ad unit, the +If a mix of properties from both formats is present within an ad unit, the newer format's properties will take precedence. Here are examples of both formats. @@ -74,7 +76,7 @@ var adUnits = [{ }]; ``` -### Supported Media Types +### Supported Media Types (Prebid.js) {: .table .table-bordered .table-striped } | Type | Support | @@ -83,6 +85,15 @@ var adUnits = [{ | `Video` | Fully supported for all IX approved sizes. | | `Native` | Not supported. | +### Supported Media Types (Prebid Server) + +{: .table .table-bordered .table-striped } +| Type | Support | +| ------ | ------- | +| `Banner` | Fully supported for all IX approved sizes. | +| `Video` | Not supported. | +| `Native` | Not supported. | + ## Bid Parameters Each of the IX-specific parameters provided under the `adUnits[].bids[].params` @@ -322,12 +333,12 @@ gulp build --modules=bidderModules.json ## Setting First Party Data (FPD) -FPD allows you to specify key-value pairs which will be passed as part of the +FPD allows you to specify key-value pairs that are passed as part of the query string to IX for use in Private Marketplace Deals which rely on query string targeting for activation. For example, if a user is viewing a news-related page, you can pass on that information by sending `category=news`. -Then in the IX Private Marketplace setup screens you can create Deals which -activate only on pages which contain `category=news`. Please reach out to your +Then in the IX Private Marketplace setup screens, you can create Deals which +activate only on pages that contain `category=news`. Please reach out to your IX representative if you have any questions or need help setting this up. To include FPD in a bid request, it must be set before `pbjs.requestBids` is @@ -363,13 +374,41 @@ such: ```javascript pbjs.setConfig({ ix: { - timeout: 250 + timeout: 50 } }); ``` The timeout value must be a positive whole number in milliseconds. +## IX Prebid Server Adapter + +Publishers who would like to retrieve IX demand via a Prebid Server instance can do so by adding IX to the list of bidders for a Prebid Server bid request, with a valid site ID. For example: + +```javascript +"imp": [ + { + "id": "test2", + "banner": { + "format": [ + { + "w": 300, + "h": 600 + } + ] + }, + "ext": { + "ix": { + "siteId": "12345" + } + } + } +] +``` + +### Important Prebid Server Note +Any party operating their own hosted Prebid Server instances must reach out to IX (prebid.support@indexexchange.com) to receive approval and customized setup instructions. Please do not send Prebid Server requests without first contacting us -- you will not receive bid responses. + ## Additional Information ### Bid Request Limit @@ -402,9 +441,9 @@ unit we require the size to be explicitly stated. 2. An ad unit may have sizes that IX does not support. By explicitly stating the size, you can choose not to have IX bid on certain sizes that are invalid. -### How do I view IX's bid request in the network? +### How can I view the bid request sent to IX by Prebid.js? In your browser of choice, create a new tab and open the developer tools. In developer tools, select the network tab. Then, navigate to a page where IX is -setup to bid. Now, in the network tab, search for requests to +set up to bid. Now, in the network tab, search for requests to `casalemedia.com/cygnus`. These are the bid requests.