Skip to content

Commit e2d6f12

Browse files
authored
Add bid parameters for Contxtful bid adapter and document Prebid Server support (#6181)
* Update contxtful.md to enable PBS support * Add bid parameters section to Contxtful documentation * Remove unnecessary blank line in Contxtful documentation * Update Contxtful documentation to clarify required parameters * chore: make customerId required * docs: add config section * docs: add section First Party Data * docs: add AdUnit Format client side * docs: add missing line break in First Party Data section of Contxtful documentation * docs: update User Sync section in Contxtful documentation to clarify bidder filter settings * docs: document "all" * docs: remove redundant blank line in Contxtful documentation
1 parent 5125ae4 commit e2d6f12

File tree

1 file changed

+77
-3
lines changed

1 file changed

+77
-3
lines changed

dev-docs/bidders/contxtful.md

Lines changed: 77 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ safeframes_ok: true
1313
floors_supported: true
1414
fpd_supported: true
1515
pbjs: true
16-
pbs: false
16+
pbs: true
1717
pbs_app_supported: false
1818
prebid_member: true
1919
multiformar_supported: will-bid-on-any
@@ -24,8 +24,80 @@ ortb_blocking_supported: true
2424

2525
The Contxtful bidder adapter requires some setup. Contact us at [contact@contxtful.com](mailto:contact@contxtful.com)
2626

27+
### Bid Params
28+
29+
{: .table .table-bordered .table-striped }
30+
| Name | Scope | Description | Example | Type |
31+
|-------------|----------|------------------------------------------------------------|------------------------------|----------------------|
32+
| `placementId` | required | The placement identifier | `'p12345678'` | `string` |
33+
| `customerId` | required | The customer identifier | `'DEMO123456'` | `string` |
34+
35+
### Configuration
36+
37+
```javascript
38+
pbjs.setConfig({
39+
"contxtful":{
40+
"version":"v1",
41+
"customer":"<<CUSTOMER_ID_HERE>>"
42+
},
43+
"realTimeData":{
44+
"dataProviders":[
45+
{
46+
"name":"contxtful",
47+
"waitForIt":true,
48+
"params":{
49+
"version":"v1",
50+
"customer":"<<CUSTOMER_ID_HERE>>",
51+
"bidders":[
52+
"contxtful"
53+
],
54+
"adServerTargeting":true
55+
}
56+
}
57+
]
58+
}
59+
}
60+
);
61+
```
62+
63+
### First Party Data
64+
65+
Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:
66+
67+
- `ortb2.site.*`
68+
- `ortb2.user.*`
69+
- `ortb2.device.*`
70+
71+
AdUnit-specific data is supported using `AdUnit.ortb2Imp.ext.*`
72+
73+
### AdUnit Format client side
74+
75+
```javascript
76+
var adUnitList = [
77+
{
78+
code: 'AD_UNIT_NAME_HERE',
79+
mediaTypes: { /* "<< ENTER_FORMAT_HERE >> */ },
80+
bids: [{
81+
bidder: 'contxtful',
82+
params: {
83+
placementId: "<<PLACEMENT_ID_HERE>>",
84+
customerId: "<<CUSTOMER_ID_HERE>>"
85+
}
86+
}],
87+
ortb2Imp: {
88+
ext: {
89+
data: {
90+
divId: "<<EACH_AD_UNIT_DIV_ID>>"
91+
}
92+
}
93+
}
94+
}
95+
]
96+
```
97+
2798
### User Sync
28-
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.
99+
100+
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.
29101

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

@@ -35,7 +107,7 @@ pbjs.setConfig({
35107
userSync: {
36108
filterSettings: {
37109
iframe: {
38-
bidders: ['contxtful'],
110+
bidders: '*', // '*' means all bidders
39111
filter: 'include'
40112
}
41113
}
@@ -49,3 +121,5 @@ pbjs.bidderSettings = {
49121
}
50122
}
51123
```
124+
125+
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.

0 commit comments

Comments
 (0)