This is the Java version of Prebid Server. See the Prebid Server Feature List and FAQ entry to understand the differences between PBS-Java and PBS-Go.
Prebid Server is an open source implementation of Server-Side Header Bidding. It is managed by Prebid.org, and upholds the principles from the Prebid Code of Conduct.
This project does not support the same set of Bidders as Prebid.js, although there is overlap. The current set can be found in the adapters package. If you don't see the one you want, feel free to contribute it.
For more information, see:
Please consider registering your Prebid Server to get on the mailing list for updates, etc.
The server makes the following assumptions:
- No ranking or decisioning is performed by this server. It just proxies requests.
- No ad quality management (e.g., malware, viruses, deceptive creatives) is performed by this server.
- This server does no fraud scanning and does nothing to prevent bad traffic.
- This server logs errors but not requests.
- This server has no user profiling or user data collection capabilities.
This project is built upon Vert.x to achieve high request throughput. We use Maven and attempt to introduce minimal dependencies.
When running, the server responds to several HTTP endpoints.
Follow next steps to create JAR file which can be deployed locally.
-
Install prerequsites
- Java SDK: Oracle's or Corretto. Let us know if there's a distribution PBS-Java doesn't work with.
- Maven
-
Clone the project:
git clone https://github.com/prebid/prebid-server-java.git- Move to project directory:
cd prebid-server-javaAnd from this step there are two common use cases, which can be chosen depending on your goals
- Create prebid-server JAR only
- First, make sure nothing's running on your local port 8080 or 8090
- Run below command to build project:
mvn clean package- Create prebid-server JAR with modules
- Run below command to build project:
mvn clean package --file extra/pom.xmlFor more information how to build the server follow documentation.
The source code includes an example configuration file sample/prebid-config.yaml.
Also, check the account settings file sample/sample-app-settings.yaml.
For more information how to configure the server follow documentation. There are many settings you'll want to consider such as which bidders you're going to enable, privacy defaults, admin endpoints, etc.
Run your local server with the command:
java -jar target/prebid-server.jar --spring.config.additional-location=sample/prebid-config.yamlFor more options how to start the server, please follow documentation.
Starting from PBS Java v2.9, you can download prebuilt .jar packages from Release Notes page, instead of building them by yourself. This prebuilt packages are delivered with or without extra modules.
To check the server is started go to http://localhost:8080/status
and verify response status is 200 OK.
There are a couple of 'hello world' test requests described in sample/requests/README.txt
Starting from PBS Java v2.9, you can download prebuilt Docker images from GitHub Packages page, and use them instead of plain .jar files. This prebuilt images are delivered with or without extra modules.
In order to run such image correctly, you should attach PBS config file. Easiest way is to mount config file into container,
using --mount or --volume (-v) Docker CLI arguments.
Keep in mind, that config file should be mounted into specific location: /app/prebid-server/ or /app/prebid-server/conf/.
- Endpoints
- Adding new bidder
- Adding new analytics module
- Adding viewability support
- Auction result post-processing
- Cookie Syncs
- Stored Requests
- Unit Tests
- Functional Tests
- GDPR