Skip to content

Commit 235190f

Browse files
authored
WURFL Rtd Provider: initial version (prebid#5445)
* WURFL Rtd Provider: initial version * WURFL Rtd Provider: apply linter suggestions * WURFL Rtd Provider: linter: code blocks should have a language specified * WURFL Rtd Provider: remove the space between the header and the no_toc * WURFL Rtd Provider: remove rtdModule dependency reference
1 parent 5e5ddaa commit 235190f

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

dev-docs/modules/wurflRtdProvider.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: page_v2
3+
title: WURFL RTD Provider Module
4+
display_name: WURFL RTD Module
5+
description: WURFL Real Time Data Module
6+
page_type: module
7+
module_type: rtd
8+
module_code : wurflRtdProvider
9+
enable_download : true
10+
vendor_specific: true
11+
sidebarType : 1
12+
---
13+
14+
{: .alert.alert-warning :}
15+
This module loads a dynamically generated JavaScript from prebid.wurflcloud.com
16+
17+
# WURFL RTD Submodule
18+
{:.no_toc}
19+
20+
* TOC
21+
{:toc}
22+
23+
## Description
24+
25+
The WURFL RTD module enriches the OpenRTB 2.0 device data with [WURFL data](https://www.scientiamobile.com/wurfl-js-business-edition-at-the-intersection-of-javascript-and-enterprise/).
26+
The module sets the WURFL data in `device.ext.wurfl` and all the bidder adapters will always receive the low entry capabilites like `is_mobile`, `complete_device_name` and `form_factor`.
27+
28+
For a more detailed analysis bidders can subscribe to detect iPhone and iPad models and receive additional [WURFL device capabilities](https://www.scientiamobile.com/capabilities/?products%5B%5D=wurfl-js).
29+
30+
## User-Agent Client Hints
31+
32+
WURFL.js is fully compatible with Chromium's User-Agent Client Hints (UA-CH) initiative. If User-Agent Client Hints are absent in the HTTP headers that WURFL.js receives, the service will automatically fall back to using the User-Agent Client Hints' JS API to fetch [high entropy client hint values](https://wicg.github.io/ua-client-hints/#getHighEntropyValues) from the client device. However, we recommend that you explicitly opt-in/advertise support for User-Agent Client Hints on your website and delegate them to the WURFL.js service for the fastest detection experience. Our documentation regarding implementing User-Agent Client Hint support [is available here](https://docs.scientiamobile.com/guides/implementing-useragent-clienthints).
33+
34+
## Usage
35+
36+
### Build
37+
38+
```bash
39+
gulp build --modules="wurflRtdProvider,appnexusBidAdapter,..."
40+
```
41+
42+
### Configuration
43+
44+
Use `setConfig` to instruct Prebid.js to initilize the WURFL RTD module, as specified below.
45+
46+
This module is configured as part of the `realTimeData.dataProviders`
47+
48+
```javascript
49+
var TIMEOUT = 1000;
50+
pbjs.setConfig({
51+
realTimeData: {
52+
auctionDelay: TIMEOUT,
53+
dataProviders: [{
54+
name: 'wurfl',
55+
waitForIt: true,
56+
params: {
57+
debug: false
58+
}
59+
}]
60+
}
61+
});
62+
```
63+
64+
### Parameters
65+
66+
{: .table .table-bordered .table-striped }
67+
| Name | Type | Description | Default |
68+
| :------------------------ | :------------ | :--------------------------------------------------------------- |:----------------- |
69+
| name | String | Real time data module name | Always 'wurfl' |
70+
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
71+
| params | Object | | |
72+
| params.altHost | String | Alternate host to connect to WURFL.js | |
73+
| params.debug | Boolean | Enable debug | `false` |
74+
75+
## Testing
76+
77+
To view an example of how the WURFL RTD module works :
78+
79+
`gulp serve --modules=wurflRtdProvider,appnexusBidAdapter`
80+
81+
and then point your browser at:
82+
83+
`http://localhost:9999/integrationExamples/gpt/wurflRtdProvider_example.html`

0 commit comments

Comments
 (0)