Skip to content

Commit 62db876

Browse files
PubMatic RTD Module doc updated with KVP details (prebid#6115)
* Docs: Updated PubMatic RTD module description and added targeting key documentation * Lint issue resolved * Lint issue resolved(end with a single newline character )
1 parent 7919ad8 commit 62db876

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

dev-docs/modules/pubmaticRtdProvider.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: page_v2
33
page_type: module
44
title: PubMatic RTD Provider
55
display_name: PubMatic RTD Module
6-
description: RTD module for Prebid provided by PubMatic to set dynamic floors
6+
description: RTD module for Prebid provided by PubMatic for dynamic yield optimization
77
module_type: rtd
88
module_code: pubmaticRtdProvider
99
enable_download: true
@@ -19,11 +19,11 @@ sidebarType: 1
1919

2020
## Overview
2121

22-
The PubMatic RTD module fetches pricing floor data and updates the Price Floors Module based on user's context in real-time as per Price Floors Modules Floor Data Provider Interface guidelines [Dynamic Floor Data Provider](https://docs.prebid.org/dev-docs/modules/floors.html#floor-data-provider-interface).
22+
The PubMatic RTD module provides dynamic yield optimization by fetching real-time pricing floor data and generating targeting data for ad server integration and reporting. The module integrates with Prebid's Price Floors system as per [Dynamic Floor Data Provider](https://docs.prebid.org/dev-docs/modules/floors.html#floor-data-provider-interface) guidelines.
2323

2424
## Integration
2525

26-
Step 1: Contact PubMatic to get a publisher ID and create your first profile.
26+
Step 1: Contact PubMatic to get a publisher ID and create your first profile. Additional settings like floor multipliers, and key-values enablement can be managed through the PubMatic UI.
2727

2828
Step 2: Integrate the PubMatic Analytics Adapter (see Prebid Analytics modules) as well as the Price Floors module.
2929

@@ -79,3 +79,14 @@ pbjs.setConfig({
7979
| params | Object | | |
8080
| params.publisherId | String | Publisher ID | |
8181
| params.profileId | String | Profile ID | |
82+
83+
## Targeting Keys
84+
85+
The module sets the following targeting keys for ad server integration and reporting:
86+
87+
{: .table .table-bordered .table-striped }
88+
| Key | Description | Values |
89+
| :-- | :---------- | :----- |
90+
| pm_ym_flrs | Whether RTD floor was applied to the auction | 0 (not applied)/1 (applied) |
91+
| pm_ym_flrv | Floor value after applying dynamic multipliers | Decimal value (e.g., "1.25") |
92+
| pm_ym_bid_s | Bid outcome status | 0 (no bid), 1 (won), 2 (floored) |

0 commit comments

Comments
 (0)