Skip to content

Commit

Permalink
Update ix.md (#5046)
Browse files Browse the repository at this point in the history
* Update ix.md

Removed Prebid.js from the title and updated the  Set up Prebid.js to call Index directly from the browser (client-side adapter) section.

* Update ix.md

* Update ix.md

updated links that were broken

* Make link relative

* Proper link formatting

---------

Co-authored-by: Muki Seiler <[email protected]>
  • Loading branch information
rimaburder-index and muuki88 authored Dec 20, 2023
1 parent 63d4582 commit 4c1457c
Showing 1 changed file with 3 additions and 50 deletions.
53 changes: 3 additions & 50 deletions dev-docs/bidders/ix.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: bidder
title: Index Exchange (Prebid.js)
title: Index Exchange
description: Prebid Index Exchange Bidder Adapter
biddercode: ix
pbjs: true
Expand Down Expand Up @@ -94,54 +94,7 @@ The following table lists the media types that Index supports. For information a

## Set up Prebid.js to call Index directly from the browser (client-side adapter)

In this configuration Prebid.js calls Index directly from the browser using our client-side adapter. Follow the quick start instructions provided in Prebid's [Getting Started for Developers](/dev-docs/getting-started.html) documentation. Complete the following steps to complete the Index-specific configuration:

1. Build the binary in one of the following ways:
* [Download Prebid.js](https://docs.prebid.org/download.html) from the Prebid site to use the standard compiled binary that Prebid includes in the download process and select **Index Exchange** as an adapter.
* Build it on your own from the source code by following the instructions in [Prebid.js project README](https://github.com/prebid/Prebid.js/blob/master/README.md#build-optimization). If you use this method, you will need to include several modules in your build process. See the [Index modules to include in your build process](#modules-to-include-in-your-build-process) section below.
2. Define the Index-specific parameters at the bidder level which include adding `ix` as the bidder and the `siteId`. For Index's bidder-specific parameters, see the [Bid request parameters](#bid-request-parameters) section below.

```javascript
{
bidder: 'ix',
params: {
siteId: '123456'
}
}
```

3. Define your ad units in the `adUnit` object. This includes the details about the ad slots such as the media types, ad size, and ad code. For more information about this object, see Prebid's [Ad Unit Reference](/dev-docs/adunit-reference.html) documentation.
4. Enable user syncing by adding the following code in the [pbjs.setConfig()](/dev-docs/publisher-api-reference/setConfig.html) function. Index strongly recommends enabling user syncing through iFrames, though we do also support image-based syncing. This functionality improves DSP user match rates and increases the Index bid rate and bid price. Make sure to call `pbjs.setConfig()` only once. This configuration is optional in Prebid, but required by Index.
```javascript
pbjs.setConfig({
userSync: {
iframeEnabled: true,
filterSettings: {
iframe: {
bidders: ['ix'],
filter: 'include'
}
}
}
});
```
5. (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the [Set up First Party Data (FPD)](#set-up-first-party-data-fpd) section below.
6. (Optional) If you want to monetize instream video, you need to enable a cache endpoint in the [pbjs.setConfig()](/dev-docs/publisher-api-reference/setConfig.html) function as follows: <br />
```javascript
pbjs.setConfig({
cache: {
url: 'https://prebid.adnxs.com/pbc/v1/cache'
}
});
```

7. (Optional) If you want to monetize outstream video, you can choose among the following options:
* Use Index's outstream video player. For more information, see the [Index's outstream video player](#index-outstream-video-player)section below.
* Use your own outstream video player. For more information, see [Prebid's documentation on how to show video ads.](https://docs.prebid.org/dev-docs/show-outstream-video-ads.html)
8. (Optional) Configure Prebid Native with Index. For more information, see the [Prebid Native](#prebid-native-configuration) section below. Prebid Native is available from Prebid.js version 7.4.0 or higher.
To call Index from a web browser environment using a Prebid Server integration, see the Index-specific configuration steps in [Setup instructions to call Index through Prebid Server](/dev-docs/bidders/ix-server.html#setup-instructions-to-call-index-through-prebid-server) in our Prebid Server documentation on the Prebid site.

<a id="server-side-adapter"></a>

Expand Down Expand Up @@ -280,7 +233,7 @@ To use Index’s outstream ad unit, in your Prebid.js configuration:<br />
1. Perform the following steps in your Prebid.js configuration to create a new section for Index's outstream ad unit:
* Add a new code property under `adUnits`. The code could be the `divID` or the Google Ad Manager adUnit code.
* Within the `adUnits`, add `ix` as a `bidder`.
* (Recommended) At the `adUnit` level, under `mediaTypes`, add a `video` object that supports our required video parameters. For more information about which parameters to add, see the [Bid request parameters](#video) section below. This is useful for publishers who want to apply the same settings across all SSPs.
* At the `adUnit` level, under `mediaTypes`, you must add a `video` object that supports our required video parameters. For more information about which parameters to add, see the [Bid request parameters](#video) section below. This is useful for publishers who want to apply the same settings across all SSPs.
* Optionally, you can add the `video` object at the bidder level under `bids.params`. This is useful for publishers who may want to set up different configurations for different SSPs. <br />
**Note:** The `bidder` level video configurations override the `adUnit` level configurations. The `playerConfig` is only a bidder level configuration.
2. (Recommended) To force the Index ad unit as the default player for Index, set `backupOnly` to true (see below example). This configuration allows you to use your own player only when an adapter does not provide their own player. This also forces any adapter that has a player to use their player by default. If no player is provided, by default, we will use our own ad unit script.
Expand Down

0 comments on commit 4c1457c

Please sign in to comment.