Merge branch 'master' into add-rediads-bid-adapter

prebid · Dec 17, 2024 · e0dd58e · e0dd58e
2 parents c4d3121 + c2a5b31
commit e0dd58e
Show file tree

Hide file tree

Showing 14 changed files with 576 additions and 41 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,6 +4,8 @@ Please give a short description and check the matching checkboxes to help us rev
 
 Please make the PR writeable. This allows us to fix typos, grammar and linting errors ourselves, which makes
 merging and reviewing a lot faster for everybody.
+
+⚠️ The documentation is merged after the related code changes are merged and release ⚠️
 -->
 
 ## 🏷 Type of documentation

diff --git a/dev-docs/bidders/adport.md b/dev-docs/bidders/adport.md
@@ -0,0 +1,115 @@
+---
+layout: bidder
+title: AdPort
+description: Prebid AdPort Bidder Adapter
+aliasCode: adverxo
+pbjs: true
+pbs: false
+pbs_app_supported: false
+biddercode: adport
+userIds:
+media_types: banner, native, video
+schain_supported: true
+dchain_supported: false
+ortb_blocking_supported: true
+floors_supported: true
+multiformat_supported: will-bid-on-any
+tcfeu_supported: false
+dsa_supported: false
+gvl_id: none
+usp_supported: false
+coppa_supported: false
+gpp_sids: none
+userId: no
+safeframes_ok: false
+deals_supported: true
+fpd_supported: true
+prebid_member: false
+privacy_sandbox: no
+sidebarType: 1
+---
+
+### Note
+
+The AdPort Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
+more details.
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+| Name | Scope | Description | Example | Type |
+|----------|----------|-----------------------|---------------------------|----------|
+| `adUnitId`   | required | Unique identifier for the ad unit in AdPort platform. | `1` | `integer` |
+| `auth`       | required | Authentication token provided by AdPort platform for the AdUnit. |`'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |
+
+### Setting First Party Data (FPD)
+
+Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:
+
+- ortb2.site.\*
+- ortb2.app.\*
+- ortb2.user.\*
+
+Example first party data:
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        site: {
+            keywords: "kw1,kw2",
+            content: {
+                title: "title1",
+                series: "series1"
+            }
+        },
+        user: {
+            keywords: "a,b",
+            gender: "M",
+            yob: 1984
+        }
+    }
+});
+```
+
+### ORTB Blocking
+
+AdPort supports the next blocking parameters:
+
+- Blocked advertisers list (`badv`) is an array of domains as strings.
+- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
+  bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
+- Blocked categories list (`bcat`) is an array of IAB categories as strings.
+- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
+  attributes.
+
+#### Globally defined ORTB Blocking
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        badv: ["domain1.com", "domain2.com"],
+        bapp: ["com.foo.mygame", "284708449"],
+        bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+    }
+});
+```
+
+#### ORTB Blocking specific only to the AdPort bidder
+
+```javascript
+pbjs.setBidderConfig({
+    bidders: ['adport'], // Or alias
+    config: {
+        ortb2: {
+            badv: ["domain1.com", "domain2.com"],
+            bapp: ["com.foo.mygame"],
+            bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+        }
+    }
+});
+```
+
+#### Media Type defined ORTB Blocking
+
+Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
+attributes. Refer to section 5.3 of the IAB specification for a list of attributes.
diff --git a/dev-docs/bidders/adverxo.md b/dev-docs/bidders/adverxo.md
@@ -0,0 +1,115 @@
+---
+layout: bidder
+title: Adverxo
+description: Prebid Adverxo Bidder Adapter
+pbjs: true
+pbs: true
+pbs_app_supported: true
+biddercode: adverxo
+userIds:
+media_types: banner, native, video
+schain_supported: true
+dchain_supported: false
+ortb_blocking_supported: true
+floors_supported: true
+multiformat_supported: will-bid-on-any
+tcfeu_supported: false
+dsa_supported: false
+gvl_id: none
+usp_supported: false
+coppa_supported: false
+gpp_sids: none
+userId: no
+safeframes_ok: false
+deals_supported: true
+fpd_supported: true
+prebid_member: false
+privacy_sandbox: no
+sidebarType: 1
+---
+
+### Note
+
+The Adverxo Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
+more details.
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+| Name | Scope | Description | Example | Type |
+|----------|----------|-----------------------|---------------------------|----------|
+| `host`   | optional | Ad network host | `'js.pbsadverxo.com'` | `string` |
+| `adUnitId`   | required | Unique identifier for the ad unit in Adverxo platform. | `1` | `integer` |
+| `auth`       | required | Authentication token provided by Adverxo platform for the AdUnit. | `'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |
+
+### Setting First Party Data (FPD)
+
+Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:
+
+- ortb2.site.\*
+- ortb2.app.\*
+- ortb2.user.\*
+
+Example first party data:
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        site: {
+            keywords: "kw1,kw2",
+            content: {
+                title: "title1",
+                series: "series1"
+            }
+        },
+        user: {
+            keywords: "a,b",
+            gender: "M",
+            yob: 1984
+        }
+    }
+});
+```
+
+### ORTB Blocking
+
+Adverxo supports the next blocking parameters:
+
+- Blocked advertisers list (`badv`) is an array of domains as strings.
+- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
+  bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
+- Blocked categories list (`bcat`) is an array of IAB categories as strings.
+- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
+  attributes.
+
+#### Globally defined ORTB Blocking
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        badv: ["domain1.com", "domain2.com"],
+        bapp: ["com.foo.mygame", "284708449"],
+        bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+    }
+});
+```
+
+#### ORTB Blocking specific only to the Adverxo bidder
+
+```javascript
+pbjs.setBidderConfig({
+    bidders: ['adverxo'], // Or alias
+    config: {
+        ortb2: {
+            badv: ["domain1.com", "domain2.com"],
+            bapp: ["com.foo.mygame"],
+            bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+        }
+    }
+});
+```
+
+#### Media Type defined ORTB Blocking
+
+Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
+attributes. Refer to section 5.3 of the IAB specification for a list of attributes.
diff --git a/dev-docs/bidders/bidsmind.md b/dev-docs/bidders/bidsmind.md
@@ -0,0 +1,115 @@
+---
+layout: bidder
+title: Bidsmind
+description: Prebid Bidsmind Bidder Adapter
+aliasCode: adverxo
+pbjs: true
+pbs: false
+pbs_app_supported: false
+biddercode: bidsmind
+userIds:
+media_types: banner, native, video
+schain_supported: true
+dchain_supported: false
+ortb_blocking_supported: true
+floors_supported: true
+multiformat_supported: will-bid-on-any
+tcfeu_supported: false
+dsa_supported: false
+gvl_id: none
+usp_supported: false
+coppa_supported: false
+gpp_sids: none
+userId: no
+safeframes_ok: false
+deals_supported: true
+fpd_supported: true
+prebid_member: false
+privacy_sandbox: no
+sidebarType: 1
+---
+
+### Note
+
+The Bidsmind Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
+more details.
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+| Name | Scope | Description | Example | Type |
+|----------|----------|-----------------------|---------------------------|----------|
+| `adUnitId`   | required | Unique identifier for the ad unit in Bidsmind platform. | `1` | `integer` |
+| `auth`       | required | Authentication token provided by Bidsmind platform for the AdUnit. | `'61336e75e414c77c367eq5c47c2599ce80a8032b'` | `string` |
+
+### Setting First Party Data (FPD)
+
+Publishers should use the `ortb2` method of setting First Party Data. The following fields are supported:
+
+- ortb2.site.\*
+- ortb2.app.\*
+- ortb2.user.\*
+
+Example first party data:
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        site: {
+            keywords: "kw1,kw2",
+            content: {
+                title: "title1",
+                series: "series1"
+            }
+        },
+        user: {
+            keywords: "a,b",
+            gender: "M",
+            yob: 1984
+        }
+    }
+});
+```
+
+### ORTB Blocking
+
+Bidsmind supports the next blocking parameters:
+
+- Blocked advertisers list (`badv`) is an array of domains as strings.
+- Blocked apps list (`bapp`) is an array of apps names as strings, for mobile apps in Google Play Store, these should be
+  bundle or package names (e.g. com.foo.mygame). For apps in Apple App Store, these should be a numeric ID.
+- Blocked categories list (`bcat`) is an array of IAB categories as strings.
+- Blocked attributes list (`battr`) is an array of integers. Refer to section 5.3 of the IAB specification for a list of
+  attributes.
+
+#### Globally defined ORTB Blocking
+
+```javascript
+pbjs.setConfig({
+    ortb2: {
+        badv: ["domain1.com", "domain2.com"],
+        bapp: ["com.foo.mygame", "284708449"],
+        bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+    }
+});
+```
+
+#### ORTB Blocking specific only to the Bidsmind bidder
+
+```javascript
+pbjs.setBidderConfig({
+    bidders: ['bidsmind'], // Or alias
+    config: {
+        ortb2: {
+            badv: ["domain1.com", "domain2.com"],
+            bapp: ["com.foo.mygame"],
+            bcat: ["IAB23-1", "IAB23-5", "IAB25-3", "IAB25-2"]
+        }
+    }
+});
+```
+
+#### Media Type defined ORTB Blocking
+
+Additionally `battr` ORTB blocking param may be set on media types to specify blocked creative
+attributes. Refer to section 5.3 of the IAB specification for a list of attributes.
diff --git a/dev-docs/bidders/connatix.md b/dev-docs/bidders/connatix.md
@@ -17,7 +17,7 @@ deals_supported: true
 floors_supported: true
 fpd_supported: false
 pbjs: true
-pbs: false
+pbs: true
 prebid_member: false
 multiformat_supported: will-bid-on-one
 ortb_blocking_supported: true

diff --git a/dev-docs/bidders/epsilon.md b/dev-docs/bidders/epsilon.md
@@ -5,13 +5,14 @@ description: Epsilon Prebid Bidder Adaptor (formerly Conversant)
 pbjs: true
 pbs: true
 biddercode: conversant
-media_types: video
+media_types: banner, video, audio
 tcfeu_supported: true
 userIds: criteo, id5Id, identityLink, liveIntentId, parrableId, pubCommonId, unifiedId, publinkId
 prebid_member: true
 schain_supported: true
 gvl_id: 24
 sidebarType: 1
+multiformat_supported: will-not-bid
 ---
 
 
@@ -84,7 +85,7 @@ The following values are defined in the [ORTB 2.5 spec](https://www.iab.com/wp-c
 Publishers should use the `ortb2` method of setting for setting First Party Data.
 Example first party data configuration that is available to all adUnits
 
-```
+```javascript
 pbjs.setConfig({
     debug: true,
     cache: {
@@ -105,7 +106,7 @@ pbjs.setConfig({
 
 Example AdUnit specific data using the `ortb2Imp` object
 
-```
+```javascript
         var videoAdUnit = {
             code: 'video1',
             mediaTypes: {