Skip to content

Commit

Permalink
I want to add dgkeyword rtd module page. (#3016)
Browse files Browse the repository at this point in the history
  • Loading branch information
mediaconsortium-develop authored Jun 10, 2021
1 parent 09b14c4 commit d9fc0c3
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions dev-docs/modules/dgkeywordRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: page_v2
title: Digital Garage Keyword Module
display_name: Digital Garage Keyword
description: Digital Garage Keyword
page_type: module
module_type: rtd
module_code : dgkeywordRtdProvider
enable_download : true
sidebarType : 1
---

# Digital Garage Keyword Module
{:.no_toc}

* TOC
{:toc}

## Integration

1) Compile the Digital Garage Keyword Module and Appnexus Bid Adapter into your Prebid build:

```
gulp build --modules="dgkeywordRtdProvider,appnexusBidAdapter,..."
```

2) Use `setConfig` to instruct Prebid.js to initilize the dgkeyword module, as specified below.

## Configuration

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

```javascript
var DGKEYWORD_TIMEOUT = 1000;
pbjs.setConfig({
realTimeData: {
auctionDelay: DGKEYWORD_TIMEOUT,
dataProviders: [{
name: 'dgkeyword',
waitForIt: true,
params: {
timeout: DGKEYWORD_TIMEOUT
}
}]
}
});
```

Syntax details:

{: .table .table-bordered .table-striped }
| Name |Type | Description | Notes |
| :------------ | :------------ | :------------ |:------------ |
| name | String | Real time data module name | Always 'dgkeyword' |
| waitForIt | Boolean | Should be `true` if there's an `auctionDelay` defined (optional) | `false` |
| params | Object | | |
| params.timeout | Integer |timeout (ms)| 1000 |

0 comments on commit d9fc0c3

Please sign in to comment.