diff --git a/dev-docs/bidders/stackadapt.md b/dev-docs/bidders/stackadapt.md new file mode 100644 index 0000000000..08c57e01fa --- /dev/null +++ b/dev-docs/bidders/stackadapt.md @@ -0,0 +1,157 @@ +--- +layout: bidder +title: StackAdapt +description: StackAdapt Prebid Bidder Adapter +biddercode: stackadapt +pbjs: true +pbs: false +gvl_id: 238 +tcfeu_supported: true +usp_supported: true +userId: all +media_types: banner, video +coppa_supported: true +gpp_sids: tcfeu, tcfca, usnat, usstate_all, usp +gpp_supported: true +schain_supported: true +dchain_supported: false +deals_supported: true +floors_supported: true +fpd_supported: true +ortb_blocking_supported: true +multiformat_supported: will-bid-on-any +privacy_sandbox: no +prebid_member: false +sidebarType: 1 +--- + +### Bid Params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|---------------|----------|-----------------------------|--------------------|----------| +| `publisherId` | required | StackAdapt provided id | `'4cd53a92ra91'` | `string` | +| `placementId` | optional | StackAdapt provided id | `'e95365f397a7'` | `string` | +| `banner` | optional | banner supporting expdir | `{expdir: [1, 3]}` | `object` | +| `bidfloor` | optional | bid floor price | `1.01` | `float` | + +The following banner parameters are supported: + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | Type | +|----------|----------|-----------------------------------|----------|------------------| +| `expdir` | optional | Directions the banner may expand. | `[1, 3]` | `Array[integer]` | + +### Banner + +#### `mediaTypes.banner` Parameters + +The StackAdapt bid adapter requires `sizes` to be defined in valid format. +See [mediaTypes.banner](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.banner) for defining mediaTypes parameters. + +Below are banner ad unit examples with required and optional parameters: + +```js + var adUnits = [ + // Banner adUnit - required parameters + { + code: 'div-test-ad-1', + mediaTypes: { + banner: { + sizes: [[300, 250]] + } + }, + bids: [{ + bidder: 'stackadapt', + params: { + publisherId: '4cd53a92ra91', + } + }] + }, + // Banner adUnit - including optional parameters + { + code: 'div-test-ad-2', + mediaTypes: { + banner: { + sizes: [[300, 250]], + pos: 1 + } + }, + bids: [{ + bidder: 'stackadapt', + params: { + publisherId: '4cd53a92ra91', + placementId: 'e95365f397a7', + bidfloor: 1.01, + banner: { + expdir: [1, 3] + } + } + }] + } + ]; +``` + +### Video + +#### `mediaTypes.video` Parameters + +The StackAdapt bid adapter requires `mimes`, `protocols`, `maxduration`, `api`, and `plcmt` to be defined in valid format. +See [mediaTypes.video](https://docs.prebid.org/dev-docs/adunit-reference.html#adUnit.mediaTypes.video) for defining mediaTypes parameters. + +Below are video ad unit examples with required and optional parameters: + +```js + var adUnits = [ + // Video adUnit - required parameters + { + code: 'div-test-ad-3', + mediaTypes: { + video: { + mimes: ['video/mp4'], + protocols: [2, 3, 5, 6], + maxduration: 60, + api: [1, 2], + plcmt: 1 + } + }, + bids: [{ + bidder: 'stackadapt', + params: { + publisherId: '4cd53a92ra91', + } + }] + }, + // Video adUnit - including optional parameters + { + code: 'div-test-ad-4', + mediaTypes: { + video: { + playerSize: [640, 360], + mimes: ['video/mp4'], + protocols: [2, 3, 5, 6], + minduration: 1, + maxduration: 60, + api: [1, 2], + playback_method: [1], + plcmt: 1, + startdelay: 1, + pos: 1, + minbitrate: 300, + maxbitrate: 1500, + skip: 1, + skipmin: 5, + skipafter: 15 + } + }, + bids: [{ + bidder: 'stackadapt', + params: { + publisherId: '4cd53a92ra91', + placementId: 'e95365f397a7', + bidfloor: 1.01, + } + }] + } + ]; +```