diff --git a/dev-docs/bidders/9MediaOnline.md b/dev-docs/bidders/9MediaOnline.md deleted file mode 100644 index 3e337a1da8..0000000000 --- a/dev-docs/bidders/9MediaOnline.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: bidder -title: 9 Media Online -description: Prebid 9 Media Online Bidder Adaptor -biddercode: 9MediaOnline -pbjs: true -media_types: banner, video -gvl_id: 644 -tcfeu_supported: true -tcf2_supported: true -schain_supported: true -usp_supported: true -userIds: id5Id, unifiedId -aliasCode: gamoshi -sidebarType: 1 ---- - -### Bid params - -{: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|-------------------|----------|---------------------------------------------------------------|----------------------|----------| -| `supplyPartnerId` | required | ID of the supply partner | `'12345'` | `string` | diff --git a/dev-docs/bidders/cleanmedianet.md b/dev-docs/bidders/cleanmedianet.md index 2035fd58e0..920038d7c7 100644 --- a/dev-docs/bidders/cleanmedianet.md +++ b/dev-docs/bidders/cleanmedianet.md @@ -4,30 +4,151 @@ title: Clean Media Net description: Clean Media Bidder Adapter biddercode: cleanmedianet pbjs: true +pbs: true media_types: banner, video -tcfeu_supported: false -usp_supported: true -coppa_supported: false +userIds: all +gvl_id: 644 +tcfeu_supported: true +tcf2_supported: true schain_supported: true -floors_supported: true -userIds: -prebid_member: false -safeframes_ok: true -deals_supported: false -pbs_app_supported: false -fpd_supported: false -ortb_blocking_supported: false -gvl_id: -multiformat_supported: will-bid-on-any +usp_supported: true +ortb_blocking_supported: true +multiformat_supported: will-bid-on-one +sidebarType: 1 +aliasCode: gamoshi --- -### Disclosure - -Note: This bidder appears to only consider gdprApplies if a consent string is available. This may result in some incorrect GDPR processing, such as when the consent string is not yet available but the publisher has decided GDPR always applies. See - ### Bid params {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | -|-------------------+----------+--------------------------------------------------------+-------------------------+---------| -| `supplyPartnerId` | required | The supply account's ID in your Clean Media dashboard. | `"1253"`, `"1254"`, etc | string | +|-------------------|----------|---------------------------------------------------------------|----------------------|----------| +| `supplyPartnerId` or `inventory_id` or `supply_partner_id` | required | ID of the supply partner. This parameter can be either a `string` or `integer` for Prebid.js, however `integer` is preferred | `12345` | `integer` | +| `bidfloor` | optional | Minimum acceptable bid price. Must be a positive number. | `0.5` | `number` | +| `instl` | optional | Interstitial flag (1 for interstitial, 0 for non-interstitial). | `1` | `integer` | +| `pos` | optional | Ad position on the page. | `1` | `integer` | +| `video` | optional | Object containing video targeting parameters. See [Video Object](#video-object) for details. | `video: { playback_method: ['auto_play_sound_off'] }` | `object` | + +This adapter only requires you to provide your Inventory Id (Supply partner id), and optionally your RTB endpoint. + +#### Video Object + +For details on how these video params work with the params set in the adUnit.mediaTypes.video object. + +{: .table .table-bordered .table-striped } +| Name | Description | Type | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| `minduration` | Integer that defines the minimum video ad duration in seconds. | `integer` | +| `maxduration` | Integer that defines the maximum video ad duration in seconds. | `integer` | +| `protocols` | Array of integers listing the supported video protocols (VAST versions). | `Array` | +| `mimes` | Array of strings listing the supported MIME types for the video creative. | `Array` | +| `pos` | Ad position on the screen. | `integer` | +| `api` | Array of integers listing the supported API frameworks. | `Array` | +| `skip` | Indicates if the player will allow the video to be skipped (0 = no, 1 = yes). | `integer` | +| `plcmt` | Video placement type. | `integer` | +| `placement` | Placement type for the impression. | `integer` | +| `playbackmethod` | Array of integers listing the playback methods. | `Array` | +| `startdelay` | Indicates the offset of the ad placement from the start of the video content. | `integer` | +| `context` | Content context (e.g., 'instream', 'outstream'). | `string` | + +### Example Ad Unit Configurations + +#### Banner Ad Unit + +```javascript +var adUnits = [ + { + code: 'banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250], [728, 90]] + } + }, + bids: [ + { + bidder: 'cleanmedianet', + params: { + supplyPartnerId: 12345, + bidfloor: 0.5, + pos: 1 + } + } + ] + } +]; +``` + +#### Video Ad Unit (Instream) + +```javascript +var adUnits = [ + { + code: 'video-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'instream', + mimes: ['video/mp4', 'video/webm'], + protocols: [2, 3, 5, 6], + maxduration: 30, + api: [1, 2] + } + }, + bids: [ + { + bidder: 'cleanmedianet', + params: { + supplyPartnerId: 12345, + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + skip: 1, + startdelay: 0, + api: [1, 2], + plcmt: 1 + } + } + } + ] + } +]; +``` + +#### Video Ad Unit (Outstream) + +```javascript +var adUnits = [ + { + code: 'outstream-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'outstream', + mimes: ['video/mp4', 'video/webm'] + } + }, + bids: [ + { + bidder: 'cleanmedianet', + params: { + supplyPartnerId: 12345, + rendererUrl: 'https://example.com/outstream-renderer.js', + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + placement: 3, + plcmt: 3, + context: 'outstream' + } + } + } + ] + } +]; +``` diff --git a/dev-docs/bidders/gambid.md b/dev-docs/bidders/gambid.md index 1e2eada831..33ab5e4031 100644 --- a/dev-docs/bidders/gambid.md +++ b/dev-docs/bidders/gambid.md @@ -1,22 +1,153 @@ --- layout: bidder title: Gambid -description: Prebid Gambid Bidder Adaptor - -top_nav_section: dev_docs -nav_section: reference - +description: Prebid Gambid Bidder Adapter +biddercode: gambid pbjs: true +pbs: true media_types: banner, video -biddercode: gambid -aliasCode: gamoshi -userIds: id5Id, unifiedId +userIds: all +gvl_id: 644 +tcfeu_supported: true +schain_supported: true +usp_supported: true +ortb_blocking_supported: true +multiformat_supported: will-bid-on-one sidebarType: 1 +aliasCode: gamoshi --- ### Bid params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | +| Name | Scope | Description | Example | Type | |-------------------|----------|---------------------------------------------------------------|----------------------|----------| -| `supplyPartnerId` | required | ID of the supply partner | `'12345'` | `string` | +| `supplyPartnerId` or `inventory_id` or `supply_partner_id` | required | ID of the supply partner. This parameter can be either a `string` or `integer` for Prebid.js, however `integer` is preferred | `12345` | `integer` | +| `bidfloor` | optional | Minimum acceptable bid price. Must be a positive number. | `0.5` | `number` | +| `instl` | optional | Interstitial flag (1 for interstitial, 0 for non-interstitial). | `1` | `integer` | +| `pos` | optional | Ad position on the page. | `1` | `integer` | +| `video` | optional | Object containing video targeting parameters. See [Video Object](#video-object) for details. | `video: { playback_method: ['auto_play_sound_off'] }` | `object` | + +This adapter only requires you to provide your Inventory Id (Supply partner id), and optionally your RTB endpoint. + +#### Video Object + +For details on how these video params work with the params set in the adUnit.mediaTypes.video object. + +{: .table .table-bordered .table-striped } +| Name | Description | Type | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| `minduration` | Integer that defines the minimum video ad duration in seconds. | `integer` | +| `maxduration` | Integer that defines the maximum video ad duration in seconds. | `integer` | +| `protocols` | Array of integers listing the supported video protocols (VAST versions). | `Array` | +| `mimes` | Array of strings listing the supported MIME types for the video creative. | `Array` | +| `pos` | Ad position on the screen. | `integer` | +| `api` | Array of integers listing the supported API frameworks. | `Array` | +| `skip` | Indicates if the player will allow the video to be skipped (0 = no, 1 = yes). | `integer` | +| `plcmt` | Video placement type. | `integer` | +| `placement` | Placement type for the impression. | `integer` | +| `playbackmethod` | Array of integers listing the playback methods. | `Array` | +| `startdelay` | Indicates the offset of the ad placement from the start of the video content. | `integer` | +| `context` | Content context (e.g., 'instream', 'outstream'). | `string` | + +### Example Ad Unit Configurations + +#### Banner Ad Unit + +```javascript +var adUnits = [ + { + code: 'banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250], [728, 90]] + } + }, + bids: [ + { + bidder: 'gambid', + params: { + supplyPartnerId: 12345, + bidfloor: 0.5, + pos: 1 + } + } + ] + } +]; +``` + +#### Video Ad Unit (Instream) + +```javascript +var adUnits = [ + { + code: 'video-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'instream', + mimes: ['video/mp4', 'video/webm'], + protocols: [2, 3, 5, 6], + maxduration: 30, + api: [1, 2] + } + }, + bids: [ + { + bidder: 'gambid', + params: { + supplyPartnerId: 12345, + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + skip: 1, + startdelay: 0, + api: [1, 2], + plcmt: 1 + } + } + } + ] + } +]; +``` + +#### Video Ad Unit (Outstream) + +```javascript +var adUnits = [ + { + code: 'outstream-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'outstream', + mimes: ['video/mp4', 'video/webm'] + } + }, + bids: [ + { + bidder: 'gambid', + params: { + supplyPartnerId: 12345, + rendererUrl: 'https://example.com/outstream-renderer.js', + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + placement: 3, + plcmt: 3, + context: 'outstream' + } + } + } + ] + } +]; +``` diff --git a/dev-docs/bidders/gamoshi.md b/dev-docs/bidders/gamoshi.md index 2b1a874644..354c6e7110 100644 --- a/dev-docs/bidders/gamoshi.md +++ b/dev-docs/bidders/gamoshi.md @@ -6,12 +6,13 @@ biddercode: gamoshi pbjs: true pbs: true media_types: banner, video +userIds: all +gvl_id: 644 tcfeu_supported: true -tcf2_supported: true schain_supported: true usp_supported: true -userIds: id5Id, unifiedId -gvl_id: 644 +ortb_blocking_supported: true +multiformat_supported: will-bid-on-one sidebarType: 1 --- @@ -20,8 +21,134 @@ sidebarType: 1 {: .table .table-bordered .table-striped } | Name | Scope | Description | Example | Type | |-------------------|----------|---------------------------------------------------------------|----------------------|----------| -| `supplyPartnerId` | required | ID of the supply partner you created in the Gamoshi dashboard. | `'12345'` | `string` | +| `supplyPartnerId` or `inventory_id` or `supply_partner_id` | required | ID of the supply partner you created in the Gamoshi dashboard. This parameter can be either a `string` or `integer` for Prebid.js, however `integer` is preferred | `12345` | `integer` | | `rtbEndpoint` | optional | If you have a whitelabel account on Gamoshi, specify it here. | `'rtb.mybidder.com'` | `string` | +| `bidfloor` | optional | Minimum acceptable bid price. Must be a positive number. | `0.5` | `number` | +| `instl` | optional | Interstitial flag (1 for interstitial, 0 for non-interstitial). | `1` | `integer` | +| `pos` | optional | Ad position on the page. | `1` | `integer` | +| `rendererUrl` | optional | Custom renderer URL for outstream video. | `'https://example.com/renderer.js'` | `string` | +| `video` | optional | Object containing video targeting parameters. See [Video Object](#video-object) for details. | `video: { playback_method: ['auto_play_sound_off'] }` | `object` | + +This adapter only requires you to provide your Inventory Id (Supply partner id), and optionally your RTB endpoint. + +#### Video Object + +For details on how these video params work with the params set in the adUnit.mediaTypes.video object. + +{: .table .table-bordered .table-striped } +| Name | Description | Type | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| `minduration` | Integer that defines the minimum video ad duration in seconds. | `integer` | +| `maxduration` | Integer that defines the maximum video ad duration in seconds. | `integer` | +| `protocols` | Array of integers listing the supported video protocols (VAST versions). | `Array` | +| `mimes` | Array of strings listing the supported MIME types for the video creative. | `Array` | +| `pos` | Ad position on the screen. | `integer` | +| `api` | Array of integers listing the supported API frameworks. | `Array` | +| `skip` | Indicates if the player will allow the video to be skipped (0 = no, 1 = yes). | `integer` | +| `plcmt` | Video placement type. | `integer` | +| `placement` | Placement type for the impression. | `integer` | +| `playbackmethod` | Array of integers listing the playback methods. | `Array` | +| `startdelay` | Indicates the offset of the ad placement from the start of the video content. | `integer` | +| `context` | Content context (e.g., 'instream', 'outstream'). | `string` | + +### Example Ad Unit Configurations + +#### Banner Ad Unit + +```javascript +var adUnits = [ + { + code: 'banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250], [728, 90]] + } + }, + bids: [ + { + bidder: 'gamoshi', + params: { + supplyPartnerId: 12345, + bidfloor: 0.5, + pos: 1 + } + } + ] + } +]; +``` + +#### Video Ad Unit (Instream) + +```javascript +var adUnits = [ + { + code: 'video-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'instream', + mimes: ['video/mp4', 'video/webm'], + protocols: [2, 3, 5, 6], + maxduration: 30, + api: [1, 2] + } + }, + bids: [ + { + bidder: 'gamoshi', + params: { + supplyPartnerId: 12345, + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + skip: 1, + startdelay: 0, + api: [1, 2], + plcmt: 1 + } + } + } + ] + } +]; +``` + +#### Video Ad Unit (Outstream) -This adapter only requires you to provide your supply partner ID, and optionally your RTB endpoint, in order to request -bids from your Gamoshi account. +```javascript +var adUnits = [ + { + code: 'outstream-div', + mediaTypes: { + video: { + playerSize: [[640, 480]], + context: 'outstream', + mimes: ['video/mp4', 'video/webm'] + } + }, + bids: [ + { + bidder: 'gamoshi', + params: { + supplyPartnerId: 12345, + rendererUrl: 'https://example.com/outstream-renderer.js', + video: { + minduration: 5, + maxduration: 30, + protocols: [2, 3, 5, 6], + mimes: ['video/mp4', 'video/webm'], + playbackmethod: [2], + placement: 3, + plcmt: 3, + context: 'outstream' + } + } + } + ] + } +]; +```