Skip to content

Commit

Permalink
51d: update RtdProvider doc
Browse files Browse the repository at this point in the history
  • Loading branch information
justadreamer committed Jul 17, 2024
1 parent 1a31c48 commit fe69aad
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions dev-docs/modules/51DegreesRtdProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,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 +62,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 API is free to integrate and use. However the free tier has certain limitations. Please check [51Degrees pricing](https://51degrees.com/pricing) to choose a plan that suits your needs.

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

Expand Down Expand Up @@ -106,13 +108,13 @@ 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',
Expand Down

0 comments on commit fe69aad

Please sign in to comment.