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 all 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
55 changes: 55 additions & 0 deletions prebid-server/pbs-modules/greenbids-analytics-reporter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
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 the Greenbids Analytics Server by sending it the information about bids for the publisher inventory sold through PBS. The Greenbids Analytics module requires setup and approval from the Greenbids team for each publisher. Please reach out to our team for more information [greenbids.ai](https://greenbids.ai).

## Configuration

The Greenbids Analytics Reporter references global parameters defined in application.yaml. For example:

```yaml
analytics:
greenbids:
analytics-server-version: "2.2.0"
analytics-server: http://localhost:8090
exploratory-sampling-split: 0.9
timeout-ms: 10000
```

Here's a description of the global parameters:

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

The Greenbids Analytics module also includes account-specific parameters for each publisher setup. These parameters should be included in the extension of the bid request json: `ext.prebid.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 |

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

```json
"ext": {
"prebid": {
"analytics": {
"greenbids": {
"pbuid": "PUBID_FROM_GREENBIDS",
"greenbidsSampling": 1.0
}
}
}
}
```