diff --git a/dev-docs/bidders/adquery.md b/dev-docs/bidders/adquery.md index c7099a031b..139ff8a20c 100644 --- a/dev-docs/bidders/adquery.md +++ b/dev-docs/bidders/adquery.md @@ -11,13 +11,112 @@ schain_supported: true gvl_id: 902 userIds: adQuery QiD sidebarType: 1 +media_types: banner, video --- ### Bid Params {: .table .table-bordered .table-striped } -| Name | Scope | Description | Example | Type | -|---------------|----------|---------------|--------------------------------------------------------------------------|-----------| -| `placementId` | required | Placement ID | `6d93f2a0e5f0fe2cc3a6e9e3ade964b43b07f897` | `string` | -| `type` | required | Ad Type | `banner` | `string` | -| `sizes` | required | Allowed sizes | `320x100,300x250,336x280,300x50,300x100,320x50,320x480,300x150,320x180` | `string` | +| Name | Scope | Description | Example | Type | +|---------------|----------|-----------------------------------------------------------------------------|--------------------------------------------------------------------------|-----------| +| `placementId` | required | Placement ID provided by Adquery (must match the type/format in dashboard) | `d30f79cf7fef47bd7a5611719f936539bec0d2e9` | `string` | +| `type` | required | Ad format/type – tells Adquery what kind of creative to return | `banner`, `video`, `interstitial`, `anchorad` | `string` | + +**Notes:** + +- `placementId` is always required and should correspond to a placement configured in the Adquery dashboard for the specific `type`. +- `type` is mandatory in bidder params — it determines the creative format (banner, video, interstitial, anchorad). +- For **banner** ads: Define sizes in `mediaTypes.banner.sizes`. The adapter automatically parses and sends them. +- For **video** ( outstream ): Use `type: 'video'` + `mediaTypes.video.context: 'outstream'`. A renderer is required for rendering (e.g. InRenderer or similar). In-stream video is not currently supported by this adapter. +- For **video** ( instream ): Use `type: 'video'` + `mediaTypes.video.context: 'instream'`. A renderer is required for rendering (e.g. InRenderer or similar). In-stream video is not currently supported by this adapter. +- For special formats (`interstitial`, `anchorad`): A spetial size placeholder is reqired `[1x1]`. + +### Example 1: Standard Banner Ad + +```javascript +{ + code: 'banner-div', + mediaTypes: { + banner: { + sizes: [[300, 250], [320, 50], [728, 90]] + } + }, + bids: [{ + bidder: 'adquery', + params: { + placementId: '9e0a916215d99196f44821dfc348c2843ee5b5a7', + type: 'banner' + } + }] +} +``` + +### Example 2: Outstream Video Ad (with renderer) + +```javascript +{ + code: 'video-outstream-1', + mediaTypes: { + video: { + context: 'outstream', + playerSize: [[640, 360]], + mimes: ['video/mp4', 'video/webm'], + protocols: [2, 3, 5, 6, 7, 8], + api: [2], + placement: 1, + startdelay: 0, + skip: 1 + } + }, + renderer: { + url: 'https://cdn.jsdelivr.net/npm/in-renderer-js@1/dist/in-renderer.umd.min.js', + render: function(bid) { + var renderer = new window.InRenderer(); + renderer.render('video-outstream-1', bid); + } + }, + bids: [{ + bidder: 'adquery', + params: { + placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9', + type: 'video' + } + }] +} +``` + +### Example 3: Interstitial + Anchor Ad (no sizes) + +```javascript +// Interstitial (full-page overlay) +{ + code: 'interstitial-div', + mediaTypes: { + banner: { + sizes: [[1, 1]] + } + }, + bids: [{ + bidder: 'adquery', + params: { + placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9', + type: 'interstitial' + } + }] +}, + +// Anchor / fixed bottom bar +{ + code: 'anchor-div', + banner: { + sizes: [[1, 1]] + }, + bids: [{ + bidder: 'adquery', + params: { + placementId: 'd30f79cf7fef47bd7a5611719f936539bec0d2e9', + type: 'anchorad' + } + }] +} +```