From 5e321fc9564879cdfe02571a27d7547d50413788 Mon Sep 17 00:00:00 2001 From: Tiago Peczenyj Date: Wed, 17 Nov 2021 17:21:59 +0100 Subject: [PATCH] update doc --- dev-docs/modules/weboramaRtdProvider.md | 32 +++++++++++++++++++++---- 1 file changed, 27 insertions(+), 5 deletions(-) diff --git a/dev-docs/modules/weboramaRtdProvider.md b/dev-docs/modules/weboramaRtdProvider.md index 9fc5ec5e10..499f033e36 100644 --- a/dev-docs/modules/weboramaRtdProvider.md +++ b/dev-docs/modules/weboramaRtdProvider.md @@ -37,6 +37,7 @@ Add the Weborama RTD provider to your Prebid config. #### Minimal configuration ``` +javascript pbjs.setConfig( ... realTimeData: { @@ -46,9 +47,25 @@ pbjs.setConfig( name: "weborama", waitForIt: true, params: { - weboCtxConf: { - token: "" - } + weboCtxConf: { // contextual configuration + token: "<>", // 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 + } } } ] @@ -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