Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename synacormedia adapter to imds to reflect ownership change #4237

Merged
merged 4 commits into from
Jun 16, 2023
Merged

Rename synacormedia adapter to imds to reflect ownership change #4237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af8e4da
Change bid adapter for synacormedia to imds. Update adapter featureset.
ecammit Dec 28, 2022
f6b2359
Change synacormedia.md bidder doc to not reference aliasCode=imds
ecammit Jan 5, 2023
ce6cbcf
Added pbjs_version_notes to synacormedia docs to use imds after 7.x
ecammit Jan 11, 2023
165a86a
Update synacormedia note with version 8.0 based upon anticipated rele…
ecammit May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions dev-docs/bidders/imds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
layout: bidder
title: iMedia Digital Services (iMDS)
description: Prebid iMedia Digital Services Bidder (iMDS) Adapter
pbjs: true
pbs: true
biddercode: imds
gdpr_supported: false
usp_supported: true
userIds: all
media_types: banner, video
coppa_supported: false
schain_supported: true
dchain_supported: false
safeframes_ok: true
pbs_app_supported: true
deals_supported: false
floors_supported: true
fpd_supported: false
ortb_blocking_supported: false
multiformat_supported: will-bid-on-any
prebid_member: false
gvl_id: none
sidebarType: 1
---

### Note:

The iMedia Digital Services bidder adapter requires setup and approval from iMedia Digital Services. Please reach out to your account manager for more information and to start using it.

### Configuration

iMedia Digital Services requires that `iframe` is used for user syncing.

Example configuration:

```javascript
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // represents all bidders
filter: 'include'
}
}
}
});
```

### DFP Video Creative
To use video, setup a `VAST redirect` creative within Google AdManager (DFP) with the following VAST tag URL:

```
https://track.technoratimedia.com/openrtb/tags?ID=%%PATTERN:hb_cache_id_synacorm%%&AUCTION_PRICE=%%PATTERN:hb_pb_synacormedia%%
```

### Bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
| ---- | ----- | ----------- | ------- | ---- |
| `seatId` | required | The seat ID from iMedia Digital Services. This will be the same for all ad units. | `'prebid'` | `string` |
| `tagId` | required | The placement ID or tag ID from iMedia Digital Services. | `'demo1'` | `string` |
| `placementId` | optional | Legacy parameter replaced by `tagId` | `'demo1'` | `string` |
| `bidfloor` | optional | Legacy parameter for floor price for the request. Replaced by [Price Floors Module](/dev-docs/modules/floors.html) | `0.1` | `float` |

### Example Ad Unit
```javascript
var adUnits = [{
"code": "test-div",
"mediaTypes": {
"video": {
"pos": 1,
"playerSize": [300, 250],
"context": "instream",
"mimes": ["video/mp4"],
"protocols": [2, 3, 5, 6, 7, 8],
"playbackmethod": [2],
"skip": 0,
"minduration": 15,
"maxduration": 30,
"startdelay": 0,
"linearity": 1
}
},
"bids": [{
"bidder": "imds",
"params": {
"seatId": "prebid",
"tagId": "demo1",
"bidfloor": 0.20
}
}]
}]
```
99 changes: 16 additions & 83 deletions dev-docs/bidders/synacormedia.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,97 +1,30 @@
---
layout: bidder
title: Synacor Media
description: Prebid Synacor Media Bidder Adapter
description: Prebid Synacor Media Bidder Adapter (replaced by "imds")
pbjs: true
pbs: true
biddercode: synacormedia
media_types: banner, video
userIds: identityLink, verizonMediaId, pubCommonId
gdpr_supported: false
schain_supported: true
usp_supported: true
userIds: all
media_types: banner, video
coppa_supported: false
schain_supported: true
dchain_supported: false
safeframes_ok: true
pbs_app_supported: true
deals_supported: false
floors_supported: true
fpd_supported: false
ortb_blocking_supported: false
multiformat_supported: will-bid-on-any
prebid_member: false
gvl_id: none
sidebarType: 1
pbjs_version_notes: use imds after 8.0
---

### Note:

The Synacor Media bidder adapter requires setup and approval from Synacor. Please reach out to your account manager for more information and to start using it.

### Configuration

Synacor Media requires that iframe is used for user syncing.

Example configuration:

```javascript
pbjs.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: '*', // represents all bidders
filter: 'include'
}
}
}
});
```

### DFP Video Creative
To use video, setup a `VAST redirect` creative within Google AdManager (DFP) with the following VAST tag URL:

```
https://track.technoratimedia.com/openrtb/tags?ID=%%PATTERN:hb_cache_id_synacorm%%&AUCTION_PRICE=%%PATTERN:hb_pb_synacormedia%%
```

### Bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
| ---- | ----- | ----------- | ------- | ---- |
| `seatId` | required | The seat ID from Synacor Media. This will be the same for all ad units. | `'prebid'` | `string` |
| `tagId` | required | The placement or tag ID from Synacor Media. | `'demo1'` | `string` |
| `bidfloor` | optional | The floor price for the request. | `0.1` | `float` |
| `pos` | optional | The position of the placement on the page, see Open RTB spec v2.5. | `0` | `int` |
| `video` | optional | Optional properties specific to video, see next table | `{ }` | Object |

### Example Ad Unit
```javascript
var adUnits = [{
"code": "test-div",
"mediaTypes": {
"video": {
"playerSize": [300, 250],
"context": "instream",
"minduration": 15,
"maxduration": 30,
"startdelay": 1,
"linearity": 1
}
},
"bids": [{
"bidder": "synacormedia",
"params": {
"seatId": "prebid",
"tagId": "demo1",
"bidfloor": 0.20,
"pos": 1
}
}]
}]
```

### Video Parameters (see openrtb 2.5 spec)

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Default | Type |
| ---- | ----- | ----------- | ------- | ---- |
| `minduration` | optional | Minimum ad duration in seconds | `2` | `int` |
| `maxduration` | optional | Maximum ad duration in seconds | `60` | `int` |
| `startdelay` | optional | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. | `0` | `int` |
| `placement` | optional | Placement type for the impression. | `null` | `int` |
| `linearity` | optional | Indicates if the impression must be linear, nonlinear, etc. | `1` | `int` |
| `mimes` | optional | Content MIME types supported. | `["video/mp4", "application/javascript"]` | Array(`String`) |
| `protocols` | optional | Array of supported video protocols. | `[1,2,3,4,5,6,7]` | Array(`int`) |
| `api` | optional | List of supported API frameworks for this impression. | `[1,2]` | Array(`int`) |
| `playbackmethod` | optional | Single element array with supported playback methods for this video impression. If multiple values are supplied, first element will be used. | `[1]` | Array(`int`) |
The Synacor Media bidder adapter has been renamed to the [iMedia Digital Services (iMDS)](/dev-docs/bidders/imds.html) adapter, using an bidder code of `imds`. Please update your implementation accordingly.