From 8bb1edceb685f49ff3a9f273f2e9560788fe1bf0 Mon Sep 17 00:00:00 2001 From: TheMediaGrid <44166371+TheMediaGrid@users.noreply.github.com> Date: Fri, 17 Jun 2022 20:40:36 +0300 Subject: [PATCH] TrustX: make trustx as alias of gridBidAdapter (#3727) * Added doc file for Grid Bid Adapter * update doc for TheMediaGrid Bid Adapter * Added video support in Grid doc file * removing unnecessary front matter * Update doc file for TheMediaGrid Bid Adapter * Added doc file for TheMediaGridNM Bid Adapter * Update doc file for TheMediaGrid Bid Adapter * Update doc file for The Media Grid Bid Adapter * Update THeMediaGrid doc to support TCF 2.0 * Update doc for TheMediaGrid Bid Adapter * Update doc file for TheMediaGrid Bid Adapter * Update doc for TheMediaGrid Bid Adapter * Update TheMediaGrid doc to support coppa * Update GridNM Bid Adapter doc file * TheMediaGrid: update doc * Added alias playewire for TheMediaGrid Bid Adapter * Added some description in TheMediaGrid doc * Added alias adlivetech for TheMediaGrid Bid Adapter * TheMediaGrid: update doc * TheMediaGrid: update docs for gridNM, grid and aliases to support FPD * TrustX: update doc to support FPD * TrustX: make trustx as alias of gridBidAdapter * TheMediaGrid: update doc - multiformat_supported flag added * TrustX: update doc Co-authored-by: bretg --- dev-docs/bidders/adlivetech.md | 43 +++++++++++++ dev-docs/bidders/grid.md | 55 +++++++++++++++- dev-docs/bidders/gridNM.md | 6 ++ dev-docs/bidders/playwire.md | 43 +++++++++++++ dev-docs/bidders/trustx.md | 96 ++++++++++++++++++++++++++-- dev-docs/bidders/trustxstandalone.md | 48 ++++++++++++++ 6 files changed, 284 insertions(+), 7 deletions(-) create mode 100644 dev-docs/bidders/trustxstandalone.md diff --git a/dev-docs/bidders/adlivetech.md b/dev-docs/bidders/adlivetech.md index 5d4a40b8c2..74398ac2e0 100644 --- a/dev-docs/bidders/adlivetech.md +++ b/dev-docs/bidders/adlivetech.md @@ -16,6 +16,13 @@ coppa_supported: true fpd_supported: true --- +### Table of Contents + +- [Bid Params](#adlivetech-bid-params) +- [Bidder Config](#adlivetech-bidder-config) +- [First Party Data](#adlivetech-first-party) + + ### Bid Params @@ -25,3 +32,39 @@ fpd_supported: true | `uid` | required | Represents the Adlivetech bidder system Ad Slot ID associated with the respective div id from the site page. | `1` | `integer` | | `keywords` | optional | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | | `bidFloor` | optional | Floor of the impression opportunity. If present in the request overrides XML info. | `0.8` | `float` | + + + +### Bidder Config + +You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `adlivetech` +``` +pbjs.setBidderConfig({ + bidders: ["adlivetech"], + config: { + localStorageWriteAllowed: true + } +}) +``` +If it will be "true" this allow Adlivetech Bid Adapter to write userId in first party localStorage + + + +### First Party Data + +Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). + +Global site or user data using `setConfig()`, or Bidder-specific using `setBidderConfig()` supports following fields: + +- `ortb2.user.data[]`: Standard IAB segment taxonomy user data +- `ortb2.user.ext.device`: Non standard arbitrary user device +- `ortb2.user.keywords`: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2 +- `ortb2.site.keywords`: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2 +- `ortb2.site.cat[]`: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array +- `ortb2.site.pagecat[]`: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array +- `ortb2.site.content.genre`: Standard IAB OpenRTB 2.5 site.content.genre field + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` +- `ortb2.imp[].instl` diff --git a/dev-docs/bidders/grid.md b/dev-docs/bidders/grid.md index 1f6a3db4ff..acaee18643 100644 --- a/dev-docs/bidders/grid.md +++ b/dev-docs/bidders/grid.md @@ -6,6 +6,7 @@ pbjs: true pbs: true biddercode: grid media_types: banner, video +multiformat_supported: will-bid-on-any gdpr_supported: true usp_supported: true schain_supported: true @@ -16,6 +17,13 @@ coppa_supported: true fpd_supported: true --- +### Table of Contents + +- [Bid Params](#grid-bid-params) +- [Bidder Config](#grid-bidder-config) +- [First Party Data](#grid-first-party) + + ### Bid Params @@ -26,8 +34,32 @@ fpd_supported: true | `keywords` | optional | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | | `bidFloor` | optional | Floor of the impression opportunity. If present in the request overrides XML info. | `0.8` | `float` | +Parameter `keywords` must have following format: +``` +{ + "site":{ + "publisher1":[ + { + "name":"SomeKeywordsBlockName", + "segment1Name":[ + "segment2Value" + ], + "segment2Name":[ + "segment2Value1", + "segment2Value2", + ... + ], + ... + } + ], + ... + } +} +``` + + -###Bidder Config +### Bidder Config You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `grid` ``` @@ -39,3 +71,24 @@ pbjs.setBidderConfig({ }) ``` If it will be "true" this allow TheMediaGrid Bid Adapter to write userId in first party localStorage + + + +### First Party Data + +Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). + +Global site or user data using `setConfig()`, or Bidder-specific using `setBidderConfig()` supports following fields: + +- `ortb2.user.data[]`: Standard IAB segment taxonomy user data +- `ortb2.user.ext.device`: Non standard arbitrary user device +- `ortb2.user.keywords`: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2 +- `ortb2.site.keywords`: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2 +- `ortb2.site.cat[]`: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array +- `ortb2.site.pagecat[]`: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array +- `ortb2.site.content.genre`: Standard IAB OpenRTB 2.5 site.content.genre field + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` +- `ortb2.imp[].instl` diff --git a/dev-docs/bidders/gridNM.md b/dev-docs/bidders/gridNM.md index fc92e91a17..ba1c7c1d2f 100644 --- a/dev-docs/bidders/gridNM.md +++ b/dev-docs/bidders/gridNM.md @@ -35,3 +35,9 @@ fpd_supported: true | `video.startdelay` | optional | Indicates the start delay in seconds | `0` | `int` | | `video.placement` | optional | Placement type for the impression. | `1` | `int` | | `video.playbackmethod` | optional | Playback methods that may be in use | `[1]` | `integer array` | + +### First Party Data + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` diff --git a/dev-docs/bidders/playwire.md b/dev-docs/bidders/playwire.md index 4d0f9a4ead..e1983cbc86 100644 --- a/dev-docs/bidders/playwire.md +++ b/dev-docs/bidders/playwire.md @@ -17,6 +17,13 @@ fpd_supported: true prebid_member: true --- +### Table of Contents + +- [Bid Params](#playwire-bid-params) +- [Bidder Config](#playwire-bidder-config) +- [First Party Data](#playwire-first-party) + + ### Bid Params @@ -26,3 +33,39 @@ prebid_member: true | `uid` | required | Represents the Playwire bidder system Ad Slot ID associated with the respective div id from the site page. | `1` | `integer` | | `keywords` | optional | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | | `bidFloor` | optional | Floor of the impression opportunity. If present in the request overrides XML info. | `0.8` | `float` | + + + +### Bidder Config + +You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `playwire` +``` +pbjs.setBidderConfig({ + bidders: ["playwire"], + config: { + localStorageWriteAllowed: true + } +}) +``` +If it will be "true" this allow Playwire Bid Adapter to write userId in first party localStorage + + + +### First Party Data + +Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). + +Global site or user data using `setConfig()`, or Bidder-specific using `setBidderConfig()` supports following fields: + +- `ortb2.user.data[]`: Standard IAB segment taxonomy user data +- `ortb2.user.ext.device`: Non standard arbitrary user device +- `ortb2.user.keywords`: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2 +- `ortb2.site.keywords`: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2 +- `ortb2.site.cat[]`: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array +- `ortb2.site.pagecat[]`: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array +- `ortb2.site.content.genre`: Standard IAB OpenRTB 2.5 site.content.genre field + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` +- `ortb2.imp[].instl` diff --git a/dev-docs/bidders/trustx.md b/dev-docs/bidders/trustx.md index 7f530c9f1a..d3dafe9f37 100644 --- a/dev-docs/bidders/trustx.md +++ b/dev-docs/bidders/trustx.md @@ -5,18 +5,102 @@ description: Prebid TrustX Bidder Adaptor pbjs: true pbs: true biddercode: trustx +aliasCode: grid media_types: banner, video +multiformat_supported: will-bid-on-any gdpr_supported: true usp_supported: true +schain_supported: true +floors_supported: true +userIds: all +tcf2_supported: true +coppa_supported: true +fpd_supported: true +pbjs_version_notes: 7.0 and after --- +### Table of Contents + +- [Bid Params](#trustx-bid-params) +- [Bidder Config](#trustx-bidder-config) +- [First Party Data](#trustx-first-party) + + ### Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|-----------| -| `uid` | required | Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. | `42` | `integer` | -| `priceType` | optional (pbjs only) | Can take the values `gross` or `net`, default value is `net`. Net represents the header bid price with the TrustX header bidder margin already extracted. Gross price does contain the TrustX bidder margin within. | `'gross'` | `string` | -| `keywords` | optional (pbjs only) | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | -| `useNewFormat` | optional (pbjs only) | Indicates to use the new ad request format. | `true` | `boolean` | +| Name | Scope | Description | Example | Type | +|----------------|-----------|----------------------------------------------------------------------------------------------------------|-------------------------------------------|-----------| +| `uid` | required | Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. | `42` | `integer` | +| `keywords` | optional | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | +| `bidFloor` | optional | Floor of the impression opportunity. If present in the request overrides XML info. | `0.8` | `float` | + +Parameter `keywords` must have following format: +``` +{ + "site":{ + "publisher1":[ + { + "name":"SomeKeywordsBlockName", + "segment1Name":[ + "segment2Value" + ], + "segment2Name":[ + "segment2Value1", + "segment2Value2", + ... + ], + ... + } + ], + ... + } +} +``` + + + +### Bidder Config + +You can allow writing in localStorage `pbjs.setBidderConfig` for the bidder `trustx` +``` +pbjs.setBidderConfig({ + bidders: ["trustx"], + config: { + localStorageWriteAllowed: true + } +}) +``` +If it will be "true" this allow TheMediaGrid Bid Adapter to write userId in first party localStorage + +If you want to make alias on TrustX Bid Adapter, you must set `forceBidderName` in bidderConfig as `"trustx"`. +``` +pbjs.setBidderConfig({ + bidders: ["aliasName"], + config: { + forceBidderName: 'trustx' + } +}) +``` + + + +### First Party Data + +Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). + +Global site or user data using `setConfig()`, or Bidder-specific using `setBidderConfig()` supports following fields: + +- `ortb2.user.data[]`: Standard IAB segment taxonomy user data +- `ortb2.user.ext.device`: Non standard arbitrary user device +- `ortb2.user.keywords`: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2 +- `ortb2.site.keywords`: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2 +- `ortb2.site.cat[]`: Standard IAB OpenRTB 2.5 site.cat field. It will be sent as part of site.cat array +- `ortb2.site.pagecat[]`: Standard IAB OpenRTB 2.5 site.pagecat field. It will be sent as part of site.cat array +- `ortb2.site.content.genre`: Standard IAB OpenRTB 2.5 site.content.genre field + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` +- `ortb2.imp[].instl` diff --git a/dev-docs/bidders/trustxstandalone.md b/dev-docs/bidders/trustxstandalone.md new file mode 100644 index 0000000000..1eca1bd86b --- /dev/null +++ b/dev-docs/bidders/trustxstandalone.md @@ -0,0 +1,48 @@ +--- +layout: bidder +title: TrustX (standalone) +description: Prebid TrustX Bidder Adaptor +pbjs: true +pbs: true +biddercode: trustx +media_types: banner, video +multiformat_supported: will-bid-on-any +gdpr_supported: true +usp_supported: true +fpd_supported: true +pbjs_version_notes: 6.x and before +--- + +### Table of Contents + +- [Bid Params](#trustx-bid-params) +- [First Party Data](#trustx-first-party) + + + +### Bid Params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|----------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|-----------| +| `uid` | required | Represents the TrustX bidder system Ad Slot ID associated with the respective div id from the site page. | `42` | `integer` | +| `priceType` | optional (pbjs only) | Can take the values `gross` or `net`, default value is `net`. Net represents the header bid price with the TrustX header bidder margin already extracted. Gross price does contain the TrustX bidder margin within. | `'gross'` | `string` | +| `keywords` | optional (pbjs only) | A set of key-value pairs applied to all ad slots on the page. Values can be empty. | `keywords: { topic: ['stress', 'fear'] }` | `object` | +| `useNewFormat` | optional (pbjs only) | Indicates to use the new ad request format. | `true` | `boolean` | + + + +### First Party Data + +Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). + +Global site or user data using `setConfig()`, or Bidder-specific using `setBidderConfig()` supports following fields: + +- `ortb2.user.data[]`: Standard IAB segment taxonomy user data +- `ortb2.user.keywords`: Standard IAB OpenRTB 2.5 user.keywords field. It will be included in ext.keywords.user.ortb2 +- `ortb2.site.keywords`: Standard IAB OpenRTB 2.5 site.keywords field. It will be included in ext.keywords.site.ortb2 + +AdUnit-specific data using `AdUnit.ortb2Imp` supports following fields: + +- `ortb2.imp[].ext.data.*` +- `ortb2.imp[].instl`