Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bitmedia Bidder Adapter MD : initial release #5788

Merged
merged 7 commits into from
Jan 16, 2025
Merged

Bitmedia Bidder Adapter MD : initial release #5788

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4e33088
add bitmedia MD
BitmediaDevTeam Dec 31, 2024
f2a5afa
Merge pull request #1 from Bitmedia-IO-Team/bitmedia-adapter
BitmediaDevTeam Dec 31, 2024
60f7f5b
Merge branch 'master' into master
BitmediaDevTeam Jan 6, 2025
a8c0d15
Changes at bitmedia.md
BitmediaDevTeam Jan 16, 2025
e3bd034
Merge pull request #2 from Bitmedia-IO-Team/bitmedia-adapter
BitmediaDevTeam Jan 16, 2025
0972943
fix eslint errors at bitmedia.md
BitmediaDevTeam Jan 16, 2025
8e2fbf9
Merge pull request #3 from Bitmedia-IO-Team/bitmedia-adapter
BitmediaDevTeam Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
223 changes: 223 additions & 0 deletions dev-docs/bidders/bitmedia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
---
layout: bidder
title: Bitmedia
description: Prebid Bitmedia Bidder Adapter
biddercode: bitmedia
aliasCode: none
bretg marked this conversation as resolved.
Show resolved Hide resolved
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: true //
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can't claim to support first party data unless there's a section below describing what specific types of FPD: site.ext.data, site.content.data, user.data, user.ext.data, imp.ext.data

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we use all fpd that automatically collected by prebid
we can change this field to false or describe at block all fpd`s what we use?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the code is already merged, I imagine you're eager to get the docs merged. So I won't hold it up for this, but really you ought to give yourself the credit for supporting FPD. All you have to do is as a note that says "Bitmedia supports all first party data: site.ext.data, site.content.data, user.ext.data, user.data, and imp.ext.data." But you can do that in a separate PR if you'd like.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the answer
We will finally consider how to describe it and make a separate pull request

ortb_blocking_supported: false
multiformat_supported: will-not-bid
privacy_sandbox: no
prebid_member: false
sidebarType: 1
---


### Table of Contents
bretg marked this conversation as resolved.
Show resolved Hide resolved

- [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` | required | Currency of the bid (default: USD) | `'USD'` | `string` |
bretg marked this conversation as resolved.
Show resolved Hide resolved

<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>
```