Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP : PubMatic RTD Documentation and link added #5860

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions dev-docs/modules/pubmaticRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
layout: page_v2
page_type: module
title: PubMatic RTD Provider
display_name: PubMatic RTD Module
description: RTD module for Prebid provided by PubMatic to set dynamic floors
module_type: rtd
module_code: pubmaticRtdProvider
enable_download: true
vendor_specific: true
sidebarType: 1
---

# PubMatic RTD Module
{:.no_toc}

* TOC
{:toc}

## Overview

This RTD module, provided by PubMatic, sets dynamic floors for Prebid auctions.

## Integration

{: .alert.alert-info :}
Note: Ensure that the following modules are listed when building Prebid: `priceFloors`.
For example:

```shell
gulp build --modules=priceFloors
```

To compile the RTD module into your Prebid build:

```shell
gulp build --modules=rtdModule,pubmaticRtdProvider
```

## Configuration

To utilize the PubMatic RTD module, add `realTimeData` with the parameters mentioned below to the Prebid config.

```js
const AUCTION_DELAY = 500;
pbjs.setConfig({
// rest of the config
...,
realTimeData: {
auctionDelay: AUCTION_DELAY,
dataProviders: [
{
name: "pubmatic",
waitForIt: true,
params: {
publisherId: `<publisher_id>`, // please contact PubMatic to get a publisherId for yourself
profileId: `<profile_id>`, // please contact PubMatic to get a profileId for yourself
},
},
],
},
// rest of the config
...,
});
```

## Parameters

{: .table .table-bordered .table-striped }
| Name | Type | Description | Default |
| :----------------- | :------ | :------------------------------------------------------------- | :------------------------- |
| name | String | Name of the real-time data module | Always `pubmatic` |
| waitForIt | Boolean | Should be `true` if an `auctionDelay` is defined (optional) | `true` |
| params | Object | | |
| params.publisherId | String | Publisher ID | |
| params.profileId | String | Profile ID | |