Skip to content

Commit d3ff5e9

Browse files
symplorprosymplorpro
authored
Add Rediads user ID module documentation (#6503)
* Add Rediads user ID module documentation * Add a fix for build failure * Add a fix for build failure
1 parent 0016ad1 commit d3ff5e9

2 files changed

Lines changed: 145 additions & 10 deletions

File tree

‎dev-docs/bidders/rediads.md‎

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,26 @@ safeframes_ok: false
1616
deals_supported: false
1717
floors_supported: true
1818
fpd_supported: true
19+
userIds: rediadsId
1920
ortb_blocking_supported: partial
2021
privacy_sandbox: no
2122
multiformat_supported: will-bid-on-one
2223
sidebarType: 1
2324
---
2425

25-
### Bid Params
26+
## Bid Params
2627

2728
{: .table .table-bordered .table-striped }
28-
| Name | Scope | Description | Example | Type |
29-
|--------------|----------|-----------------------------------------------------------------------------|----------------------|----------------|
30-
| account_id | required | Account ID generated on the Rediads Platform. | '123xyz' | string |
31-
| endpoint | optional | Only to be used if RediAds team provides you with one. | 'bidding2' | string |
32-
| slot | optional | Unique identifier for the ad slot generated on the platform. | '54321' | string |
29+
30+
| Name | Scope | Description | Example | Type |
31+
| ---------- | -------- | ------------------------------------------------------------ | ------------ | ------ |
32+
| account_id | required | Account ID generated on the Rediads Platform. | `'123xyz'` | string |
33+
| endpoint | optional | Only to be used if RediAds team provides you with one. | `'bidding2'` | string |
34+
| slot | optional | Unique identifier for the ad slot generated on the platform. | `'54321'` | string |
3335

3436
---
3537

36-
### Enabling Test Bids
38+
## Enabling Test Bids
3739

3840
To enable test bids for the Rediads Bidder Adapter, append rediads-test-bids to the hash of the page URL.
3941

@@ -46,9 +48,9 @@ This will activate test bids for debugging and validation purposes.
4648

4749
---
4850

49-
### AdUnit Examples
51+
## AdUnit Examples
5052

51-
#### AdUnit Format for Banner
53+
### AdUnit Format for Banner
5254

5355
```javascript
5456
var adUnits = [
@@ -72,7 +74,7 @@ var adUnits = [
7274
];
7375
```
7476

75-
### First Party Data Support
77+
## First Party Data Support
7678
The following fields are supported for First Party Data (FPD):
7779

7880
- `ortb2.site.*`
@@ -81,3 +83,11 @@ The following fields are supported for First Party Data (FPD):
8183
- `ortb2.devices.locations parameters`
8284

8385
For additional implementation or support, contact us at <support@rediads.com>.
86+
87+
## User ID Support
88+
89+
The Rediads bidder supports the `rediadsId` user ID submodule. To build both together:
90+
91+
```bash
92+
gulp build --modules=rediadsBidAdapter,userId,rediadsIdSystem
93+
```

‎dev-docs/modules/userid-submodules/rediads.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
layout: userid
3+
title: Rediads ID
4+
description: Rediads User ID sub-module
5+
useridmodule: rediadsIdSystem
6+
bidRequestUserId: rediadsId
7+
eidsource: rediads.com
8+
example: '"ruid_7b9c1d3f-1e2b-4e7b-9e5a-acde12345678"'
9+
---
10+
11+
## Overview
12+
13+
The Rediads User ID submodule generates a first-party browser identifier for publisher-side identity and makes it available to Prebid bidders through both `bidRequest.userId.rediadsId` and `bidRequest.userIdAsEids`.
14+
15+
This submodule is implemented as a Prebid User ID module and uses Prebid-managed storage.
16+
17+
## Registration
18+
19+
For setup information, contact [support@rediads.com](mailto:support@rediads.com).
20+
21+
## Installation
22+
23+
Build Prebid.js with the User ID core module, the Rediads ID submodule, and optionally the Rediads bidder:
24+
25+
```bash
26+
gulp build --modules=rediadsBidAdapter,userId,rediadsIdSystem
27+
```
28+
29+
If you only need the user ID module, you can omit `rediadsBidAdapter`:
30+
31+
```bash
32+
gulp build --modules=userId,rediadsIdSystem
33+
```
34+
35+
## Configuration
36+
37+
```javascript
38+
pbjs.setConfig({
39+
userSync: {
40+
userIds: [{
41+
name: 'rediadsId',
42+
params: {
43+
source: 'rediads.com'
44+
},
45+
storage: {
46+
type: 'html5',
47+
name: 'rediads_id',
48+
expires: 30,
49+
refreshInSeconds: 3600
50+
}
51+
}]
52+
}
53+
});
54+
```
55+
56+
## Parameters
57+
58+
{: .table .table-bordered .table-striped }
59+
60+
| Param under `userSync.userIds[]` | Scope | Type | Description | Example |
61+
| --- | --- | --- | --- | --- |
62+
| `name` | Required | String | Module identifier. Must be `"rediadsId"`. | `"rediadsId"` |
63+
| `params` | Optional | Object | Rediads-specific configuration. | |
64+
| `params.source` | Optional | String | EID source to emit. Defaults to `"rediads.com"`. | `"rediads.com"` |
65+
| `storage` | Recommended | Object | Prebid-managed storage configuration. | |
66+
| `storage.type` | Recommended | String | Storage type. Use `"html5"`, `"cookie"`, or `"cookie&html5"` as needed. | `"html5"` |
67+
| `storage.name` | Recommended | String | Storage key name. | `"rediads_id"` |
68+
| `storage.expires` | Optional | Number | Lifetime of the stored ID in days. Defaults to `30`. | `30` |
69+
| `storage.refreshInSeconds` | Optional | Number | Refresh interval in seconds. Defaults to `3600`. | `3600` |
70+
71+
## Privacy Handling
72+
73+
The Rediads ID submodule follows the standard Prebid User ID privacy flow.
74+
75+
- If COPPA applies, the module does not create or return an ID.
76+
- If GDPR applies without a valid consent string and Purpose 1 consent, the module does not create or return an ID.
77+
- If US Privacy or GPP opt-out signals restrict sharing, the module may still retain its local ID state but does not emit EIDs for bidder sharing.
78+
79+
The module uses Prebid's vendorless TCF marker so purpose-level enforcement applies without requiring a separate vendor registration in the module config.
80+
81+
## Bid Request Output
82+
83+
When available, the Rediads ID is exposed on the bid request as:
84+
85+
```javascript
86+
bidRequest.userId.rediadsId
87+
```
88+
89+
Example:
90+
91+
```json
92+
{
93+
"uid": "ruid_7b9c1d3f-1e2b-4e7b-9e5a-acde12345678",
94+
"source": "rediads.com",
95+
"atype": 1,
96+
"ext": {
97+
"canShare": true
98+
}
99+
}
100+
```
101+
102+
## EID Output
103+
104+
When sharing is permitted, the module contributes the following EID:
105+
106+
```json
107+
{
108+
"source": "rediads.com",
109+
"uids": [{
110+
"id": "ruid_7b9c1d3f-1e2b-4e7b-9e5a-acde12345678",
111+
"atype": 1
112+
}]
113+
}
114+
```
115+
116+
## Testing
117+
118+
After building Prebid.js with `userId` and `rediadsIdSystem`, you can verify the module with:
119+
120+
```javascript
121+
pbjs.getUserIds()
122+
pbjs.getUserIdsAsEids()
123+
```
124+
125+
You should see `rediadsId` in `getUserIds()` and a `rediads.com` entry in `getUserIdsAsEids()` when privacy settings allow sharing.

0 commit comments

Comments
 (0)