Skip to content

Commit

Permalink
Create sharethroughAnalyticsAdapter.md (prebid#11513)
Browse files Browse the repository at this point in the history
* Adding documentation for Sharethrough's analytics adapter.
  • Loading branch information
jefftmahoney authored and mefjush committed May 21, 2024
1 parent 5942d60 commit e43821b
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions modules/sharethroughAnalyticsAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Overview

```txt
Module Name: Sharethrough Analytics Adapter
Module Type: Analytics Adapter
Maintainer: [email protected]
```

#### About

This analytics adapter collects data about win/loss events (beacon firings) from each auction run on your site. This data is communicated to Sharethrough via API calls the analytics adapter makes to an endpoint dedicated to the collection of beacon information. Sharethrough uses this information to improve its services as a SSP.

This analytics adapter is free to use.

#### Configuration

In order to guarantee consistent reporting events, we recommend
including the GPT Pre-Auction Module, `gptPreAuction`. This module is included
by default when Prebid is downloaded.

If you are compiling from source, this might look something like:

```sh
gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Please note that the above snippet is a "bare bones" example - you will likely want to include other modules as well. A more realistic example might look something like the example below (with other bid adapters also included in the list as needed):

```sh
gulp bundle --modules=gptPreAuction,consentManagement,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,gdprEnforcement,sharethroughBidAdapter,sharethroughAnalyticsAdapter
```

Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider `sharethrough` as seen in the example below.

#### Example Configuration

```js
pbjs.enableAnalytics({
provider: 'sharethrough',
});
```

0 comments on commit e43821b

Please sign in to comment.