Skip to content

Commit 1dfc273

Browse files
raveltechRtdProvider: Initial documentation release (#5923)
* 1st version of the doc for raveltech bid adapter * add angle brackets around email address * add single newline character to comply with https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md * 1st version of the doc for raveltech bid adapter * add angle brackets around email address * add single newline character to comply with https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md047.md * update to solve: - header level 3: https://github.com/prebid/prebid.github.io/pull/5501/files/004b8d8e6ea3866f53aecc23a7f0041fd241874e#r1681657660 - table of params: https://github.com/prebid/prebid.github.io/pull/5501/files/004b8d8e6ea3866f53aecc23a7f0041fd241874e#r1681663103 * fix anchors to the appnexus doc * fix anchors to the appnexus doc * initial release of raveltechRtdProvider.md, replacing the raveltech.md as we're changing the approach from bid adapter to rtd module. * Update of documentation * fix the markdown lint errors * fix markdown lint errors * update markdown with instructions on how to load zkad.js * fix lint errors
1 parent ed85b71 commit 1dfc273

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
layout: page_v2
3+
title: Raveltech RTD Module
4+
display_name: Raveltech RTD Module
5+
description: Raveltech Real Time Data Module
6+
page_type: module
7+
module_type: rtd
8+
module_code : raveltechRtdProvider
9+
enable_download : true
10+
vendor_specific: true
11+
sidebarType : 1
12+
---
13+
14+
# Raveltech RTD Module for Prebid.js
15+
16+
## Overview
17+
18+
```text
19+
Module Name: Raveltech RTD Provider
20+
Module Type: RTD Provider
21+
Maintainer: maintainers@raveltech.io
22+
```
23+
24+
The RavelTech RTD (Real-Time Data) module for Prebid.js enables publishers to integrate seamlessly with Ravel Technologies' privacy-focused solution, ensuring bidder requests are anonymized before reaching SSPs and DSPs. By leveraging the Ravel Privacy Bus, this module prevents the transmission of personally identifiable information (PII) in bid requests, strengthening privacy compliance and security.
25+
26+
## How It Works
27+
28+
The module operates in two modes:
29+
30+
1. Bid URL Replacement:
31+
** The module modifies the bid request URL of the configured bidders to pass through the Ravel proxy, ensuring that all IDs are anonymized.
32+
2. Bid Duplication (if `preserveOriginalBid` is enabled):
33+
** The module duplicates the original bid request, sending one request as-is and another through the Ravel proxy with anonymized IDs.
34+
35+
## Configuration
36+
37+
To enable the Raveltech RTD module, you need to configure it with a list of bidders and specify whether to preserve the original bid request.
38+
For the anonymization feature to work, you also need to load a javascript in the header of your HTML page:
39+
40+
```html
41+
<script src="https://cdn.rvlproxy.net/latest/zkad.js" async></script>
42+
```
43+
44+
**NB: the URL to load zkad.js may change depending your setup. Please reach out to your contact at Ravel Technologies to ensure you have the correct URL.**
45+
46+
Please contact <support@raveltech.io> to activate your adapter after installation or for more information.
47+
48+
### Build
49+
50+
```bash
51+
gulp build --modules="rtdModule,raveltechRtdProvider,appnexusBidAdapter,..."
52+
```
53+
54+
> Note that the global RTD module, `rtdModule`, is a prerequisite of the raveltech RTD module.
55+
56+
### Parameters
57+
58+
| Parameter | Type | Description |
59+
|--------------------|--------|-------------|
60+
| `bidders` | Array | A list of bidder codes (or their alias if an alias is used) that should have their bid requests anonymized via Ravel. |
61+
| `preserveOriginalBid` | Boolean | If `true`, the original bid request is preserved, and an additional bid request is sent through the Ravel proxy. If `false`, the original bid request is replaced with the Ravel-protected request. |
62+
63+
### Example Configuration
64+
65+
```javascript
66+
pbjs.setConfig({
67+
realTimeData: {
68+
dataProviders: [{
69+
name: 'raveltech',
70+
params: {
71+
bidders: ['appnexus', 'rubicon'],
72+
preserveOriginalBid: true
73+
}
74+
}]
75+
}
76+
});
77+
```
78+
79+
## Privacy Features
80+
81+
The RavelTech RTD module allows publishers to implement the following privacy protections:
82+
83+
- Personally Identifiable Information (PII) is either removed or converted into Anonymized IDs (RIDs).
84+
- Bid requests are routed through an anonymized proxy before reaching the SSP, ensuring IP address anonymization.

0 commit comments

Comments
 (0)