Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description of PBS Greenbids Analytics Reporter #5490

Merged
merged 5 commits into from
Aug 22, 2024
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions prebid-server/pbs-modules/greenbids-analytics-reporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: page_v2
page_type: pbs-module
title: Prebid Server Greenbids PBS Analytics Reporter
display_name : Prebid Server Greenbids Analytics Reporter
sidebarType : 5
---

## Overview

This analytics adapter communicates with Greenbids Analytics Server by sending to it the information about the SSP bids for the publisher inventory sold throguh PBS. For the publishers the incoming requests to the Greenbids Analytics Reporter require setup and approval from the Greenbids team. Please reach out to our team for more information [greenbids.ai](https://greenbids.ai).

## Configuration

Greenbids Analytics Reporter contains the static parameters defined in [application.yaml](https://github.com/EvgeniiMunin/prebid-server-java/blob/a2e376c14680108683483719d212d330f8f66742/src/main/resources/application.yaml#L296)

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| analytics-server-version | string | Version of Analytics Schema Greenbids side |
| analytics-server | string | Greenbids Analytics Server URL |
| exploratory-sampling-split | float | Exploration vs Exploitation ratio of analytics traffic |
| timeout-ms | int | Timeout limit on sending POST request to Greenbids Analytics Server |

Greenbids Analytics Reporter also includes the parameters specific for each publisher setup. These parameters should be included into the extension of the bid request json: `ext.analytics.greenbids`
EvgeniiMunin marked this conversation as resolved.
Show resolved Hide resolved

| Parameter | Scope | Description | Example | Type |
| --------- | ---- | ------------- | ------------- | ----------- |
| pbuid | required | The Greenbids Publisher ID | greenbids-publisher-1 | string |
| greenbidsSampling | optional | sampling factor [0-1] (a value of 0.1 will filter 90% of the traffic) | 1.0 | float |

The example of publisher config in the bid request extension is as follows:

```json
"ext": {
"analytics": {
"greenbids": {
"pbuid": "PBUID_FROM_GREENBIDS",
"greenbidsSampling": 0.1
}
}
}
```