From ec1206cd0d7f7e41e99b56754aea91b79bcad1cf Mon Sep 17 00:00:00 2001 From: Scott Menzer Date: Thu, 10 Jun 2021 22:10:00 +0200 Subject: [PATCH] Id5 analytics adapter: initial release documentation (#2999) * first draft of id5 analytics adapter docs * update links and example --- dev-docs/analytics/id5.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 dev-docs/analytics/id5.md diff --git a/dev-docs/analytics/id5.md b/dev-docs/analytics/id5.md new file mode 100644 index 0000000000..220fb175ad --- /dev/null +++ b/dev-docs/analytics/id5.md @@ -0,0 +1,38 @@ +--- +layout: analytics +title: ID5 +description: ID5 Analytics Adapter +modulecode: id5Analytics +gdpr_supported: true +usp_supported: true +prebid_member: true +gvl_id: 131 +enable_download: false +--- + +#### Registration + +The ID5 Analytics Adapter is free to use during our Beta period, but requires a simple registration with ID5. Please visit [id5.io/solutions](https://id5.io/solutions#publishers) to sign up and request your ID5 Partner Number to get started. If you're already using the ID5 Universal ID, you may use your existing Partner Number with the analytics adapter. + +The ID5 privacy policy is at [https://id5.io/platform-privacy-policy](https://id5.io/platform-privacy-policy). + +#### Analytics Options + +{: .table .table-bordered .table-striped } +| Parameter | Scope | Type | Description | Example | +| --- | --- | --- | --- | --- | +| provider | Required | String | The name of this module: `id5Analytics` | `id5Analytics` | +| options.partnerId | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `1234` | +| options.eventsToTrack | Optional | Array of strings | Overrides the set of tracked events | `['auctionEnd','bidWon']` | + + +### Example Configuration + +```javascript +pbjs.enableAnalytics({ + provider: 'id5Analytics', + options: { + partnerId: 173 // change to the Partner Number you received from ID5 + } +}); +```