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

Add Reconciliation RTD Module docs #2395

Merged
merged 3 commits into from
Oct 28, 2020
Merged
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
86 changes: 86 additions & 0 deletions dev-docs/modules/reconciliationRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
layout: page_v2
title: Reconciliation SDK Module
description: Reconciliation Real Time Data Module
bretg marked this conversation as resolved.
Show resolved Hide resolved
page_type: module
module_type: rtd
module_code: reconciliation
display_name: Reconciliation
enable_download: true
sidebarType: 1
---

# Reconciliation SDK Module
{:.no_toc}

* TOC
{:toc}

## Overview

The purpose of Reconciliation Real Time Data Provider is to allow publishers to collect supply chain structure information and vendor-specific impression IDs from ad creative suppliers. It reports the data to the Reconciliation Service, allowing publishers, advertisers and other supply chain participants to match and reconcile ad server, SSP, DSP and verification system log file records.
Reconciliation SDK was created as part of TAG DLT initiative ([https://www.tagtoday.net/pressreleases/dlt_9_7_2020](https://www.tagtoday.net/pressreleases/dlt_9_7_2020)).
TAG recently led a twelve-month, cross-industry pilot in the UK that evaluated the feasibility and benefits of using Distributed Ledger Technology (DLT) to increase trust and transparency in digital advertising.

More information: https://www.tagtoday.net/brand-safety#dltnetwork
Contact us: consultation@tagtoday.net

Implementation works like this:

1) Build the Reconciliation module into the Prebid.js package with:

```
gulp build --modules=reconciliationRtdProvider&...
```

2) Use `setConfig` to pass parameters to module

## Configuration

This module is configured as part of the `realTimeData.dataProviders` object:

```
pbjs.setConfig({
"realTimeData": {
dataProviders:[{
name: "reconciliation",
params: {
publisherMemberId: "test_prebid_publisher",
allowAccess: true, //optional - false by default
}
}]
}
});
```

Syntax details:

{: .table .table-bordered .table-striped }
| Name |Type | Description | Notes |
| :------------ | :------------ | :------------ |:------------ |
| name | String | Real time data module name | Always 'reconciliation' |
| params | Object | | |
| params.publisherMemberId |String |Unique Publisher ID| |
| params.allowAccess |Boolean |Share AdUnit IDs with advertiser Reconciliation Tags| Optional. Default to `false`|



## Output

For each ad slot, the module returns custom targeting values used to match impressions (publisher-adserver-advertiser).
The module also tracks AdUnit initialization and impressions ('impression' message is sent by the Reconciliation Tag in ad markup).

Custom targetings example:
```
{
"slotA":{
"RSDK_AUID": "/slotA-Unit",
"RSDK_ADID": "b5bbc103-00e9-499d-9637-bdba05b65427"
},
"slotB":{
"RSDK_AUID": "/slotB-Unit",
"RSDK_ADID": "325da95e-e37d-45fa-a46f-8ff91168b121"
}
}
```