Skip to content

Commit d5bd356

Browse files
authored
Add Panxo RTD Provider module documentation (#6424)
1 parent 3e340fb commit d5bd356

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
layout: page_v2
3+
title: Panxo RTD Provider Module
4+
display_name: Panxo RTD Module
5+
description: Real-time AI traffic classification for enriched OpenRTB bid requests.
6+
page_type: module
7+
module_type: rtd
8+
module_code : panxoRtdProvider
9+
enable_download : true
10+
vendor_specific: true
11+
sidebarType : 1
12+
---
13+
14+
# Panxo RTD Provider Module
15+
{:.no_toc}
16+
17+
* TOC
18+
{:toc}
19+
20+
## Overview
21+
22+
The Panxo RTD module enriches OpenRTB bid requests with real-time AI traffic classification signals. It detects visits originating from AI assistants and provides contextual data through `device.ext.panxo` and `site.ext.data.panxo`, enabling the Panxo Bid Adapter and other demand partners to apply differentiated bidding on AI-referred inventory.
23+
24+
To use this module, contact [publishers@panxo.ai](mailto:publishers@panxo.ai) or sign up at [app.panxo.com](https://app.panxo.com) to receive your property identifier.
25+
26+
{% include dev-docs/loads-external-javascript.md %}
27+
28+
## Configuration
29+
30+
This module is configured as part of the `realTimeData.dataProviders` object.
31+
32+
{: .table .table-bordered .table-striped }
33+
| Name | Scope | Description | Example | Type |
34+
|------------------|----------|--------------------------------------------------------|----------------------|-----------|
35+
| `name` | required | Real time data module name | `'panxo'` | `string` |
36+
| `params` | required | | | `Object` |
37+
| `params.siteId` | required | 16-character hex property identifier provided by Panxo | `'a1b2c3d4e5f67890'` | `string` |
38+
| `params.verbose` | optional | Enable verbose logging for troubleshooting | `true` | `boolean` |
39+
40+
### Basic Example
41+
42+
```javascript
43+
pbjs.setConfig({
44+
realTimeData: {
45+
auctionDelay: 300,
46+
dataProviders: [{
47+
name: 'panxo',
48+
waitForIt: true,
49+
params: {
50+
siteId: 'a1b2c3d4e5f67890'
51+
}
52+
}]
53+
}
54+
});
55+
```
56+
57+
## ORTB2 Data
58+
59+
The module adds the following fields to the OpenRTB bid request:
60+
61+
{: .table .table-bordered .table-striped }
62+
| Path | Description |
63+
|--------------------------|------------------------------------------|
64+
| `device.ext.panxo` | Session signal token for traffic verification |
65+
| `site.ext.data.panxo` | Contextual AI traffic classification data |
66+
67+
## Integration
68+
69+
To install the module, follow these instructions:
70+
71+
### Step 1: Build Prebid.js with the module
72+
73+
* Option 1: Use the Prebid [Download](/download.html) page to build the prebid package. Ensure that you check *Panxo RTD Module* under Vendor-Specific Modules.
74+
75+
* Option 2: From the command line, run `gulp build --modules=rtdModule,panxoRtdProvider,...`
76+
77+
> Note that the Panxo RTD module requires the global real-time data module, `rtdModule`.
78+
79+
### Step 2: Set configuration
80+
81+
Enable the Panxo RTD module using `pbjs.setConfig` as shown in the example above.

0 commit comments

Comments
 (0)