You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
|`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
+
27
98
### 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.
29
101
30
102
{% include dev-docs/storageAllowed.md %}
31
103
@@ -35,7 +107,7 @@ pbjs.setConfig({
35
107
userSync: {
36
108
filterSettings: {
37
109
iframe: {
38
-
bidders:['contxtful'],
110
+
bidders:'*', // '*' means all bidders
39
111
filter:'include'
40
112
}
41
113
}
@@ -49,3 +121,5 @@ pbjs.bidderSettings = {
49
121
}
50
122
}
51
123
```
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