From 8ad561c1132c540212ab6fd7798c90ad1f2b3826 Mon Sep 17 00:00:00 2001 From: Scott Menzer Date: Mon, 31 May 2021 10:04:23 +0200 Subject: [PATCH 1/2] first draft of id5 analytics adapter docs --- dev-docs/analytics/id5.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 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..86664cd16b --- /dev/null +++ b/dev-docs/analytics/id5.md @@ -0,0 +1,39 @@ +--- +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/universal-id](https://id5.io/universal-id) 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://www.id5.io/platform-privacy-policy](https://www.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: 1234, // change to the Partner Number you received from ID5 + eventsToTrack: ['auctionEnd','bidWon'] + } +}); +``` From 7c427367b746e08d45c848c2399fc8096d7c8e38 Mon Sep 17 00:00:00 2001 From: Scott Menzer Date: Mon, 31 May 2021 10:47:32 +0200 Subject: [PATCH 2/2] update links and example --- dev-docs/analytics/id5.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/dev-docs/analytics/id5.md b/dev-docs/analytics/id5.md index 86664cd16b..220fb175ad 100644 --- a/dev-docs/analytics/id5.md +++ b/dev-docs/analytics/id5.md @@ -12,9 +12,9 @@ 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/universal-id](https://id5.io/universal-id) 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 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://www.id5.io/platform-privacy-policy](https://www.id5.io/platform-privacy-policy). +The ID5 privacy policy is at [https://id5.io/platform-privacy-policy](https://id5.io/platform-privacy-policy). #### Analytics Options @@ -32,8 +32,7 @@ The ID5 privacy policy is at [https://www.id5.io/platform-privacy-policy](https: pbjs.enableAnalytics({ provider: 'id5Analytics', options: { - partnerId: 1234, // change to the Partner Number you received from ID5 - eventsToTrack: ['auctionEnd','bidWon'] + partnerId: 173 // change to the Partner Number you received from ID5 } }); ```