-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mobkoi Bidder Adapter and Mobkoi Analytics Adapter docs
- Loading branch information
Showing
2 changed files
with
137 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
layout: analytics | ||
title: Mobkoi | ||
description: Mobkoi Analytics Adapter | ||
modulecode: mobkoi | ||
prebid_member: false | ||
tcfeu_supported: true | ||
usp_supported: false | ||
coppa_supported: false | ||
gvl_id: 898 | ||
enable_download: true | ||
--- | ||
|
||
#### Registration | ||
|
||
The Mobkoi Analytics adapter requires setup and approval. Please send an email to <[email protected]> for more information. | ||
|
||
### Setting First Party Data (FPD) | ||
|
||
Publishers should use the `pbjs.setBidderConfig` method of setting First Party Data. The following fields are supported: | ||
|
||
| Path | Scope | Description | Example | Type | | ||
|---------------------------------------------|----------|------------------------------|---------------------------|-----------| | ||
| `ortb2.site.publisher.id` | required | Mobkoi Provided Publisher ID | `'mobkoi-publisher-id'` | `string` | | ||
| `ortb2.site.publisher.ext.adServerBaseUrl` | required | Ad Server URL | `'https://adserver.com'` | `string` | | ||
|
||
#### Example Configuration | ||
|
||
```js | ||
pbjs.que.push(function () { | ||
pbjs.enableAnalytics([ | ||
{ | ||
provider: 'mobkoi', | ||
}, | ||
]); | ||
|
||
pbjs.setBidderConfig({ | ||
bidders: ['mobkoi'], | ||
config: { | ||
ortb2: { | ||
site: { | ||
publisher: { | ||
id: '<<-- Required. Provided Mobkoi Publisher ID -->>', | ||
ext: { | ||
adServerBaseUrl: '<<-- Required. Provided by Mobkoi -->>', | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}); | ||
}); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
layout: bidder | ||
title: Mobkoi | ||
description: Mobkoi Bidder Adapter | ||
biddercode: mobkoi | ||
# aliasCode: fileContainingPBJSAdapterCodeIfDifferentThenBidderCode | ||
tcfeu_supported: true | ||
dsa_supported: false | ||
gvl_id: 898 | ||
usp_supported: false | ||
coppa_supported: false | ||
# gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp | ||
schain_supported: false | ||
dchain_supported: /false | ||
# userId: (list of supported vendors) | ||
media_types: banner | ||
safeframes_ok: false | ||
deals_supported: false | ||
floors_supported: false | ||
fpd_supported: true | ||
pbjs: true | ||
pbs: false | ||
prebid_member: false | ||
# multiformat_supported: will-bid-on-any, will-bid-on-one, will-not-bid | ||
ortb_blocking_supported: partial | ||
privacy_sandbox: no or comma separated list of `paapi`, `topics` | ||
sidebarType: 1 | ||
--- | ||
|
||
### Note | ||
|
||
The Mobkoi Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for | ||
more details. | ||
|
||
### Bid Params | ||
|
||
No bid params are needed as Mobkoi Adapters rely on First Party Data. | ||
|
||
### Setting First Party Data (FPD) | ||
|
||
Publishers should use the `pbjs.setBidderConfig` method of setting First Party Data. The following fields are supported: | ||
|
||
| Path | Scope | Description | Example | Type | | ||
|---------------------------------------------|----------|------------------------------|---------------------------|-----------| | ||
| `ortb2.site.publisher.id` | required | Mobkoi Provided Publisher ID | `'mobkoi-publisher-id'` | `string` | | ||
| `ortb2.site.publisher.ext.adServerBaseUrl` | required | Ad Server URL | `'https://adserver.com'` | `string` | | ||
|
||
#### Example Configuration | ||
|
||
```js | ||
const adUnits = [ | ||
{ | ||
code: 'banner-ad', | ||
mediaTypes: { | ||
banner: { sizes: [300, 200] }, | ||
}, | ||
bids: [ | ||
{ | ||
bidder: 'mobkoi', | ||
}, | ||
], | ||
}, | ||
]; | ||
|
||
pbjs.que.push(function () { | ||
pbjs.setBidderConfig({ | ||
bidders: ['mobkoi'], | ||
config: { | ||
ortb2: { | ||
site: { | ||
publisher: { | ||
id: '<<-- Required. Provided Mobkoi Publisher ID -->>', | ||
ext: { | ||
adServerBaseUrl: '<<-- Required. Provided by Mobkoi -->>', | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}); | ||
|
||
pbjs.addAdUnits(adUnits); | ||
}); | ||
``` |