Skip to content

Commit

Permalink
Update sharethrough.md
Browse files Browse the repository at this point in the history
* Enhancing the existing documentation with details regarding registration and configuration.
  • Loading branch information
jefftmahoney committed May 22, 2024
1 parent 172ae66 commit 5fd2981
Showing 1 changed file with 33 additions and 1 deletion.
34 changes: 33 additions & 1 deletion dev-docs/analytics/sharethrough.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,36 @@ modulecode: sharethrough

#### Registration

Please visit [www.sharethrough.com](https://www.sharethrough.com/) for more information.
This module is free to use.

#### 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.

#### Example Configuration

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

#### Compiling from Source (Optional)

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 Configuration** section.

0 comments on commit 5fd2981

Please sign in to comment.