Skip to content

Commit

Permalink
Add Adagio Rtd Provider doc
Browse files Browse the repository at this point in the history
  • Loading branch information
osazos committed May 27, 2024
1 parent e59fa05 commit d6d05cf
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions dev-docs/modules/adagioRtdProvider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
layout: page_v2
title: Adagio Rtd Module
display_name: Adagio Rtd Module
description: The Adagio Rtd module computes and collects data required to leverage Adagio viewability and attention prediction engine.
page_type: module
module_type: rtd
module_code : adagioRtdProvider
enable_download : true
vendor_specific: true
sidebarType : 1
---

# Adagio Realtime Module

{:.no_toc}

* TOC
{:toc}

## Overview

This module can be used in combination with [Adagio Bid Adapter](/dev-docs/bidders/adagioBidAdapter.md) (SSP) and/or with Adagio prebid server endpoint.
It computes and collects data required to leverage Adagio viewability and attention prediction engine.

Please contact [contact@adagio.io](contact@adagio.io) for more information.

## Configuration

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

```javascript
pbjs.setConfig({
realTimeData: {
dataProviders:[{
name: 'adagio',
params: {
organizationId: '1000', // Required. Provided by Adagio
site: "my-site" // Required. Provided by Adagio
}
}]
}
});
```

Syntax details:

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------------------|----------|-----------------------------------------------|-------------|----------|
| `name` | required | Real time data module name: Always `'adagio'` | `'adagio'` | `string` |
| `params` | required | | | `Object` |
| `params.organizationId` | required | Account id provided by Adagio. | `'1000'` | `string` |
| `params.site` | required | Account site name provided by Adagio. | `'my-site'` | `string` |


Check failure on line 56 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Multiple consecutive blank lines

dev-docs/modules/adagioRtdProvider.md:56 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md012.md
## Installation

To install the module, follow these instructions:

- Contact Adagio to get an account

Check failure on line 61 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list style

dev-docs/modules/adagioRtdProvider.md:61:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md

- Build the prebid.js file

Check failure on line 63 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list style

dev-docs/modules/adagioRtdProvider.md:63:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md

- Option 1: Use Prebid [Download](/download.html) page to build the prebid package. Ensure that you do check *Adagio* in Bidder Adapters and *Adagio Rtd Module* in Vendor-Specific Modules

Check failure on line 65 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list style

dev-docs/modules/adagioRtdProvider.md:65:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md

- Option 2: From the command line, run `gulp build --modules=adagioBidAdapter,rtdModule,adagioRtdProvider,...`

Check failure on line 67 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list style

dev-docs/modules/adagioRtdProvider.md:67:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md

- Enable Adagio Real Time Module using `pbjs.setConfig`. Example is provided in Configuration section.

Check failure on line 69 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Unordered list style

dev-docs/modules/adagioRtdProvider.md:69:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md004.md

Check failure on line 69 in dev-docs/modules/adagioRtdProvider.md

View workflow job for this annotation

GitHub Actions / run markdownlint

Files should end with a single newline character

dev-docs/modules/adagioRtdProvider.md:69:102 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md047.md

0 comments on commit d6d05cf

Please sign in to comment.