Skip to content

Commit dbaeaee

Browse files
jxdeveloper1bretg
andauthored
adding documentation for jixie Id module which is applying for submission into the PrebidJs repo concurrently (#6030)
* as we are adding the prebid-server adaptor and introduced a few extra params , they are added here too (note: those 3 new params would also reach the headerbid adserver in the case of prebid "clientside HB" too. So all good) * added quotes around string params * add jixieId module md file --------- Co-authored-by: bretg <bgorsline@gmail.com>
1 parent 052708b commit dbaeaee

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

  • dev-docs/modules/userid-submodules
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
layout: userid
3+
title: Jixie ID
4+
description: Jixie ID User ID sub-module
5+
useridmodule: jixieId
6+
bidRequestUserId: jixieId
7+
eidsource: jixie.io
8+
example: '"1111"'
9+
---
10+
11+
12+
The Jixie ID module is specially useful for publishers that will connect with Jixie bidder through PrebidServer adapter feature of PrebidJS and/or for publishers that are unable to integrate with the Jixie ID/event script to still acquire the important Jixie client ID for users.
13+
14+
For assistance setting up your module, please contact us at <partners.jixie.io>
15+
16+
Add the Jixie ID to your Prebid.js Package with:
17+
18+
```bash
19+
gulp build --modules=userId,jixieIdSystem
20+
```
21+
22+
## Jixie ID Registration
23+
24+
Please reach out to [partners.jixie.io](mailto:partners.jixie.io) to request your `accountid`
25+
26+
## Jixie ID Configuration
27+
28+
{: .table .table-bordered .table-striped }
29+
30+
| Param under userSync.userIds[] | Scope | Type | Description | Example |
31+
| --- | --- | --- | --- | --- |
32+
| name | Required | String | The name of Module | `"jixieId"` |
33+
| params | optional | Object | Container of all module params. | |
34+
| params.accountid | optional | String | This is your `accountid` as provided by Jixie. | `Mo165qXxxx` |
35+
36+
## DMD ID Example
37+
38+
```javascript
39+
pbjs.setConfig({
40+
userSync: {
41+
userIds: [{
42+
name: 'jixieId',
43+
params: {
44+
accountid: 'Mo165qXxxx' // provided to you by Jixie
45+
}
46+
}]
47+
}
48+
});
49+
```

0 commit comments

Comments
 (0)