Documentation for Adlane Real Time Data Provider Module

dev-docs/modules/adlaneRtdProvider.md

@@ -0,0 +1,76 @@
+---
+layout: page_v2
+title: Adlane Real-Time Data Module
+display_name: Adlane RTD Module
+description: Adlane Real-Time Data Provider for Age Verification
+page_type: module
+module_type: rtd
+module_code: adlaneRtdProvider
+enable_download: true
+vendor_specific: true
+sidebarType: 1
+---
+
+# Adlane RTD Provider
+
+## Overview
+
+The Adlane Real-Time Data (RTD) Provider automatically retrieves age verification information and adds it to the bid stream, allowing for age-appropriate ad targeting. This module does not have a Global Vendor List ID (GVL ID).
+
+## Integration
+
+1. Compile the Adlane RTD Module into your Prebid build:
+
+    ```bash
+    gulp build --modules=adlaneRtdProvider ...
+    ```
+
+2. Use `setConfig` to instruct Prebid.js to initialize the adlaneRtdProvider module, as specified below.
+
+## Configuration
+
+```javascript
+pbjs.setConfig({
+  realTimeData: {
+    auctionDelay: 1000,
+    dataProviders: [
+      {
+        name: "adlane",
+        waitForIt: true,
+      }
+    ]
+  }
+});
+```
+
+## Parameters
+
+| Name      | Type    | Description                                   | Default |
+|-----------|---------|-----------------------------------------------|---------|
+| name      | String  | Must be "adlane"                           | n/a     |
+| waitForIt | Boolean | Whether to wait for the module before auction | true    |
+
+## Age Verification Data
+
+The module attempts to retrieve age verification data from the following sources, in order:
+
+1. AdlCmp API (if available)
+2. Local storage
+
+The age verification data is added to the bid request in the following format:
+
+```javascript
+{
+   ortb2: {
+      regs: {
+         ext: {
+            age_verification: {
+               status: 'accepted', //The acceptance indicates that the user has confirmed they are 21 years of age or older (accepted/declined)
+               id: "123456789123456789", //unique identifier for the age verification // Optional
+               decisionDate: "2011-10-05T14:48:00.000Z", //ISO 8601 date string (e.g.,"2011-10-05T14:48:00.000Z") // Optional, represents the date when the age verification decision was made
+            }
+         }
+      }
+   }
+}
+```