-
Notifications
You must be signed in to change notification settings - Fork 735
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
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
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 | ||
} | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added, txs.