Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IX Bid Adapter: Documentation for Native Support #3831

Merged
merged 2 commits into from
Jun 30, 2022
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
53 changes: 50 additions & 3 deletions dev-docs/bidders/ix.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ coppa_supported: true
gdpr_supported: true
floors_supported: true
usp_supported: true
media_types: banner, video
media_types: banner, video, native
fpd_supported: true
gvl_id: 10
prebid_member: yes
Expand Down Expand Up @@ -63,7 +63,7 @@ var adUnits = [{
|---|---|
| `banner` | Fully supported for all IX approved sizes |
| `video` | Fully supported for all IX approved sizes |
| `native` | Not supported |
| `native` | Supported |

### Supported Media Types (Prebid Server)

Expand Down Expand Up @@ -108,6 +108,9 @@ In Prebid.js versions 5.0 and above, mediaType and sizes are not required to be
| `video.maxduration` | Required | Integer | Maximum video ad duration in seconds.|
| `video.protocol` / `video.protocols` | Required | Integer / Integer[] | Either a single protocol provided as an integer, or protocols provided as a list of integers. `2` - VAST 2.0, `3` - VAST 3.0, `5` - VAST 2.0 Wrapper, `6` - VAST 3.0 Wrapper|

### Native
Index supports the native assets that Prebid.js recognizes. For the list of native assets, see [Prebid.js Native Implementation Guide on the Prebid site.](https://docs.prebid.org/prebid/native-implementation.html#3-prebidjs-native-adunit-overview)

## Setup Guide

Follow these steps to configure and add the IX module to your Prebid.js
Expand Down Expand Up @@ -274,6 +277,50 @@ pbjs.setConfig({
});
```

#### Native
We support the three native template rendering options that are provided in the [Setting up Prebid Native in Google Ad Manager](https://docs.prebid.org/adops/gam-native.html). The following code is an example of a Prebid native set up using Google Ad Manager, but the concept and implementation should be similar for other ad servers.

```
pbjs.addAdUnits({
code: slot.code,
mediaTypes: {
native: {
image: {
required: true,
sizes: [150, 50]
},
title: {
required: true,
len: 80
},
sponsoredBy: {
required: true
},
clickUrl: {
required: true
},
privacyLink: {
required: false
},
body: {
required: true
len: 90
},
icon: {
required: true,
sizes: [50, 50]
}
}
},
bids: [{
bidder: 'ix',
params: {
siteId: '715966'
}
}]
});
```

#### User Sync
Add the following code to enable user sync. IX strongly recommends enabling user syncing through iFrames. This functionality improves DSP user match rates and increases the IX bid rate and bid price. Be sure to call `pbjs.setConfig()` only once.

Expand Down Expand Up @@ -462,7 +509,7 @@ to `'ix'` across all ad units that bids are being requested for does not exceed

### Time-To-Live (TTL)

Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of 3 hours, after which time they become invalid.
Banner bids from Index have a TTL of 600 seconds while video bids have a TTL of 3 hours, after which time they become invalid.</br>
**Note:** Index supports the `bid.exp` attribute in the bid response which allows our adapter to specify the maximum number of seconds allowed between the auction and billing notice. In the absence of the `bid.exp` attribute, the TTL provided above applies.

## FAQs
Expand Down