Skip to content

Commit 2f5d54e

Browse files
authored
Mobkoi Bidder Adapter and Mobkoi Analytics Adapter initial docs (#5809)
* Mobkoi Bidder Adapter and Mobkoi Analytics Adapter docs * removed the line that suggested in official PR review * multiformat_supported: will-bid-on-one * added userId configs * initialise user id module doc * github action fix * updated userId module and bidder adapter corrected a mistake corrected a mistake tidy up
1 parent 0777625 commit 2f5d54e

File tree

3 files changed

+168
-0
lines changed

3 files changed

+168
-0
lines changed

dev-docs/analytics/mobkoi.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
layout: analytics
3+
title: Mobkoi
4+
description: Mobkoi Analytics Adapter
5+
modulecode: mobkoi
6+
prebid_member: false
7+
tcfeu_supported: true
8+
usp_supported: false
9+
coppa_supported: false
10+
gvl_id: 898
11+
enable_download: true
12+
---
13+
14+
#### Registration
15+
16+
The Mobkoi Analytics adapter requires setup and approval. Please send an email to <[email protected]> for more information.
17+
18+
### Setting First Party Data (FPD)
19+
20+
Publishers should use the `pbjs.setBidderConfig` method of setting First Party Data. The following fields are supported:
21+
22+
| Path | Scope | Description | Example | Type |
23+
|---------------------------------------------|----------|------------------------------|---------------------------|-----------|
24+
| `ortb2.site.publisher.id` | required | Mobkoi Provided Publisher ID | `'mobkoi-publisher-id'` | `string` |
25+
| `ortb2.site.publisher.ext.adServerBaseUrl` | required | Ad Server URL | `'https://adserver.com'` | `string` |
26+
27+
#### Example Configuration
28+
29+
```js
30+
pbjs.que.push(function () {
31+
pbjs.enableAnalytics([
32+
{
33+
provider: 'mobkoi',
34+
},
35+
]);
36+
37+
pbjs.setBidderConfig({
38+
bidders: ['mobkoi'],
39+
config: {
40+
ortb2: {
41+
site: {
42+
publisher: {
43+
id: '<<-- Required. Provided Mobkoi Publisher ID -->>',
44+
ext: {
45+
adServerBaseUrl: '<<-- Required. Provided by Mobkoi -->>',
46+
},
47+
},
48+
},
49+
},
50+
},
51+
});
52+
});
53+
```

dev-docs/bidders/mobkoi.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: bidder
3+
title: Mobkoi
4+
description: Mobkoi Bidder Adapter
5+
biddercode: mobkoi
6+
tcfeu_supported: true
7+
dsa_supported: false
8+
gvl_id: 898
9+
usp_supported: false
10+
coppa_supported: false
11+
gpp_sids: tcfeu
12+
schain_supported: false
13+
dchain_supported: false
14+
userId: mobkoiId
15+
media_types: banner
16+
safeframes_ok: false
17+
deals_supported: false
18+
floors_supported: false
19+
fpd_supported: true
20+
pbjs: true
21+
pbs: false
22+
prebid_member: false
23+
multiformat_supported: will-bid-on-one
24+
ortb_blocking_supported: partial
25+
privacy_sandbox: no
26+
sidebarType: 1
27+
---
28+
29+
### Note
30+
31+
The Mobkoi Bidding adapter requires setup and approval before beginning. Please reach out to <[email protected]> for
32+
more details.
33+
34+
### Bid Params
35+
36+
{: .table .table-bordered .table-striped }
37+
| Path | Scope | Description | Example | Type |
38+
|---------------------------------------------|----------|------------------------------|---------------------------|-----------|
39+
| `placementId` | required | Mobkoi Provided Placement ID | `'DF2FFFFF'` | `string` |
40+
41+
#### Example Configuration
42+
43+
```js
44+
const adUnits = [
45+
{
46+
code: 'banner-ad',
47+
mediaTypes: {
48+
banner: { sizes: [300, 200] },
49+
},
50+
bids: [
51+
{
52+
bidder: 'mobkoi',
53+
params: {
54+
placementId: '<-- Placement ID provided by Mobkoi -->',
55+
},
56+
},
57+
],
58+
},
59+
];
60+
61+
pbjs.que.push(function () {
62+
pbjs.addAdUnits(adUnits);
63+
});
64+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
layout: userid
3+
title: Mobkoi ID
4+
description: Mobkoi ID User ID sub-module
5+
useridmodule: mobkoiIdSystem
6+
bidRequestUserId: mobkoiId
7+
eidsource: mobkoi.com
8+
example: '"1111111111111"'
9+
---
10+
11+
The Mobkoi ID system provides user identification capabilities for improved addressability and targeted advertising. This module handles user ID synchronization and storage while supporting GDPR consent management.
12+
13+
## Add Mobkoi ID to your Prebid.js Package
14+
15+
Add the module to your Prebid.js package:
16+
17+
```bash
18+
gulp build --modules=consentManagementTcf,tcfControl,mobkoiIdSystem,userId
19+
```
20+
21+
## Mobkoi ID Configuration
22+
23+
{: .table .table-bordered .table-striped }
24+
| Param under userSync.userIds[] | Scope | Type | Description | Example |
25+
| --- | --- | --- | --- | --- |
26+
| name | Required | String | The name of this module | `"mobkoiId"` |
27+
| storage | Required | Object | Storage settings for the ID | |
28+
| storage.type | Required | String | Where to store the ID - must be `"cookie"` | `"cookie"` |
29+
| storage.name | Required | String | Cookie name for storing the ID | `"_mobkoi_Id"` |
30+
| storage.expires | Required | Integer | Number of days before the cookie expires | `30` |
31+
32+
## Example Configuration
33+
34+
```javascript
35+
pbjs.setConfig({
36+
userSync: {
37+
userIds: [
38+
{
39+
name: 'mobkoiId',
40+
storage: {
41+
type: 'cookie',
42+
name: '_mobkoi_Id',
43+
expires: 30, // days
44+
},
45+
},
46+
],
47+
},
48+
});
49+
```
50+
51+
For integration support or questions, contact <[email protected]>.

0 commit comments

Comments
 (0)