Skip to content

Commit 304bca9

Browse files
Update indexExchange.md to include Prebid Server details (prebid#1) (prebid#2331)
* Update indexExchange.md * minor spelling fix * Fixed minor grammatical errors (prebid#2) * Changed timeout example to 50ms Co-authored-by: rimaburder-index <[email protected]> Co-authored-by: rimaburder-index <[email protected]>
1 parent 7928adb commit 304bca9

File tree

1 file changed

+50
-11
lines changed

1 file changed

+50
-11
lines changed

dev-docs/bidders/indexExchange.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,18 @@ Maintainer: [email protected]
2424

2525
## Description
2626

27-
This module connects publishers to Index Exchange's (IX) network of demand
28-
sources through Prebid.js. This module is GDPR and CCPA compliant.
27+
Publishers may access Index Exchange's (IX) network of demand
28+
sources through our Prebid.js and Prebid Server adapters. Both of these modules are GDPR and CCPA compliant.
2929

30-
It is compatible with both the older ad unit format where the `sizes` and
30+
### IX Prebid.js Adapter
31+
32+
Our Prebid.js adapter is compatible with both the older ad unit format where the `sizes` and
3133
`mediaType` properties are placed at the top-level of the ad unit, and the newer
3234
format where this information is encapsulated within the `mediaTypes` object. We
3335
recommend that you use the newer format when possible as it will be better able
3436
to accommodate new feature additions.
3537

36-
If a mix of properties from both formats are present within an ad unit, the
38+
If a mix of properties from both formats is present within an ad unit, the
3739
newer format's properties will take precedence.
3840

3941
Here are examples of both formats.
@@ -74,7 +76,7 @@ var adUnits = [{
7476
}];
7577
```
7678

77-
### Supported Media Types
79+
### Supported Media Types (Prebid.js)
7880

7981
{: .table .table-bordered .table-striped }
8082
| Type | Support |
@@ -83,6 +85,15 @@ var adUnits = [{
8385
| `Video` | Fully supported for all IX approved sizes. |
8486
| `Native` | Not supported. |
8587

88+
### Supported Media Types (Prebid Server)
89+
90+
{: .table .table-bordered .table-striped }
91+
| Type | Support |
92+
| ------ | ------- |
93+
| `Banner` | Fully supported for all IX approved sizes. |
94+
| `Video` | Not supported. |
95+
| `Native` | Not supported. |
96+
8697
## Bid Parameters
8798

8899
Each of the IX-specific parameters provided under the `adUnits[].bids[].params`
@@ -322,12 +333,12 @@ gulp build --modules=bidderModules.json
322333

323334
## Setting First Party Data (FPD)
324335

325-
FPD allows you to specify key-value pairs which will be passed as part of the
336+
FPD allows you to specify key-value pairs that are passed as part of the
326337
query string to IX for use in Private Marketplace Deals which rely on query
327338
string targeting for activation. For example, if a user is viewing a
328339
news-related page, you can pass on that information by sending `category=news`.
329-
Then in the IX Private Marketplace setup screens you can create Deals which
330-
activate only on pages which contain `category=news`. Please reach out to your
340+
Then in the IX Private Marketplace setup screens, you can create Deals which
341+
activate only on pages that contain `category=news`. Please reach out to your
331342
IX representative if you have any questions or need help setting this up.
332343

333344
To include FPD in a bid request, it must be set before `pbjs.requestBids` is
@@ -363,13 +374,41 @@ such:
363374
```javascript
364375
pbjs.setConfig({
365376
ix: {
366-
timeout: 250
377+
timeout: 50
367378
}
368379
});
369380
```
370381

371382
The timeout value must be a positive whole number in milliseconds.
372383

384+
## IX Prebid Server Adapter
385+
386+
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:
387+
388+
```javascript
389+
"imp": [
390+
{
391+
"id": "test2",
392+
"banner": {
393+
"format": [
394+
{
395+
"w": 300,
396+
"h": 600
397+
}
398+
]
399+
},
400+
"ext": {
401+
"ix": {
402+
"siteId": "12345"
403+
}
404+
}
405+
}
406+
]
407+
```
408+
409+
### Important Prebid Server Note
410+
Any party operating their own hosted Prebid Server instances must reach out to IX ([email protected]) to receive approval and customized setup instructions. Please do not send Prebid Server requests without first contacting us -- you will not receive bid responses.
411+
373412
## Additional Information
374413

375414
### Bid Request Limit
@@ -402,9 +441,9 @@ unit we require the size to be explicitly stated.
402441
2. An ad unit may have sizes that IX does not support. By explicitly stating the
403442
size, you can choose not to have IX bid on certain sizes that are invalid.
404443

405-
### How do I view IX's bid request in the network?
444+
### How can I view the bid request sent to IX by Prebid.js?
406445

407446
In your browser of choice, create a new tab and open the developer tools. In
408447
developer tools, select the network tab. Then, navigate to a page where IX is
409-
setup to bid. Now, in the network tab, search for requests to
448+
set up to bid. Now, in the network tab, search for requests to
410449
`casalemedia.com/cygnus`. These are the bid requests.

0 commit comments

Comments
 (0)