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

Added adbookpsp bid adapter documentation #2933

Merged
merged 6 commits into from
Jun 10, 2021
Merged
Changes from all commits
Commits
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
200 changes: 200 additions & 0 deletions dev-docs/bidders/adbookpsp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
---
layout: bidder
title: AdBookPSP
description: Prebid AdBookPSP Bidder Adapter
biddercode: adbookpsp
media_types: banner, video
gdpr_supported: true
prebid_member: false
schain_supported: true
coppa_supported: true
usp_supported: true
pbjs: true
pbs: false
---

*NOTE*: The AdBookPSP Bidder Adapter requires setup and approval before use. The adapter uses custom targeting keys that require a dedicated Google Ad Manager setup to work. Please reach out to your AdbookPSP representative for more details.

### Bid Params

{: .table .table-bordered .table-striped }
|Name|Scope|Description|Example|Type|
|----|-----|-----------|-------|----|
|`orgId`|optional|Org ID listed in the Deal File|`abc123`|`string`|
|`placementId`|optional|Placement ID listed in the Deal File|`abc123`|`string`|

Each adUnit with `adbookpsp` adapter has to have either `placementId` or `orgId` set.

```js
var adUnits = [
{
bids: [
{
bidder: 'adbookpsp',
params: {
placementId: 'example-placement-id',
orgId: 'example-org-id',
},
},
],
},
];
```

Alternatively, `orgId` can be set globally while configuring prebid.js:

```js
pbjs.setConfig({
adbookpsp: {
orgId: 'example-org-id',
},
});
```

*NOTE*: adUnit orgId will take precedence over the globally set orgId.

#### Banner parameters

Required:

- sizes

Example configuration:

```js
var adUnits = [
{
code: 'div-1',
mediaTypes: {
banner: {
sizes: [[300, 250]],
},
}
},
];
```

#### Video parameters

Required:

- context
- mimes
- playerSize

Additionaly, all `Video` object parameters described in chapter `3.2.7` of the [OpenRTB 2.5 specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) can be passed as bidder params.

Example configuration:

```js
var adUnits = [
{
code: 'div-1',
mediaTypes: {
video: {
context: 'outstream',
mimes: ['video/mp4', 'video/x-flv'],
playerSize: [400, 300],
protocols: [2, 3],
},
},
bids: [
{
bidder: 'adbookpsp',
params: {
placementId: 'example-placement-id',
video: {
placement: 2,
},
},
},
],
},
];
```

*NOTE*: Supporting outstream video requires the publisher to set up a renderer as described [in the Prebid docs](https://docs.prebid.org/dev-docs/show-outstream-video-ads.html).

#### Testing params

To test the adapter, either `placementId: 'example-placement-id'` or `orgId: 'example-org-id'` can be used.

*NOTE*: If any adUnit uses the testing params, all adUnits will receive testing responses.

Example adUnit configuration:

```js
var adUnits = [
{
code: 'div-1',
mediaTypes: {
banner: {
sizes: [[300, 250]],
},
},
bids: [
{
bidder: 'adbookpsp',
params: {
placementId: 'example-placement-id',
},
},
],
},
];
```

Example google publisher tag configuration:

```js
googletag
.defineSlot('/22094606581/example-adbookPSP', sizes, 'div-1')
.addService(googletag.pubads());
```

### Configuration

Setting of the `orgId` can be done in the `pbjs.setConfig()` call. If this is the case, both `orgId` and `placementId` become optional. Remember to only call `pbjs.setConfig()` once as each call overwrites anything set in previous calls.

Enabling iframe based user syncs is also encouraged.

```javascript
pbjs.setConfig({
adbookpsp: {
orgId: 'example-org-id',
winTrackingEnabled: true,
},
userSync: {
filterSettings: {
iframe: {
bidders: '*',
filter: 'include',
},
},
},
});
```

### Privacy

GDPR and US Privacy are both supported by default.

#### Event tracking

This adapter tracks win events for it’s bids. This functionality can be disabled by adding `winTrackingEnabled: false` to the adapter configuration:

```js
pbjs.setConfig({
adbookpsp: {
winTrackingEnabled: false,
},
});
```

#### COPPA support

COPPA support can be enabled for all the visitors by changing the config value:

```js
config.setConfig({ coppa: true });
```