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

Documentation updates #3

Merged
merged 1 commit into from
Aug 29, 2018
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
102 changes: 94 additions & 8 deletions modules/districtmDmxBidAdapter.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,105 @@
```
Module Name: district m Bid Adapter
Module Type: Bidder Adapter
Maintainer: Steve Alliance ([email protected])
```

# Overview

The `districtmDmxAdapter` module allows publishers to include DMX Exchange demand using Prebid 1.0+.

## Attributes

* Single Request
* Multi-Size Support
* GDPR Compliant
* Bids returned in **NET**

## Media Types

* Banner

## Bidder Parameters

| Key | Scope | Type | Description
| --- | --- | --- | ---
| dmxid | Mandatory | Integer | Unique identifier of the placement, dmxid can be obtained in the district m Boost platform.
| memberid | Mandatory | Integer | Unique identifier for your account, memberid can be obtained in the district m Boost platform.

# Ad Unit Configuration Example

```javascript
var adUnits = [{
code: 'div-gpt-ad-1460505748561-0',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]],
}
},
bids: [{
bidder: 'districtmDMX',
params: {
dmxid: 100001,
memberid: 100003
}
}]
}];
```


# Quick Start Guide

###### 1. Including the `districtmDmxAdapter` in your build process.

Add the adapter as an argument to gulp build.

```
gulp build --modules=districtmDmxAdapter,ixBidAdapter,appnexusBidAdapter
```

*Adding `"districtmDmxAdapter"` as an entry in a JSON file with your bidders is also acceptable.*

```
[
"districtmDmxAdapter",
"ixBidAdapter",
"appnexusBidAdapter"
]
```

*Proceed to build with the JSON file.*

```
Module Name: DistrictM Bid Adapter
Module Type: Bidder Adapter
Maintainer: [email protected]
gulp build --modules=bidderModules.json
```

# Description
###### 2. Configure the ad unit object

Adapter that connects to DistrictM's demand sources.
This version only support banner
Once Prebid is ready you may use the below example to create the adUnits object and begin building the configuration.

# Test Parameters
```javascript
var adUnits = [{
code: 'div-gpt-ad-1460505748561-0',
mediaTypes: {
banner: {
sizes: [[300, 250], [300, 600], [728, 90]],
}
},
bids: []
}
];
```

###### 3. Add the bidder

Our demand and adapter supports multiple sizes per placement, as such a single dmxid may be used for all sizes of a single domain.

```javascript
var adUnits = [{
code: 'div-gpt-ad-1460505748561-0',
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]],
sizes: [[300, 250], [300, 600], [728, 90]],
}
},
bids: [{
Expand All @@ -29,3 +111,7 @@ This version only support banner
}]
}];
```

###### 4. Implementation Checking

Once the bidder is live in your Prebid configuration you may confirm it is making requests to our end point by looking for requests to `https://dmx.districtm.io/b/v1`.