Skip to content

Commit

Permalink
dev-docs: describe Adloox Prebid Analytics Adapter (#2762)
Browse files Browse the repository at this point in the history
* dev-docs: describe Adloox Prebid Analytics Adapter

* dev-docs: add disclosure to adloox module as per as per prebid/Prebid.js#6308 (comment)
  • Loading branch information
jimdigriz authored Apr 7, 2021
1 parent 7e4d21c commit 9d659a0
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions dev-docs/analytics/adloox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: analytics
title: Adloox
description: Adloox Prebid Analytics Adapter
modulecode: adloox
gdpr_supported: true
usp_supported: true
coppa_supported: false
prebid_member: false
gvl_id: 93
enable_download: false
---

#### Disclosure

The adapter adds an HTML `<script>` tag to load Adloox's post-buy verification JavaScript (`https://j.adlooxtracking.com/ads/js/tfav_adl_X.js` at ~25kiB gzipped) when the [`bidWon` event](https://docs.prebid.org/dev-docs/publisher-api-reference.html#module_pbjs.onEvent) for each ad slot.

#### Registration

The [Adloox](https://adloox.com/) analytics adapter requires on-boarding and configuration
parameters supplied to you by Adloox account team. Please reach out to your account team or
[email protected] for more information.

#### Analytics Options

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|---------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|------------------|
| client | required | Your client name | `'adlooxtest'` | string |
| clientid | required | Your client ID | `127` | integer |
| platformid | required | Your platform ID | `2` | integer |
| tagid | required | Your tag configuration ID | `1234` | integer |

For detailed instructions please look to the [integration guidelines shipped with the Prebid.js project](https://github.com/prebid/Prebid.js/blob/master/modules/adlooxAnalyticsAdapter.md) which also link to our Prebid video and real-time data provider options.

### Example Configuration

```
pbjs.enableAnalytics({
provider: 'adloox',
options: {
client: 'adlooxtest', // supplied by Adloox
clientid: 127, // supplied by Adloox
platformid: 0, // supplied by Adloox
tagid: 0 // supplied by Adloox
}
});
```

0 comments on commit 9d659a0

Please sign in to comment.