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.

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

shinez #3

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
94 changes: 66 additions & 28 deletions dev-docs/bidders/shinez.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,80 @@
layout: bidder
title: Shinez
description: Prebid Shinez Bidder Adapter
biddercode: shinez
media_types: banner
multiformat_supported: will-bid-on-any
pbjs: true
enable_download: false
pbjs_version_notes: not ported to 5.x
biddercode: shinez
media_types: banner, video
schain_supported: true
usp_supported: true
floors_supported: true
userIds: all
fpd_supported: true
---

### Registration
### Note

The Shinez adapter requires setup and approval from the Shinez team. Please reach out to [email protected] for more information.
The Shinez adapter requires setup and approval. Please reach out to [email protected] to setup an Shinez account.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|----------------------|------------|----------|
| `placementId` | required | A Shinez-specific identifier that is associated with a specific domain provided by your Shinez representative. | `'00654321'` | `string` |
| `unit` | optional | An alphanumerical value used to identify the slot_id in reporting. | `'__header-bid-1'` | `string` |
### Bid Parameters

### Examples
#### Banner, Video

#### Example Banner Ad Unit
{: .table .table-bordered .table-striped }
| Name | Scope | Type | Description | Example
| ---- | ----- | ---- | ----------- | -------
| `org` | required | String | Shinez publisher Id provided by your Shinez representative | "56f91cd4d3e3660002000033"
| `floorPrice` | optional | Number | Minimum price in USD. <br/><br/> **WARNING:**<br/> Misuse of this parameter can impact revenue | 2.00
| `placementId` | optional | String | A unique placement identifier | "12345678"
| `testMode` | optional | Boolean | This activates the test mode | false

## Example
```javascript
var adUnit = {
code: "test-div",
mediaTypes: {
banner: {
sizes: [[300, 250]]
}
},
bids: [{
bidder: "shinez",
params: {
placementId: "00654321"
var adUnits = [{
code: 'banner-div',
mediaTypes: {
banner: {
sizes: [
[300, 250],
[728, 90]
]
}
},
bids: [{
bidder: 'shinez',
params: {
org: '56f91cd4d3e3660002000033', // Required
floorPrice: 0.05, // Optional
placementId: '12345678', // Optional
testMode: false // Optional
}
}]
},
{
code: 'dfp-video-div',
sizes: [
[640, 480]
],
mediaTypes: {
video: {
playerSize: [
[640, 480]
],
context: 'instream'
}
},
bids: [{
bidder: 'shinez',
params: {
org: '56f91cd4d3e3660002000033', // Required
floorPrice: 5.00, // Optional
placementId: '12345678', // Optional
testMode: false // Optional
}
}]
}
}]
};
];
```

### Configuration
Shinez recommends setting UserSync by iframe for monetization.