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.

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

Add FreePass IdSystem Docs #4485

Merged
merged 6 commits into from
Jun 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions dev-docs/modules/userId.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ Bidders that want to support the User ID module in Prebid.js need to update thei
| SharedID (PBJS 4.x)| Prebid | sharedid | sharedid.org | {"id":"01EAJWWN...", "third":"01EAJ..."} |
| Unified ID | Trade Desk | tdid | adserver.org | "1111" |
| ConnectID | Yahoo | connectId | yahoo.com | {"connectId": "72d04af6..."} |
| FreePass ID | FreePass | freepassId | | "1111" |

For example, the adapter code might do something like:

Expand Down
47 changes: 47 additions & 0 deletions dev-docs/modules/userid-submodules/freepass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: userid
title: FreePass ID
description: FreePass User ID sub-module
useridmodule: freepassIdSystem
---

[FreePass](https://freepass-login.com/introduction.html) is a common authentication service operated by Freebit Co., Ltd. Users with a FreePass account do not need to create a new account to use partner services.

Please contact FreePass before using this ID at [[email protected]](mailto:[email protected])

## FreePass ID Configuration

Please make sure to add the FreePass user ID sub-module to your Prebid.js package with:

```shell
gulp build --modules=freepassIdSystem,userId
```

The following configuration parameters are available:

{: .table .table-bordered .table-striped }
| Param under userSync.userIds[] | Scope | Type | Description | Example |
|--------------------------------|----------|--------|------------------------------------------------------|----------------|
| name | Required | String | The name of this module | `"freepassId"` |
| freepassData | Optional | Object | FreePass data | `{}` |
| freepassData.commonId | Optional | String | Common ID obtained from FreePass | `"abcd1234"` |
| freepassData.userIp | Optional | String | User IP obtained in cooperation with partner service | `"127.0.0.1"` |

Usage example:

```javascript
pbjs.setConfig({
userSync: {
userIds: [{
name: 'freepassId',
storage: { name: '_freepassId', type: 'cookie', expires: 30 },
params: {
freepassData: {
commonId: 'fpcommonid123',
userIp: '127.0.0.1'
}
}
}]
}
});
```