Bitmedia Bidder Adapter MD : initial release (#5788)

* add bitmedia MD * Changes at bitmedia.md * fix eslint errors at bitmedia.md
prebid · Jan 16, 2025 · 94580d7 · 94580d7
1 parent e747355
commit 94580d7
Showing 1 changed file with 223 additions and 0 deletions.
diff --git a/dev-docs/bidders/bitmedia.md b/dev-docs/bidders/bitmedia.md
@@ -0,0 +1,223 @@
+---
+layout: bidder
+title: Bitmedia
+description: Prebid Bitmedia Bidder Adapter
+biddercode: bitmedia
+pbjs: true
+pbs: false
+gvl_id: none
+tcfeu_supported: false
+usp_supported: false
+coppa_supported: false
+gpp_sids: none
+schain_supported: false
+dchain_supported: false
+userId: none
+media_types: banner
+safeframes_ok: true
+deals_supported: false
+floors_supported: true
+fpd_supported: false
+ortb_blocking_supported: false
+multiformat_supported: will-not-bid
+privacy_sandbox: no
+prebid_member: false
+sidebarType: 1
+---
+
+
+### Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Description](#description)
+- [Bid Params](#bid-params)
+- [Test Parameters](#test-parameters)
+- [Testing Instructions](#testing-instructions)
+
+<a name="bitmedia-desc"></a>
+
+### Description
+
+The Bitmedia Bid Adapter allows publishers to integrate with BitmediaIO for banner advertising.
+
+#### Key Points
+
+- Supported Media Type: **Banner**
+- Bids are only provided in **USD**.
+- Access to **local storage** is optional.
+
+Before using this adapter, simply [create a publisher account](https://bitmedia.io/become-a-publisher) on our platform to obtain your `adUnitID`.
+
+More about us: [https://bitmedia.io](https://bitmedia.io)
+
+<a name="bid-params"></a>
+
+### Bid Params
+
+{: .table .table-bordered .table-striped }
+| Name         | Scope    | Description                        | Example           | Type     |
+|--------------|----------|------------------------------------|-------------------|----------|
+| `adUnitID`   | required | The ad unit ID from Bitmedia       | `'exampleAdUnitID'` | `string` |
+| `currency`   | optional | Currency of the bid (default: USD) | `'USD'`           | `string` |
+
+<a name="test-parameters"></a>
+
+## Test Parameters
+### Example
+
+```javascript
+var adUnits = [
+  {
+    code: 'banner-div',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250], [300, 600]],
+      },
+    },
+    bids: [{
+      bidder: 'bitmedia',
+      params: {
+        adUnitID: 'exampleAdUnitID',
+        currency: 'USD',
+      },
+    }],
+  },
+];
+```
+
+---
+<a name="testing-instructions"></a>
+## Testing Instructions
+
+The HTML file below can be used to test the integration of the Bitmedia Bid Adapter.
+
+### Simple Test HTML
+
+```html
+<!--
+  This page runs an auction for 2 adunits, simply displaying the results
+  rather than sending targeting to an ad server.
+
+  Notes:
+
+  - this approach assumes that the adunit.code is the div name. There
+  are many other ways to match the adunit to the div.
+  - this approach won't work for refreshed adunits. For that scenario
+  you'll need to be more surgical about what's passed into the bidsbackhandler.
+  - there's not a separate failsafe timeout here. Since there's no call to
+  an ad server waiting impatiently, Prebid's the only ad game in town and its
+  timeout is sufficient.
+-->
+
+<html>
+<head>
+    <!-- Your prebid build with Bitmedia adapter included -->
+    <script type="text/javascript" src="Should_Include_Bitmedia_Adapter/prebid.js" async></script>
+    <script>
+        var adUnits = [
+            {
+                code: 'test-div',
+                mediaTypes: {
+                    banner: {
+                        sizes: [
+                            [300, 600],
+                            [300, 250]
+
+                        ]
+                    }
+                },
+                bids: [
+                    {
+                        bidder: 'bitmedia',
+                        params: {
+                            adUnitID: 'exampleAdUnitID',
+                            currency: 'USD'
+                        },
+                    },
+                ]
+            },
+            {
+                code: 'test-div2',
+                mediaTypes: {
+                    banner: {
+                        sizes: [[320, 100]]
+                    }
+                },
+                bids: [{
+                    bidder: 'bitmedia',
+                    params: {
+                        adUnitID: 'exampleAdUnitID',
+                        currency: 'USD'
+                    }
+                }]
+            }
+        ];
+
+        var pbjs = pbjs || {};
+        pbjs.que = pbjs.que || [];
+    </script>
+    <!-- Your prebid settings -->
+    <script>
+        pbjs.que.push(function () {
+            pbjs.setConfig({
+                debug: true,
+            });
+            pbjs.bidderSettings = {
+                bitmedia: {
+                    storageAllowed: true, // recommended
+                },
+            };
+        });
+    </script>
+
+
+
+    <script>
+        pbjs.que.push(function() {
+            pbjs.addAdUnits(adUnits);
+        });
+
+        // you could instead pass an array of adUnits
+        // to getHighestCpmBids() if desired
+        function renderAllAdUnits() {
+            var winners=pbjs.getHighestCpmBids();
+            for (var i = 0; i < winners.length; i++) {
+                renderOne(winners[i]);
+            }
+        }
+
+        function renderOne(winningBid) {
+            if (winningBid && winningBid.adId) {
+                var div = document.getElementById(winningBid.adUnitCode);
+                if (div) {
+                    let iframe = document.createElement('iframe');
+                    iframe.frameBorder = '0';
+                    div.appendChild(iframe);
+                    var iframeDoc = iframe.contentWindow.document;
+                    pbjs.renderAd(iframeDoc, winningBid.adId);
+                }
+            }
+
+        }
+
+    </script>
+
+    <script>
+        pbjs.que.push(function() {
+            pbjs.requestBids({
+                timeout: 2000,
+                bidsBackHandler: renderAllAdUnits
+            });
+        });
+    </script>
+</head>
+
+<body>
+<h2>Ad Serverless Test Page</h2>
+
+<div id='test-div'></div>
+<br/>
+<div id='test-div2'></div>
+</body>
+</html>
+```