From 9f84a5716f18f565d500a1ca0b8f4438a058cd6c Mon Sep 17 00:00:00 2001 From: Susan Date: Wed, 11 Dec 2019 10:55:25 -0800 Subject: [PATCH 01/10] specifies us privacy is supported --- dev-docs/bidders/gumgum.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 4d9acc15bc..2914138695 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -8,6 +8,7 @@ media_types: native schain_supported: true userIds: unifiedId/tradedesk, digitrustId gdpr_supported: true +usp_supported: true --- ### Note: From 8dcd24d1d64731b1505f4a9610ef77cb1068daad Mon Sep 17 00:00:00 2001 From: Susan Date: Wed, 12 Feb 2020 08:50:40 -0800 Subject: [PATCH 02/10] adds video support to gumgum md --- dev-docs/bidders/gumgum.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 4e540e4107..273c732589 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -4,7 +4,7 @@ title: GumGum description: Prebid GumGum Bidder Adaptor hide: true biddercode: gumgum -media_types: native +media_types: banner, video schain_supported: true userIds: unifiedId/tradedesk, digitrustId gdpr_supported: true @@ -25,3 +25,4 @@ information. | `inScreen` | optional | Tracking ID | `'ggumtest'` | `string` | | `inScreenPubID`| optional | Publisher ID| `123` | `integer` | | `inSlot` | optional | Slot ID | `9` | `integer` | +| `video` | optional | Tracking ID | `'ggumtest'` | `string` | From 2bf57d4e9b0066a410433cf1b0b8e37d4cc05c48 Mon Sep 17 00:00:00 2001 From: Susan Date: Wed, 25 Mar 2020 11:28:36 -0700 Subject: [PATCH 03/10] adds support for tcf 2 --- dev-docs/bidders/gumgum.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 273c732589..e65635be4d 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -9,6 +9,7 @@ schain_supported: true userIds: unifiedId/tradedesk, digitrustId gdpr_supported: true usp_supported: true +tcf2_supported: true --- ### Note: From 9a46fba61f89a688b2ff9e18481486efd227df56 Mon Sep 17 00:00:00 2001 From: Susan Date: Fri, 22 May 2020 14:52:06 -0700 Subject: [PATCH 04/10] adds new bid param to gumgum.md --- dev-docs/bidders/gumgum.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 2cbb7a71cc..c129461d0c 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -27,4 +27,5 @@ information. | `inScreenPubID`| optional | Publisher ID| `123` | `integer` | | `inSlot` | optional | Slot ID | `9` | `integer` | | `video` | optional | Tracking ID | `'ggumtest'` | `string` | +| `videoPubID` | optional | Publisher ID| `123` | `integer` | | `inVideo` | optional | Tracking ID | `'ggumtest'` | `string` | From 3961bc6994044bed9c574697d7fd7eaa5fc46dc0 Mon Sep 17 00:00:00 2001 From: Susan Date: Fri, 25 Sep 2020 14:26:08 -0700 Subject: [PATCH 05/10] updates gumgum doc --- dev-docs/bidders/gumgum.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index fdb80a4dcc..4fa35521f5 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -19,18 +19,25 @@ The GumGum Header Bidding adaptor requires setup and approval from the GumGum team. Please reach out to your account manager or for more information. -### Bid Params +### Server and Client Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|----------|-------------|--------------|-----------| -| `zone` | optional | Tracking ID | `'ggumtest'` | `string` | -| `pubId` | optional | Publisher ID| `123` | `integer` | -| `slot` | optional | Slot ID | `9` | `integer` | -| `native` | optional | Native ID | `19` | `integer` | -| `inScreen` | optional | Tracking ID | `'ggumtest'` | `string` | -| `inScreenPubID`| optional | Publisher ID| `123` | `integer` | -| `inSlot` | optional | Slot ID | `9` | `integer` | -| `video` | optional | Tracking ID | `'ggumtest'` | `string` | -| `videoPubID` | optional | Publisher ID| `123` | `integer` | -| `inVideo` | optional | Tracking ID | `'ggumtest'` | `string` | +| Name | Scope | Description | Example | Type | +|----------------|----------|-------------------|------------------------|-----------| +| `zone` | optional | Tracking ID | `'ggumtest'` | `string` | + +# Client Side only Bid Params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|----------------|----------|-------------------|------------------------|-----------| +| `pubId` | optional | Publisher ID | `123` | `integer` | +| `slot` | optional | Slot ID | `9` | `integer` | +| `native` | optional | Native ID | `19` | `integer` | +| `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | +| `inScreen` | optional | Tracking ID | `'ggumtest'` | `string` | +| `inScreenPubID`| optional | Publisher ID | `123` | `integer` | +| `inSlot` | optional | Slot ID | `9` | `integer` | +| `video` | optional | Tracking ID | `'ggumtest'` | `string` | +| `videoPubID` | optional | Publisher ID | `123` | `integer` | +| `inVideo` | optional | Tracking ID | `'ggumtest'` | `string` | From a58f5f1fd2d825e789dc3b8ec3b56253956430b7 Mon Sep 17 00:00:00 2001 From: Susan Date: Thu, 3 Dec 2020 14:00:14 -0800 Subject: [PATCH 06/10] notes required mediaType for video products --- dev-docs/bidders/gumgum.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 9906bc858f..dd2498d6ce 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -42,3 +42,7 @@ information. | `video` | optional | Tracking ID | `'ggumtest'` | `string` | | `videoPubID` | optional | Publisher ID | `123` | `integer` | | `inVideo` | optional | Tracking ID | `'ggumtest'` | `string` | + + +Please note that both video and in-video products require a mediaType of video. +All other products (in-screen, slot, native) should have a mediaType of banner. \ No newline at end of file From ebac7517350d6794ea5e80258a8d18e6f68db919 Mon Sep 17 00:00:00 2001 From: Susan Date: Wed, 9 Dec 2020 12:16:19 -0800 Subject: [PATCH 07/10] updates gumgum doc --- dev-docs/bidders/gumgum.md | 207 +++++++++++++++++++++++++++++++++---- 1 file changed, 188 insertions(+), 19 deletions(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index dd2498d6ce..63a9be2876 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -20,29 +20,198 @@ The GumGum Header Bidding adaptor requires setup and approval from the GumGum team. Please reach out to your account manager or for more information. -### Server and Client Side Bid Params + +Client side and server side parameters differ slightly. For Server side (Prebid S2S) implementation, + we currently accept the `zone` parameter. For Client side (Prebid.js) implementation, we accept `zone` and + a long list of other parameters which are listed below. + +### Server Side Bid Params {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |----------------|----------|-------------------|------------------------|-----------| -| `zone` | optional | Tracking ID | `'ggumtest'` | `string` | +| `zone` | required | Tracking ID | `'ggumtest'` | `string` | -# Client Side only Bid Params +### Client Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|----------|-------------------|------------------------|-----------| -| `pubId` | optional | Publisher ID | `123` | `integer` | -| `slot` | optional | Slot ID | `9` | `integer` | -| `native` | optional | Native ID | `19` | `integer` | -| `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | -| `inScreen` | optional | Tracking ID | `'ggumtest'` | `string` | -| `inScreenPubID`| optional | Publisher ID | `123` | `integer` | -| `inSlot` | optional | Slot ID | `9` | `integer` | -| `video` | optional | Tracking ID | `'ggumtest'` | `string` | -| `videoPubID` | optional | Publisher ID | `123` | `integer` | -| `inVideo` | optional | Tracking ID | `'ggumtest'` | `string` | - - -Please note that both video and in-video products require a mediaType of video. -All other products (in-screen, slot, native) should have a mediaType of banner. \ No newline at end of file +| Name | Scope | Description | Example | Type | +|----------------|--------------------------------------------|-------------------|------------------------|-----------| +| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | +| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | +| `slot` | required for slot placement only | Slot ID | `9` | `integer` | +| `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | +| `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | + +### Legacy Client Side Bid Params +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|----------------|---------------------------------------|-------------------|------------------------|-----------| +| `inScreen` | required for in-screen placement only | Tracking ID | `'ggumtest'` | `string` | +| `inScreenPubID`| required for in-screen placement only | Publisher ID | `123` | `integer` | +| `inSlot` | required for slot placement only | Slot ID | `9` | `integer` | +| `video` | required for video placement only | Tracking ID | `'ggumtest'` | `string` | +| `videoPubID` | required for video placement only | Publisher ID | `123` | `integer` | +| `inVideo` | required for in-video placement only | Tracking ID | `'ggumtest'` | `string` | +| `ICV` | required for ICV placement only | ICV ID | `19` | `integer` | +| `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | + +Please note that both video and in-video products require a mediaType of video while all other products +require a mediaType of banner. + +### Client Side Examples +Client side integration currently supports slot, in-screen, video, and in-video products. +The following examples are based on the 'Client Side Bid Params' table. +All bid requests require a zone or pubId parameter: + + { + bidder: 'gumgum', + params: { + zone: 'zone_id' // provided by GumGum + } + } + +To enable ad requests at a publisher level, instead of `zone` use `pubId`: + + { + bidder: 'gumgum', + params: { + pubId: pub_id // provided by GumGum + } + } + +#### In-Screen +To enable ad requests for in-screen, either `zone` or `pubId` must be present in the params object: + + { + bidder: 'gumgum', + params: { + zone: 'zone_id' // provided by GumGum + } + } + +#### Slot +Slot ad requests require the `slot` parameter in the params object: + + { + bidder: 'gumgum', + params: { + zone: 'zone_id', // provided by GumGum + slot: 'slot_id' // provided by GumGum + } + } + +#### Video and In-Video +For video and in-video products, please follow the configuration shown under the in-screen example. +Additionally, you will need to define a 'video' field in the 'mediaTypes' object. For example: + + { + mediaTypes: { + video: { + context: 'instream', + playerSize: [640, 480], + minduration: 1, + maxduration: 2, + linearity: 1, // ** Change this to 2 for in-video + startdelay: 1, + placement: 1, + protocols: [1, 2] + } + } + } + +Please note: + +All fields under video (context, playerSize, minDuration etc) are the minimum requirements to make a video ad request. +You should replace playerSize, minduration, maxduration, startdelay, placement, and protocols values to your +specifications (see [OpenRTB spec 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) for more information). +`linearity` should be set to 1 for video product, and 2 for in-video. + + +### Server Side Examples +At the moment, the only products supported via Prebid S2S are slot, in-screen, and video. +The configuration is similar to client side configuration. +Add the following object in your `bids` array: + + { + bidder: 'gumgum', + params: { + zone: 'zone_id', // provided by GumGum + } + } + +#### Slot +The mediaTypes field should have ‘banner’ with sizes using standard IAB display sizes (as seen in the example below). +The zone id is provided by GumGum. + + { + mediaTypes: { + banner: { + sizes: [[300, 250], [300, 600]] + } + }, + bids: [ + { + bidder: 'gumgum', + params: { + zone: 'zone_id' // zone id is provided by GumGum + } + }, + ] + } + +#### In-Screen +The adUnits settings for both in-screen and slot have a similar structure. The only difference between slot +and in-screen ad unit configuration is the sizes. +In-screen products require a non-standard IAB display size (e.g. [1, 1] as seen in the example below or any +other size you choose). + + { + mediaTypes: { + banner: { + sizes: [[1, 1]] + } + }, + bids: [ + { + bidder: 'gumgum', + params: { + zone: 'zone_id' // zone id is provided by GumGum + } + }, + ] + } + +#### Video +The video product requires nearly the same setup as with Prebid client side header bidding: + + { + mediaTypes: { + video: { + context: 'instream', + mimes: ['video/mp4'], + playerSize: [640, 480], + w: 640, + h: 480, + minduration: 1, + maxduration: 2, + linearity: 1, + startdelay: 1, + placement: 1, + protocols: [1, 2] + } + }, + bids: [ + { + bidder: 'gumgum', + params: { + zone: 'zone_id' // zone id is provided by GumGum + } + }, + ] + } + +All fields under video (context, playerSize, minDuration etc) are the minimum requirements +to make a video ad request. Please replace playerSize, w, h, mimes, minduration, maxduration, +startdelay, and protocols values to your specifications (see [OpenRTB spec 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) for more information). + From fd27d1135d0426b704e9c50bcae395d667c01ab1 Mon Sep 17 00:00:00 2001 From: Susan Date: Thu, 21 Jan 2021 10:53:24 -0800 Subject: [PATCH 08/10] adds pubId and irisid params --- dev-docs/bidders/gumgum.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 3189be731e..a33060d591 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -29,9 +29,11 @@ Client side and server side parameters differ slightly. For Server side (Prebid ### Server Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|----------|-------------------|------------------------|-----------| -| `zone` | required | Tracking ID | `'ggumtest'` | `string` | +| Name | Scope | Description | Example | Type | +|----------------|--------------------------------------------|-------------------|------------------------|-----------| +| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | +| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | +| `irisid` | optional | Iris.tv ID | `'iris_6f9285823a4'` | `string` | ### Client Side Bid Params @@ -45,6 +47,7 @@ Client side and server side parameters differ slightly. For Server side (Prebid | `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | ### Legacy Client Side Bid Params + {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |----------------|---------------------------------------|-------------------|------------------------|-----------| From 5dc0aa9427451bd9ecafa02f99e4ec9e050592e7 Mon Sep 17 00:00:00 2001 From: Susan Date: Thu, 21 Jan 2021 10:57:06 -0800 Subject: [PATCH 09/10] removes extra cell --- dev-docs/bidders/gumgum.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index 6a3aab4dca..ba32f9a8d4 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -44,7 +44,7 @@ Client side and server side parameters differ slightly. For Server side (Prebid | `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | | `slot` | required for slot placement only | Slot ID | `9` | `integer` | | `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | -| `irisid` | optional | Iris.tv ID | Iris.tv IDs | `'123'` | `string` | +| `irisid` | optional | Iris.tv ID | `'123'` | `string` | | `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | ### Legacy Client Side Bid Params From 141fa78b793a9f88354b1d0600391f0e4930a47c Mon Sep 17 00:00:00 2001 From: Susan Date: Thu, 4 Mar 2021 09:42:06 -0800 Subject: [PATCH 10/10] updates doc to include that bidfloor is in usd --- dev-docs/bidders/gumgum.md | 46 +++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/dev-docs/bidders/gumgum.md b/dev-docs/bidders/gumgum.md index ba32f9a8d4..af86cf61bf 100644 --- a/dev-docs/bidders/gumgum.md +++ b/dev-docs/bidders/gumgum.md @@ -29,37 +29,37 @@ Client side and server side parameters differ slightly. For Server side (Prebid ### Server Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|--------------------------------------------|-------------------|------------------------|-----------| -| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | -| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | -| `irisid` | optional | Iris.tv ID | `'iris_6f9285823a4'` | `string` | +| Name | Scope | Description | Example | Type | +|----------------|--------------------------------------------|-----------------------|------------------------|-----------| +| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | +| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | +| `irisid` | optional | Iris.tv ID | `'iris_6f9285823a4'` | `string` | ### Client Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|--------------------------------------------|-------------------|------------------------|-----------| -| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | -| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | -| `slot` | required for slot placement only | Slot ID | `9` | `integer` | -| `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | -| `irisid` | optional | Iris.tv ID | `'123'` | `string` | -| `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | +| Name | Scope | Description | Example | Type | +|----------------|--------------------------------------------|-----------------------|------------------------|-----------| +| `zone` | pubId or zone required for all bid requests| Tracking ID | `'ggumtest'` | `string` | +| `pubId` | pubId or zone required for all bid requests| Publisher ID | `123` | `integer` | +| `slot` | required for slot placement only | Slot ID | `9` | `integer` | +| `iriscat` | optional | Iris.tv segments | `'segment1,segment2'` | `string` | +| `irisid` | optional | Iris.tv ID | `'123'` | `string` | +| `bidfloor` | optional | CPM bidfloor in USD | `0.03` | `float` | ### Legacy Client Side Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|----------------|---------------------------------------|-------------------|------------------------|-----------| -| `inScreen` | required for in-screen placement only | Tracking ID | `'ggumtest'` | `string` | -| `inScreenPubID`| required for in-screen placement only | Publisher ID | `123` | `integer` | -| `inSlot` | required for slot placement only | Slot ID | `9` | `integer` | -| `video` | required for video placement only | Tracking ID | `'ggumtest'` | `string` | -| `videoPubID` | required for video placement only | Publisher ID | `123` | `integer` | -| `inVideo` | required for in-video placement only | Tracking ID | `'ggumtest'` | `string` | -| `ICV` | required for ICV placement only | ICV ID | `19` | `integer` | -| `bidfloor` | optional | CPM bidfloor | `0.03` | `float` | +| Name | Scope | Description | Example | Type | +|----------------|--------------------------------------------|-----------------------|------------------------|-----------| +| `inScreen` | required for in-screen placement only | Tracking ID | `'ggumtest'` | `string` | +| `inScreenPubID`| required for in-screen placement only | Publisher ID | `123` | `integer` | +| `inSlot` | required for slot placement only | Slot ID | `9` | `integer` | +| `video` | required for video placement only | Tracking ID | `'ggumtest'` | `string` | +| `videoPubID` | required for video placement only | Publisher ID | `123` | `integer` | +| `inVideo` | required for in-video placement only | Tracking ID | `'ggumtest'` | `string` | +| `ICV` | required for ICV placement only | ICV ID | `19` | `integer` | +| `bidfloor` | optional | CPM bidfloor in USD | `0.03` | `float` | Please note that both video and in-video products require a mediaType of video while all other products require a mediaType of banner.