Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 604d1b0

Browse files
aleksandar-raynaleksandar-rayn
authored
rayn rtd provider module (prebid#5132)
1 parent aaacd86 commit 604d1b0

File tree

1 file changed

+120
-0
lines changed

1 file changed

+120
-0
lines changed

‎dev-docs/modules/raynRtdProvider.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
layout: page_v2
3+
title: Rayn RTD Provider
4+
display_name: Rayn Real Time Data Module
5+
description: Rayn Real Time Data module appends privacy preserving enhanced contextual categories and audiences. Moments matter.
6+
page_type: module
7+
module_type: rtd
8+
module_code: raynRtdProvider
9+
enable_download: true
10+
vendor_specific: true
11+
sidebarType: 1
12+
---
13+
14+
# Rayn Real-time Data Submodule
15+
16+
Rayn is a privacy preserving, data platform. We turn content into context, into audiences. For Personalisation, Monetisation and Insights. This module reads contextual categories and audience cohorts from RaynJS (via localStorage) and passes them to the bid-stream.
17+
18+
For best results, we recommend that you deploy RaynJS on your properties, as instructed in the Rayn implementation guide. RaynJS will ensure that your auctions contain Rayn data. Please reach out to [[email protected]](mailto:[email protected]) if you have any questions.
19+
20+
## Integration
21+
22+
To install the module, follow these instructions:
23+
24+
Step 1: Prepare the base Prebid file
25+
Compile the Rayn RTD module (`raynRtdProvider`) into your Prebid build along with the parent RTD Module (`rtdModule`). From the command line, run gulp build `gulp build --modules=rtdModule,raynRtdProvider`
26+
27+
Step 2: Set configuration
28+
Enable Rayn RTD Module using pbjs.setConfig. Example is provided in the Configuration section. See the **Parameter Description** for more detailed information of the configuration parameters.
29+
30+
### Configuration
31+
32+
This module is configured as part of the realTimeData.dataProviders object.
33+
34+
Example format:
35+
36+
```js
37+
pbjs.setConfig(
38+
// ...
39+
realTimeData: {
40+
auctionDelay: 1000,
41+
dataProviders: [
42+
{
43+
name: "rayn",
44+
waitForIt: true,
45+
params: {
46+
bidders: ["appnexus", "pubmatic"],
47+
integration: {
48+
iabAudienceCategories: {
49+
v1_1: {
50+
tier: 6,
51+
enabled: true,
52+
},
53+
},
54+
iabContentCategories: {
55+
v3_0: {
56+
tier: 4,
57+
enabled: true,
58+
},
59+
v2_2: {
60+
tier: 4,
61+
enabled: true,
62+
},
63+
},
64+
}
65+
}
66+
}
67+
]
68+
}
69+
// ...
70+
}
71+
```
72+
73+
## Parameter Description
74+
75+
The parameters below provide configurability for general behaviours of the RTD submodule, as well as enabling settings for specific use cases mentioned above (e.g. tiers and bidders).
76+
77+
### Parameters
78+
79+
{: .table .table-bordered .table-striped }
80+
| Name | Type | Description | Notes |
81+
| :---------------------------------------------------- | :-------- | :----------------------------------------------------------------------------------- | :---- |
82+
| name | `String` | RTD sub module name | Always "rayn" |
83+
| waitForIt | `Boolean` | Required to ensure that the auction is delayed for the module to respond | Optional. Defaults to false but recommended to true |
84+
| params | `Object` | ||
85+
| params.bidders | `Array` | Bidders with which to share context and segment information | Optional. In case no bidder is specified Rayn will append data for all bidders |
86+
| params.integration | `Object` | Controls which IAB taxonomy should be used and up to which category tier | Optional. In case it's not defined, all supported IAB taxonomies and all category tiers will be used |
87+
| params.integration.iabAudienceCategories | `Object` | ||
88+
| params.integration.iabAudienceCategories.v1_1 | `Object` | ||
89+
| params.integration.iabAudienceCategories.v1_1.enabled | `Boolean` | Controls if IAB Audience Taxonomy v1.1 will be used | Optional. Enabled by default |
90+
| params.integration.iabAudienceCategories.v1_1.tier | `Number` | Controls up to which IAB Audience Taxonomy v1.1 Category tier will be used | Optional. Tier 6 by default |
91+
| params.integration.iabContentCategories | `Object` | ||
92+
| params.integration.iabContentCategories.v3_0 | `Object` | ||
93+
| params.integration.iabContentCategories.v3_0.enabled | `Boolean` | Controls if IAB Content Taxonomy v3.0 will be used | Optional. Enabled by default |
94+
| params.integration.iabContentCategories.v3_0.tier | `Number` | Controls up to which IAB Content Taxonomy v3.0 Category tier will be used | Optional. Tier 4 by default |
95+
| params.integration.iabContentCategories.v2_2 | `Object` | ||
96+
| params.integration.iabContentCategories.v2_2.enabled | `Boolean` | Controls if IAB Content Taxonomy v2.2 will be used | Optional. Enabled by default |
97+
| params.integration.iabContentCategories.v2_2.tier | `Number` | Controls up to which IAB Content Taxonomy v2.2 Category tier will be used | Optional. Tier 4 by default |
98+
99+
Please note that raynRtdProvider should be integrated into the website along with RaynJS.
100+
101+
## Testing
102+
103+
To view an example of the on page setup:
104+
105+
```bash
106+
gulp serve-fast --modules=rtdModule,raynRtdProvider,appnexusBidAdapter
107+
```
108+
109+
Then in your browser access: [http://localhost:9999/integrationExamples/gpt/raynRtdProvider_example.html](http://localhost:9999/integrationExamples/gpt/raynRtdProvider_example.html)
110+
111+
Run the unit tests, just on the Rayn RTD module test file:
112+
113+
```bash
114+
gulp test --file "test/spec/modules/raynRtdProvider_spec.js"
115+
```
116+
117+
## Support
118+
119+
If you require further assistance or are interested in discussing the module functionality please reach out to [[email protected]](mailto:[email protected]).
120+
You are also able to find more examples and other integration routes on the Rayn documentation site.

0 commit comments

Comments
 (0)