Skip to content

update weborama RTD submodule doc to reflect latest feature update #3415

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.

Sign up for GitHub

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

Merged
fowler446 merged 1 commit into from
Jan 6, 2022
Merged

update weborama RTD submodule doc to reflect latest feature update #3415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 27 additions & 5 deletions dev-docs/modules/weboramaRtdProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Add the Weborama RTD provider to your Prebid config.
#### Minimal configuration

```
javascript
pbjs.setConfig(
...
realTimeData: {
Expand All @@ -46,9 +47,25 @@ pbjs.setConfig(
name: "weborama",
waitForIt: true,
params: {
weboCtxConf: {
token: "<token-provided-by-weborama>"
}
weboCtxConf: { // contextual configuration
token: "<<provided by weborama>>", // mandatory
targetURL: "...", // default is document.URL
setPrebidTargeting: true, // default
sendToBidders: true, // default
defaultProfile: { // optional, default is none
webo_ctx: ['foo'],
webo_ds: ['bar']
}
},
weboUserDataConf: { // user-centric configuration
setPrebidTargeting: true, // default
sendToBidders: true, // default
defaultProfile: { // optional, default is none
webo_cs: ['baz'],
webo_audiences: ['bam']
},
localStorageProfileKey: 'webo_wam2gam_entry' // default
}
}
}
]
Expand All @@ -67,9 +84,14 @@ pbjs.setConfig(
| params.weboCtxConf | Object | Weborama Contextual Configuration | Optional |
| params.weboCtxConf.token | String | Security Token provided by Weborama, unique per client | Mandatory |
| params.weboCtxConf.targetURL | String | Url to be profiled in the contextual api | Optional. Defaults to `document.URL` |
| params.weboCtxConf.setPrebidTargeting|Boolean|If true, will use the contextual profile to set the prebid (GPT/GAM or AST) targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
| params.weboCtxConf.sendToBidders|Boolean|If true, will send the contextual profile to all bidders (only smartadserver is supported now)| Optional. Default is *true*.|
| params.weboCtxConf.defaultProfile | Object | default value of the profile to be used when there are no response from contextual api (such as timeout)| Optional. Default is `{}` |
| params.weboCtxConf.setTargeting|Boolean|If true, will use the contextual profile to set the gam targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
| params.weboCtxConf.setOrtb2|Boolean|If true, will use the contextual profile to set the ortb2 configuration on `site.ext.data`| Optional. Default is *false*.|
| params.weboUserDataConf | Object | WeboUserData Configuration | Optional |
| params.weboUserDataConf.setPrebidTargeting|Boolean|If true, will use the contextual profile to set the prebid (GPT/GAM or AST) targeting of all adunits managed by prebid.js| Optional. Default is *true*.|
| params.weboUserDataConf.sendToBidders|Boolean|If true, will send the contextual profile to all bidders (only smartadserver is supported now)| Optional. Default is *true*.|
| params.weboUserDataConf.defaultProfile | Object | default value of the profile to be used when there are no response from contextual api (such as timeout)| Optional. Default is `{}` |
| params.weboUserDataConf.localStorageProfileKey| String | can be used to customize the local storage key | Optional |


### Testing
Expand Down