New 33Across Analytics Adapter 1.0.0 (#4944)

* add analytics doc Ticket: IDG-716 * note gdpr and usp support Ticket: IDG-716 * update docs to better reflect analytics adapter standard use-case and behavior Ticket: IDG-716 * add table styling to table Ticket: IDG-716 * indicate gpp and coppa support Ticket: IDG-716 * Update 33across.md Change pid type to string, plus other minor tweaks. * Update 33across.md Add UIM reference. * Update 33across.md Add instructions on enabling existing customers for Analytics. * 33Across Analytics Adapter: Fix linting errors Co-authored-by: Muki Seiler <[email protected]> --------- Co-authored-by: Michael Scott-Nelson <[email protected]> Co-authored-by: Muki Seiler <[email protected]> Co-authored-by: Michael Scott-Nelson <[email protected]>
prebid · Nov 16, 2023 · 2a6979d · 2a6979d
1 parent ed22b47
commit 2a6979d
Showing 1 changed file with 77 additions and 0 deletions.
diff --git a/dev-docs/analytics/33across.md b/dev-docs/analytics/33across.md
@@ -0,0 +1,77 @@
+---
+layout: analytics
+title: 33Across
+description: 33Across Analytics Adapter
+modulecode: 33across
+gdpr_supported: true
+usp_supported: true
+gpp_supported: true
+coppa_supported: true
+gvl_id: 58
+enable_download: true
+---
+
+#### About
+
+This analytics adapter collects data about the performance of your ad slots
+for each auction run on your site. It also provides insight into how identifiers
+from the
+[33Across User ID Sub-module](https://docs.prebid.org/dev-docs/modules/userid-submodules/33across.html)
+and other user ID sub-modules improve your monetization. The data is sent at
+the earliest opportunity for each auction to provide a more complete picture of
+your ad performance.
+
+The analytics adapter is free to use!
+However, the publisher must work with our account management team to obtain a
+Publisher/Partner ID (PID) and enable Analytics for their account.
+To get a PID and to have the publisher account enabled for Analytics,
+you can reach out to our team at the following email - <[email protected]>
+
+If you are an existing publisher and you already use a 33Across PID,
+you can reach out to <[email protected]>
+to have your account enabled for analytics.
+
+The 33Across privacy policy is at <https://www.33across.com/privacy-policy/>.
+
+#### Analytics Options
+
+{: .table .table-bordered .table-striped }
+| Name      | Scope    | Example | Type     | Description |
+|-----------|----------|---------|----------|-------------|
+| `pid`     | required | abc123  | `string` | 33Across Publisher ID |
+| `timeout` | optional | 10000   | `int`    | Milliseconds to wait after last seen auction transaction before sending report (default 10000). |
+
+#### Configuration
+
+The data is sent at the earliest opportunity for each auction to provide
+a more complete picture of your ad performance, even if the auction is interrupted
+by a page navigation. At the latest, the adapter will always send the report
+when the page is unloaded, at the end of the auction, or after the timeout,
+whichever comes first.
+
+In order to guarantee consistent reports of your ad slot behavior, we recommend
+including the GPT Pre-Auction Module (`gptPreAuction` if compiling from source).
+This module is included by default when Prebid is downloaded.
+
+Enable the 33Across Analytics Adapter in Prebid.js using the analytics provider `33across`
+and options as seen in the example below.
+
+#### Example Configuration
+
+```js
+pbjs.enableAnalytics({
+    provider: '33across',
+    options: {
+        /**
+         * The 33Across Publisher ID.
+         */
+        pid: 'abc123',
+        /** 
+         * Timeout in milliseconds after which an auction report 
+         * will be sent regardless of auction state.
+         * [optional]
+         */
+        timeout: 10000
+    }
+});
+```