Skip to content

Commit

Permalink
51degreesRtdProvider: update doc
Browse files Browse the repository at this point in the history
- clarified the free availability of the api
- improved configuration description
  • Loading branch information
justadreamer committed Jul 22, 2024
1 parent 39926b8 commit 7c6e03a
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions dev-docs/modules/51DegreesRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ sidebarType : 1
---

{: .alert.alert-warning :}
This module loads a dynamically generated JavaScript from cloud.51degrees.com (or your self-hosted domain) based on the evidence (HTTP headers and API results) available. The external resource is used to handle constant platform and browser evolution without requiring frequent changes to the Prebid source code.
This module loads a dynamically generated JavaScript from Cloud API hosted at cloud.51degrees.com (or your self-hosted domain) based on the evidence (HTTP headers and API results) available. The external resource is used to handle constant platform and browser evolution without requiring frequent changes to the Prebid source code.

{: .alert.alert-warning :}
The Cloud API is **free** to integrate and use. To increase limits please check [51Degrees pricing](https://51degrees.com/pricing).

# 51Degrees RTD Submodule

Expand Down Expand Up @@ -51,7 +54,7 @@ gulp build --modules="rtdModule,51DegreesRtdProvider,appnexusBidAdapter,..."

#### Resource Key

In order to use the module please first obtain a Resource Key using the [Configurator tool](https://configure.51degrees.com/tWrhNfY6) - choose the following properties:
In order to use the module please first obtain a Resource Key using the [Configurator tool](https://configure.51degrees.com/HNZ75HT1) - choose the following properties:

* DeviceId
* DeviceType
Expand All @@ -62,11 +65,13 @@ In order to use the module please first obtain a Resource Key using the [Configu
* PlatformVersion
* ScreenPixelsHeight
* ScreenPixelsWidth
* ScreenPixelsPhysicalHeight
* ScreenPixelsPhysicalWidth
* ScreenInchesHeight
* ScreenInchesWidth
* PixelRatio (optional)
* PixelRatio

PixelRatio is desirable, but it's a paid property requiring a paid license. Free API service is limited. Please check [51Degrees pricing](https://51degrees.com/pricing) to choose a plan that suits your needs.
The Cloud API is **free** to integrate and use. To increase limits please check [51Degrees pricing](https://51degrees.com/pricing).

#### User Agent Client Hint (UA-CH) Permissions

Expand Down Expand Up @@ -106,20 +111,20 @@ In summary we recommend using `Delegate-CH` http-equiv as the preferred method o

### Configuration

This module is configured as part of the `realTimeData.dataProviders`
This module is configured as part of the `realTimeData.dataProviders`. We recommend setting `auctionDelay` to at least 250 ms and make sure `waitForIt` is set to `true` for the `51Degrees` RTD provider.

```javascript
pbjs.setConfig({
debug: true, // we recommend turning this on for testing as it adds more logging
realTimeData: {
auctionDelay: 1000, // should be set lower in production use
auctionDelay: 250,
dataProviders: [
{
name: '51Degrees',
waitForIt: true, // should be true, otherwise the auctionDelay will be ignored
params: {
// Get your resource key from https://configure.51degrees.com/tWrhNfY6 to connect to cloud.51degrees.com
resourceKey: '<YOUR_RESOURCE_KEY>',
// Get your resource key from https://configure.51degrees.com/HNZ75HT1
// alternatively, you can use the on-premise version of the 51Degrees service and connect to your chosen end point
// onPremiseJSUrl: 'https://localhost/51Degrees.core.js'
},
Expand Down

0 comments on commit 7c6e03a

Please sign in to comment.