Skip to content

Commit e59fa05

Browse files
authored
Update sharethrough.md (prebid#5332)
* Enhancing the existing documentation with details regarding registration and configuration.
1 parent d477519 commit e59fa05

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

dev-docs/analytics/sharethrough.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,36 @@ modulecode: sharethrough
77

88
#### Registration
99

10-
Please visit [www.sharethrough.com](https://www.sharethrough.com/) for more information.
10+
This module is free to use.
11+
12+
#### About
13+
14+
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.
15+
16+
#### Example Configuration
17+
18+
```js
19+
pbjs.enableAnalytics({
20+
provider: 'sharethrough',
21+
})
22+
```
23+
24+
#### Compiling from Source (Optional)
25+
26+
In order to guarantee consistent reporting events, we recommend
27+
including the GPT Pre-Auction Module, `gptPreAuction`. This module is included
28+
by default when Prebid is downloaded.
29+
30+
If you are compiling from source, this might look something like:
31+
32+
```sh
33+
gulp bundle --modules=gptPreAuction,sharethroughBidAdapter,sharethroughAnalyticsAdapter
34+
```
35+
36+
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):
37+
38+
```sh
39+
gulp bundle --modules=gptPreAuction,consentManagement,consentManagementGpp,consentManagementUsp,enrichmentFpdModule,gdprEnforcement,sharethroughBidAdapter,sharethroughAnalyticsAdapter
40+
```
41+
42+
Enable the Sharethrough Analytics Adapter in Prebid.js using the analytics provider `sharethrough` as seen in the **Example Configuration** section.

0 commit comments

Comments
 (0)