diff --git a/dev-docs/modules/adlineRtdProvider.md b/dev-docs/modules/adlineRtdProvider.md new file mode 100644 index 0000000000..1179d798cc --- /dev/null +++ b/dev-docs/modules/adlineRtdProvider.md @@ -0,0 +1,77 @@ +--- +layout: page_v2 +title: Adline Real-Time Data Module +display_name: Adline RTD +description: Adline Real-Time Data Provider for Age Consent +page_type: module +module_type: rtd +module_code: adlineRtd +enable_download: true +vendor_specific: true +sidebarType: 1 +--- + +# Adline RTD Provider + +## Overview + +The Adline Real-Time Data (RTD) Provider automatically retrieves age consent 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 Adline RTD Module into your Prebid build: + + ```bash + gulp build --modules=adlineRtdProvider ... + ``` + +2. Use `setConfig` to instruct Prebid.js to initialize the adlineRtdProvider module, as specified below. + +## Configuration + +```javascript +pbjs.setConfig({ + realTimeData: { + auctionDelay: 1000, + dataProviders: [ + { + name: "adlineRtd", + waitForIt: true, + } + ] + } +}); +``` + +## Parameters + +| Name | Type | Description | Default | +|-----------|---------|----------------------------------------------|---------| +| name | String | Must be "adlineRtd" | n/a | +| waitForIt | Boolean | Whether to wait for the module before auction | true | + +## Age Consent Data + +The module attempts to retrieve age consent data from the following sources, in order: + +1. AdlCmp API (if available) +2. Local storage + +The age consent data is added to the bid request in the following format: + +```javascript +{ + ortb2: { + user: { + ext: { + age_consent: { + status: 'accepted', //represents the age consent status. + id: "123456789123456789", //unique identifier for the consent decision // 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 consent decision was made + dob: "01-01-1980", //ISO 8601 date string (e.g., "01-01-1980") // Optional, represents the user's date of birth if provided + } + } + } + } +} +```