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

Add docs for apstream adapter #2141

Merged
merged 2 commits into from
Aug 5, 2020
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
97 changes: 97 additions & 0 deletions dev-docs/bidders/apstream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# Overview

```
Module Name: AP Stream Bidder Adapter
Module Type: Bidder Adapter
Maintainer: stream@audienceproject.com
gdpr_supported: true
tcf2_supported: true
```

# Description

Module that connects to AP Stream source

# Inherit from prebid.js
```
var adUnits = [
{
code: '/19968336/header-bid-tag-1',
mediaTypes: { // mandatory and should be only one
banner: {
sizes: [[920,180], [920, 130]]
}
},
bids: [{
bidder: 'apstream',
params: {
publisherId: STREAM_PIBLISHER_ID // mandatory
}
}]
}
];
```

# Explicit ad-unit code
```
var website = null;
switch (location.hostname) {
case "site1.com":
website = "S1";
break;
case "site2.com":
website = "S2";
break;
}

var adUnits = [
{
code: '/19968336/header-bid-tag-1',
mediaTypes: { // mandatory and should be only one
banner: {
sizes: [[920,180], [920, 130]]
}
},
bids: [{
bidder: 'apstream',
params: {
publisherId: STREAM_PIBLISHER_ID, // mandatory
code: website + '_Leaderboard'
}
}]
}
];
```

# Explicit ad-unit ID
```
var adUnits = [
{
code: '/19968336/header-bid-tag-1',
mediaTypes: { // mandatory and should be only one
banner: {
sizes: [[920,180], [920, 130]]
}
},
bids: [{
bidder: 'apstream',
params: {
publisherId: STREAM_PIBLISHER_ID, // mandatory
adunitId: 1234
}
}]
}
];
```

# DSU

To disable DSU use config option:

```
pbjs.setConfig({
apstream: {
noDsu: true
}
});
```