InsurAds Bid Adapter: Initial Implementation

dev-docs/bidders/insurads.md

@@ -0,0 +1,142 @@
+---
+layout: bidder
+title: InsurAds
+description: Prebid InsurAds Bidder Adapter
+pbjs: true
+pbs: true
+biddercode: insurads
+gvl_id: 596
+usp_supported: true
+gpp_sids: tcfeu
+schain_supported: true
+dchain_supported: false
+floors_supported: true
+userIds: all
+tcfeu_supported: true
+media_types: banner, video, native
+safeframes_ok: true
+deals_supported: true
+sidebarType: 1
+fpd_supported: true
+multiformat_supported: will-bid-on-any
+
+---
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+| Name          | Scope    | Description                | Example                                   | Type      |
+|---------------|----------|----------------------------|--------------------------------------     |-----------|
+| `tagId`       | required | InsurAds tag ID            | `"testnexx"`                              | `string`  |
+| `videoTagId`  | optional | InsurAds Video tag ID      | `"testnexx"`                              | `string`  |
+| `nativeTagId` | optional | InsurAds Native tag ID     | `"testnexx"`                              | `string`  |
+| `allBids`     | optional | Return all bids            | `true`                                    | `boolean` |
+| `divId`       | optional | divId linked to adUnit     | `"div-1"`                                 | `string`  |
+| `adUnitName`  | optional | A code to identify adUnit  | `"header-ad"`                             | `string`  |
+| `adUnitPath`  | optional | A reference to adUnit Path | `"/12345/insurads/Homepage/HP/Header-Ad"` | `string`  |
+| `placement`   | optional | InsurAds placement         | `"TEST_PLACEMENT"`                        | `string`  |
+
+You *must* only include one ID field - either `tagId` or `placement`, not both. If you have questions on which parameter to use, please reach out to your Account Manager.
+The `tagId` and `placement` are **mutually exclusive** but at least one is required. If you pass both, `tagId` takes precedence.
+
+### Bidder Config
+
+You can allow writing in localStorage `pbjs.bidderSettings` for the bidder `insurads`
+
+{% include dev-docs/storageAllowed.md %}
+
+```javascript
+pbjs.bidderSettings = {
+    insurads: {
+        storageAllowed : true
+    }
+}
+```
+
+### First Party Data
+
+Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html).
+
+### Test Parameters
+
+```javascript
+var adUnits = [
+   // Banner adUnit
+   {
+      code: 'banner-div',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300,600]]
+        }
+      },
+      bids: [{
+         bidder: 'insurads',
+         params: {
+            tagId: 'testnexx'
+         }
+       }]
+   },
+   // Video adUnit
+   {
+        code: 'video1',
+        mediaTypes: {
+            video: {
+                playerSize: [640, 480],
+                context: 'instream'
+            }
+        },
+        bids: [{
+            bidder: 'insurads',
+            params: {
+               tagId: 'testnexx'
+            }
+        }]
+    },
+     // Native adUnit
+   {
+        code: 'native1',
+        mediaTypes: {
+            native: {
+                title: {
+                    required: true
+                },
+                image: {
+                    required: true
+                },
+                sponsoredBy: {
+                    required: true
+                }
+            }
+        },
+        bids: [{
+            bidder: 'insurads',
+            params: {
+               tagId: 'testnexx'
+            }
+        }]
+    },
+    // Multiformat Ad
+   {
+        code: 'multi1',
+        mediaTypes: {
+            video: {
+                playerSize: [640, 480],
+                context: 'instream'
+            },
+            banner: {
+              sizes: [[300, 250], [300,600]]
+            },
+            native: {
+
+            }
+        },
+        bids: [{
+            bidder: 'insurads',
+            params: {
+               tagId: 'testnexx',
+               videoTagId: 'testnexx'
+            }
+        }]
+    };
+];
+```