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 Pubnative bidder documentation #1340

Merged
merged 3 commits into from
Jun 9, 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
62 changes: 62 additions & 0 deletions docs/bidders/pubnative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Pubnative Bidder

## Prerequisite
Before adding PubNative as a new bidder, there are 3 prerequisites:
- As a Publisher, you need to have Prebid Mobile SDK integrated.
- You need a configured Prebid Server (either self-hosted or hosted by 3rd party).
- You need to be integrated with Ad Server SDK (e.g. Mopub) or internal product which communicates with Prebid Mobile SDK.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any Pubnative help resources for people to consult in case they want to implement these?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added, txs.


Please see [documentation](https://developers.pubnative.net/docs/prebid-adding-pubnative-as-a-bidder) for more info.

## Configuration

- bidder should be always set to "pubnative" (`imp.ext.pubnative`)
- zone_id (int) should be always set to 1, unless special use case agreed with our account manager. (`imp.ext.pubnative.zone_id`)
- app_auth_token (string) is unique per publisher app. Please contact our account manager to obtain yours. (`imp.ext.pubnative.app_auth_token`)

An example is illustrated in a section below.

## Testing

Please consult with our Account Manager for testing.
We need to confirm that your ad request is correctly received by our system.

The following test parameters can be used to verify that Prebid Server is working properly with the
Pubnative adapter.

The following json can be used to do a request to prebid server for verifying its integration with Pubnative adapter.

```json
{
"id": "some-impression-id",
"site": {
"page": "https://good.site/url"
},
"imp": [
{
"id": "test-imp-id",
"banner": {
"format": [
{
"w": 300,
"h": 250
}
]
},
"ext": {
"pubnative": {
"zone_id": 1,
"app_auth_token": "b620e282f3c74787beedda34336a4821"
}
}
}
],
"device": {
"os": "android",
"h": 700,
"w": 375
},
"tmax": 500,
"test": 1
}
```