Skip to content

Add bid parameters for Contxtful bid adapter and document Prebid Server support #6181

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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open
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
80 changes: 77 additions & 3 deletions dev-docs/bidders/contxtful.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ safeframes_ok: true
floors_supported: true
fpd_supported: true
pbjs: true
pbs: false
pbs: true
pbs_app_supported: false
prebid_member: true
multiformar_supported: will-bid-on-any
Expand All @@ -24,8 +24,80 @@ ortb_blocking_supported: true

The Contxtful bidder adapter requires some setup. Contact us at [[email protected]](mailto:[email protected])

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|------------------------------------------------------------|------------------------------|----------------------|
| `placementId` | required | The placement identifier | `'p12345678'` | `string` |
| `customerId` | required | The customer identifier | `'DEMO123456'` | `string` |

### Configuration

```javascript
pbjs.setConfig({
"contxtful":{
"version":"v1",
"customer":"<<CUSTOMER_ID_HERE>>"
},
"realTimeData":{
"dataProviders":[
{
"name":"contxtful",
"waitForIt":true,
"params":{
"version":"v1",
"customer":"<<CUSTOMER_ID_HERE>>",
"bidders":[
"contxtful"
],
"adServerTargeting":true
}
}
]
}
}
);
```

### First Party Data

Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:

- `ortb2.site.*`
- `ortb2.user.*`
- `ortb2.device.*`

AdUnit-specific data is supported using `AdUnit.ortb2Imp.ext.*`

### AdUnit Format client side

```javascript
var adUnitList = [
{
code: 'AD_UNIT_NAME_HERE',
mediaTypes: { /* "<< ENTER_FORMAT_HERE >> */ },
bids: [{
bidder: 'contxtful',
params: {
placementId: "<<PLACEMENT_ID_HERE>>",
customerId: "<<CUSTOMER_ID_HERE>>"
}
}],
ortb2Imp: {
ext: {
data: {
divId: "<<EACH_AD_UNIT_DIV_ID>>"
}
}
}
}
]
```

### User Sync
Contxtful recommends enabling [User Syncing](https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing) to optimize match rate and monetization.

Contxtful recommends enabling [User Syncing](https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig#setConfig-Configure-User-Syncing) to optimize match rate and monetization.

{% include dev-docs/storageAllowed.md %}

Expand All @@ -35,7 +107,7 @@ pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: ['contxtful'],
bidders: '*', // '*' means all bidders
filter: 'include'
}
}
Expand All @@ -49,3 +121,5 @@ pbjs.bidderSettings = {
}
}
```

Note - the `userSync.filterSettings.all` field is mutually exclusive and cannot be combined with the `userSync.filterSettings.iframe`/`userSync.filterSettings.image` fields in the `userSync` config. If the fields are used together, this will be considered an invalid config and only image pixels will be permitted.