Skip to content

Commit

Permalink
WURFL Rtd Provider: initial version (prebid#5445)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
lucor authored Jul 26, 2024
1 parent 5e5ddaa commit 235190f
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions dev-docs/modules/wurflRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
layout: page_v2
title: WURFL RTD Provider Module
display_name: WURFL RTD Module
description: WURFL Real Time Data Module
page_type: module
module_type: rtd
module_code : wurflRtdProvider
enable_download : true
vendor_specific: true
sidebarType : 1
---

{: .alert.alert-warning :}
This module loads a dynamically generated JavaScript from prebid.wurflcloud.com

# WURFL RTD Submodule
{:.no_toc}

* TOC
{:toc}

## Description

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/).
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`.

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).

## User-Agent Client Hints

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).

## Usage

### Build

```bash
gulp build --modules="wurflRtdProvider,appnexusBidAdapter,..."
```

### Configuration

Use `setConfig` to instruct Prebid.js to initilize the WURFL RTD module, as specified below.

This module is configured as part of the `realTimeData.dataProviders`

```javascript
var TIMEOUT = 1000;
pbjs.setConfig({
realTimeData: {
auctionDelay: TIMEOUT,
dataProviders: [{
name: 'wurfl',
waitForIt: true,
params: {
debug: false
}
}]
}
});
```

### Parameters

{: .table .table-bordered .table-striped }
| Name | Type | Description | Default |
| :------------------------ | :------------ | :--------------------------------------------------------------- |:----------------- |
| name | String | Real time data module name | Always 'wurfl' |
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
| params | Object | | |
| params.altHost | String | Alternate host to connect to WURFL.js | |
| params.debug | Boolean | Enable debug | `false` |

## Testing

To view an example of how the WURFL RTD module works :

`gulp serve --modules=wurflRtdProvider,appnexusBidAdapter`

and then point your browser at:

`http://localhost:9999/integrationExamples/gpt/wurflRtdProvider_example.html`

0 comments on commit 235190f

Please sign in to comment.