diff --git a/dev-docs/bidders/vidcrunch.md b/dev-docs/bidders/vidcrunch.md index 6b485ca8d8..0560558e38 100644 --- a/dev-docs/bidders/vidcrunch.md +++ b/dev-docs/bidders/vidcrunch.md @@ -6,12 +6,17 @@ pbjs: true biddercode: vidcrunch aliasCode: aniview media_types: banner, video -gvl_id: 780 (aniview) +gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp +ortb_blocking_supported: true +multiformat_supported: will-bid-on-any tcfeu_supported: true +floors_supported: true usp_supported: true schain_supported: true safeframes_ok: true +gvl_id: 780 (aniview) sidebarType: 1 +userIds: all --- ### Note @@ -21,29 +26,131 @@ For more information about [VidCrunch](https://vidcrunch.com/), please contact < ### Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|------------------|----------|------------------|------------------------------|----------| -| `AV_PUBLISHERID` | required | Publisher/Netid | `'55b88d4a181f465b3e8b4567'` | `string` | -| `AV_CHANNELID` | required | Channel id | `'5a5f17a728a06102d14c2718'` | `string` | +| Name | Scope | Description | Example | Type | +|------------------|----------|-----------------------|----------------------|----------| +| `AV_PUBLISHERID` | required | Publisher/Network ID | `'Get from VidCrunch'` | `string` | +| `AV_CHANNELID` | required | Channel ID | `'Get from VidCrunch'` | `string` | + +### Setup for Video + +```javascript +const adUnit = [{ + code: 'videoAdUnit', + mediaTypes: { + video: { + // Required + playerSize: [[640, 480]], + context: 'outstream', + mimes: ['video/mp4', 'video/mpeg', 'application/javascript'], + + // Optional + playbackmethod: [1, 2], + protocols: [1, 2, 3, 5, 6, 7, 8], + api: [1, 2], + maxduration: 60, + plcmt: 4, + }, + }, + bids: [{ + bidder: 'vidcrunch', + params: { + // Required + AV_PUBLISHERID: 'Get from VidCrunch', + AV_CHANNELID: 'Get from VidCrunch', + }, + }], +}]; +``` + +### Setup for Banner + +```javascript +const adUnit = [{ + code: 'bannerAdUnit', + mediaTypes: { + banner: { + // Required + sizes: [[300, 250], [300, 600]], + }, + }, + bids: [{ + bidder: 'vidcrunch', + params: { + // Required + AV_PUBLISHERID: 'Get from VidCrunch', + AV_CHANNELID: 'Get from VidCrunch', + }, + }], +}]; +``` -### Test Parameters +### Setup for Multi-format (Banner & Video) ```javascript -const videoAdUnit = [ -{ - code: 'video1', +const adUnit = [{ + code: 'multiformatAdUnit', mediaTypes: { + banner: { + // Required + sizes: [[300, 250], [300, 600]], + }, video: { + // Required playerSize: [[640, 480]], - context: 'outstream' + context: 'outstream', + mimes: ['video/mp4', 'video/mpeg', 'application/javascript'], }, }, bids: [{ bidder: 'vidcrunch', params: { - AV_PUBLISHERID: '55b78633181f4603178b4568', - AV_CHANNELID: '5d19dfca4b6236688c0a2fc4' - } - }] + // Required + AV_PUBLISHERID: 'Get from VidCrunch', + AV_CHANNELID: 'Get from VidCrunch', + }, + }], }]; ``` + +### Bidder specific configs + +```javascript +pbjs.setBidderConfig({ + bidders: ['vidcrunch'], + config: { + ortb2: { + ext: { + vidcrunch: { + // Additional data to send to the Ad Server + }, + }, + }, + }, +}, true); +``` + +### User Sync example + +```javascript +pbjs.setConfig({ + userSync: { + filterSettings: { + // Iframe and Image + all: { + bidders: ['vidcrunch'], + filter: 'include', + }, + + // Or you can specify which type should be enabled/disabled: + iframe: { + bidders: ['vidcrunch'], + filter: 'include', + }, + image: { + bidders: '*', // '*' represents all bidders + filter: 'include', // or 'exclude' + }, + }, + }, +}); +```