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

Initial document for groupm as pubmatic alias #3399

Merged
merged 2 commits into from
Feb 3, 2022
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
90 changes: 90 additions & 0 deletions dev-docs/bidders/groupm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
layout: bidder
title: GroupM
description: Prebid GroupM Bidder Adaptor
biddercode: groupm
aliasCode: pubmatic
media_types: banner, video, native
gdpr_supported: true
usp_supported: true
coppa_supported: true
schain_supported: true
floors_supported: true
userIds: all
prebid_member: true
safeframes_ok: true
pbjs: true
pbs: true
pbs_app_supported: true
fpd_supported: true
gvl_id: 98
---


### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|--------------------|------------------------------|----------|
| `publisherId` | required | Publisher ID | `'32572'` | `string` |
| `adSlot` | optional | Ad Slot Name (see below)| `'38519891'` | `string` |
| `pmzoneid` | optional | Zone ID | `'zone1,zone2'` | `string` |
| `lat` | optional | Latitude | `'40.712775'` | `string` |
| `lon` | optional | Longitude | `'-74.005973'` | `string` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pm-isha-bharti I see that the bidder params listed here don't exactly match what you have in Prebid Server. These docs are meant to communicate to the Publisher enabling Groupm as a bidder what parameters they need to pass to Prebid Server in the request for the Groupm bidder and so they should match what you have specified in the static/bidder-params/groupm.json file in the Prebid Server PR

Copy link
Contributor Author

@pm-isha-bharti pm-isha-bharti Nov 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mansinahar The params that I have mentioned are supported at the prebid JS end and since groupM is an alias of pubmatic, I have kept the params similar to pubmatic.md
Should I add a separate section( "Prebid Server Test Request" ) for prebid-server request in the same document as I can see this section in other bidders docs as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pm-isha-bharti Ah ok! But I still see wrapper and keywords in the prebid server params file for Groupm but not in this doc. Can you please include those as well? And yeah, I think adding a test Prebid Server request is a good idea. Thanks!

| `yob` | optional | Year of Birth | `'1982'` | `string` |
| `gender` | optional | Gender | `'M'` | `string` |
| `kadpageurl` | optional | Overrides Page URL | `'http://www.yahoo.com/'`| `string` |
| `kadfloor` | optional | Bid Floor | `'1.75'` | `string` |
| `currency` | optional | Bid currency | `'AUD'` (Value configured only in the 1st adunit will be passed on. <br/> Values if present in subsequent adunits, will be ignored.) | `string` |
| `dctr` | optional | Deal Custom Targeting <br/> (Value configured only in the 1st adunit will be passed on. <br/> Values if present in subsequent adunits, will be ignored.) | `'key1=123\|key2=345'` | `string` |
| `bcat` | optional | Blocked IAB Categories <br/> (Values from all slots will be combined and only unique values will be passed. An array of strings only. Each category should be a string of a length of more than 3 characters.) | `[ 'IAB1-5', 'IAB1-6', 'IAB1-7' ]` | `array of strings` |
| `deals` | optional | PMP deals <br/> (Values from each slot will be passed per slot. An array of strings only. Each deal-id should be a string of a length of more than 3 characters.) | `[ 'deal-id-5', 'deal-id-6', 'deal-id-7' ]` | `array of strings` |
| `outstreamAU` | optional | Oustream AdUnit described in Blue BillyWig UI. This field is mandatory if mimeType is described as video and context is outstream (i.e., for outstream videos) | `'renderer_test_groupm'` | `string` |

GroupM is an aliased bidder of PubMatic

### Prebid Server Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|--------------------|------------------------------|----------|
| `publisherId` | required | Publisher ID | `"32572"` | `string` |
| `adSlot` | optional | Ad Slot Name | `"38519891"` | `string` |
| `pmzoneid` | optional | Comma separated zone id. Used im deal targeting & site section targeting. e.g drama,sport| `"zone1,zone2"` | `string` |
| `dctr` | optional | Deal Custom Targeting, pipe separated key-value pairs| `"key1=123\|key2=345"` | `string` |
| `wrapper` | optional | Specifies GroupM openwrap configuration for a publisher | `"wrapper": { "profile": 123, "version": 1}` | `object` |
| `keywords` | optional | A set of key-value pairs; A key can have one or more values associated with it. They are used in buy-side segment targeting.| `"keywords": { "genre": ["rock", "pop"] }` | `object` |



### Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the
GroupM adapter. This example includes an `imp` object with an GroupM test publisher ID, ad slot,
and sizes that would match with the test creative.

```
"imp":[
{
"id":“"some-impression-id”,
"banner":{
"format":[
{
"w":300,
"h":250
},
{
"w":300,
"h":600
}
]
},
"ext":{
"groupm":{
"publisherId":“156276”,
"adSlot":"groupm_test"
}
}
}
]
```