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

Jump to bottom

Smaato: update documentation #3062

Merged
merged 1 commit into from
Jul 8, 2021
Merged

Smaato: update documentation #3062

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 46 additions & 5 deletions dev-docs/bidders/smaato.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ title: Smaato
description: Prebid Smaato Bidder Adaptor
biddercode: smaato
gdpr_supported: true
gvl_id: 82
usp_supported: true
coppa_supported: true
media_types: banner, video
userIds: criteo, pubCommonId, unifiedId
userId: criteo, pubCommonId, unifiedId
pbjs: true
pbs: true
pbs_app_supported: true
Expand All @@ -18,7 +19,9 @@ prebid_member: true

- [Bid Params](#smaato-bid-params)
- [App Object](#smaato-app-object)
- [Example Ad Units](#smaato-example-ad-units)
- [First Party Data](#smaato-first-party)
- [Test Parameters](#smaato-test-parameters)

### Registration

Expand All @@ -32,7 +35,8 @@ The Smaato adapter requires setup and approval from the Smaato team, even for ex
| Name | Scope | Description | Example | Type |
|------------|----------|----------------------|------------|----------|
| `publisherId` | required | Your Smaato publisher id | `'1100012345'` | `string` |
| `adspaceId` | required | Your Smaato adspace id | `'11002234'` | `string` |
| `adspaceId` | required | Your Smaato adspace id. Required for non adpod requests | `'11002234'` | `string` |
| `adbreakId` | required | Your Smaato adbreak id. Required for adpod (long-form video) requests | `'41002234'` | `string` |
| `app` | optional | Object containing mobile app parameters. See the [App Object](#smaato-app-object) for details.| `app : { ifa: '56700000-9cf0-22bd-b23e-46b96e40003a'}` | `object` |

<a name="smaato-app-object" />
Expand All @@ -47,12 +51,15 @@ Smaato supports using prebid within a mobile app's webview.
| `ifa` | String that contains the advertising identifier of the user (e.g. idfa or aaid). | `'56700000-9cf0-22bd-b23e-46b96e40003a'` | `string` |
| `geo` | Object that contains the latitude (`lat`) and longitude (`lon`) of the user. | `{ lat: 33.3, lon: -88.8 }` | `object` |

<a name="smaato-example-ad-units" />

### Example Banner Ad Unit
### Example Ad Units

#### Example Banner Ad Unit

```javascript
var adUnit = {
"code": "header-bid-tag-1",
"code": "banner unit",
"mediaTypes": {
"banner": {
"sizes": [320, 50]
Expand All @@ -68,7 +75,7 @@ var adUnit = {
}
```

### Example Video Ad Unit
#### Example Video Ad Unit

```javascript
var adUnit = {
Expand Down Expand Up @@ -98,6 +105,37 @@ var adUnit = {
}]
};
```
#### Example AdPod (long-form) Video Ad Unit

```javascript
var adUnit = {
"code": "adpod unit",
"mediaTypes": {
"video": {
"context": "adpod",
"playerSize": [640, 480],
"adPodDurationSec": 300,
"durationRangeSec": [15, 30],
"requireExactDuration": false,
"mimes": ["video/mp4"],
"startdelay": 0,
"linearity": 1,
"protocols": [7],
"skip": 1,
"skipmin": 5,
"api": [7],
}
},
"bids": [{
"bidder": "smaato",
"params": {
"publisherId": "1100042525",
"adbreakId": "400000000"
}
}]
};
```

<a name="smaato-first-party" />

### First Party Data
Expand All @@ -115,9 +153,12 @@ pbjs.setConfig({
gender: "M",
yob: 1984
}
}
});
```

<a name="smaato-test-parameters" />

### Test Parameters

Following example includes sample `imp` object with publisherId and adSlot which can be used to test Smaato Adapter
Expand Down