-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
43 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,6 @@ | |
layout: page_v2 | ||
sidebarType: 5 | ||
title: Prebid Server | Developers | Adding a Module | ||
|
||
--- | ||
|
||
# Prebid Server - Adding a Module | ||
|
@@ -11,7 +10,7 @@ title: Prebid Server | Developers | Adding a Module | |
This document guides you through the process of developing a module for host companies to plug into their instance of Prebid Server. | ||
We encourage you to look at existing modules for working examples. You can also ask us questions by [submitting a GitHub issue](https://github.com/prebid/prebid-server/issues/new). | ||
|
||
* TOC | ||
- TOC | ||
{:toc } | ||
|
||
## Overview | ||
|
@@ -142,6 +141,7 @@ to the PBS host company. Examples: | |
If your module either utilizes or supplies user-level data like User First Party Data or precise geographic information, it must adhere to the framework supplied by the [Activity Controls](/prebid-server/features/pbs-activitycontrols.html). | ||
|
||
For instance: | ||
|
||
- if your module is going to supply user-level data (e.g. "job title") to bid adapters, it must check permissions for the `enrichUfpd` activity. | ||
- if your module is going to forward the entire ORTB request to an endpoint, it must check the `transmitUfpd` and `transmitPreciseGeo` activity permissions. | ||
|
||
|
@@ -173,7 +173,7 @@ The details of the implementation depend on the platform. | |
Other rules for open source PBS pull request: | ||
|
||
- Unit test coverage must exceed 90%. | ||
- A maintainer email address must be provided and be a group, not an individual. e.g. "[email protected] rather than [email protected] | ||
- A maintainer email address must be provided and be a group, not an individual. e.g. <[email protected]> rather than <[email protected]> | ||
|
||
### 10. Write the Module Documentation | ||
|
||
|
@@ -184,7 +184,7 @@ create a file in /prebid-server/pbs-modules. You can start by copying one of the | |
- Prerequisites: any necessary account activation, other required modules, etc. | ||
- Configuration: both init and runtime | ||
- Analytics Tag support | ||
- Privacy Support: disclose whether the module has user privacy implications and support for TCF-EU, TCF-CA, CCPA, MSPA, etc. | ||
- Privacy Support: disclose whether the module has user privacy implications and support for TCF-EU, TCF-CA, CCPA, etc. | ||
|
||
### 11. Submit the Pull Requests | ||
|
||
|
Oops, something went wrong.