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

AdvRed analytics adapter #5397

Merged
merged 2 commits into from
Aug 8, 2024
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
30 changes: 30 additions & 0 deletions dev-docs/analytics/advRed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
layout: analytics
title: AdvRed
description: AdvRed Analytics Adapter
modulecode: advRed
---

#### About

The AdvRed analytics adapter can be used by all clients after approval. For more information,
please visit <https://ams.adv.red/>

#### Analytics Options
| Param enableAnalytics | Scope | Type | Description | Example |
|-----------------------|----------|--------|------------------------------------------------------|----------------------------------|
| provider | Required | String | The name of this Adapter. | `'advRed'` |
| params | Required | Object | Details of module params. | |
| params.publisherId | Required | String | This is the Publisher ID value obtained from AdvRed. | `'123456'` |
| params.url | Optional | String | Custom URL of the endpoint to collect the events | `'https://pub1.api.adv.red/api/event'` |

#### Example Configuration

```javascript
pbjs.enableAnalytics({
provider: 'advRed',
options: {
publisherId: '123456' // change to the Publisher ID you received from AdvRed
}
});
```
Loading