-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add SuperEdge bidder adapter doc #6672
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
Open
LeeZXin
wants to merge
4
commits into
prebid:master
Choose a base branch
from
LeeZXin:dev
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+164
−0
Open
Changes from all commits
Commits
Show all changes
4 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 hidden or 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,164 @@ | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
| layout: bidder | ||||||||||||||||||||||
| title: SuperEdge | ||||||||||||||||||||||
| description: SuperEdge Prebid Bidder Adapter | ||||||||||||||||||||||
| biddercode: superedge | ||||||||||||||||||||||
| media_types: banner,native | ||||||||||||||||||||||
| userIds: all (with commercial activation) | ||||||||||||||||||||||
| tcfeu_supported: true | ||||||||||||||||||||||
| coppa_supported: true | ||||||||||||||||||||||
| gvl_id: 1554 | ||||||||||||||||||||||
| usp_supported: true | ||||||||||||||||||||||
| pbjs: true | ||||||||||||||||||||||
| pbs: true | ||||||||||||||||||||||
| floors_supported: true | ||||||||||||||||||||||
| sidebarType: 1 | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Table of Contents | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| * [Modules](#modules) | ||||||||||||||||||||||
| * [Note](#note) | ||||||||||||||||||||||
| * [Bid Params](#bid-params) | ||||||||||||||||||||||
| * [Prebid.js Bid Params](#prebidjs-bid-params) | ||||||||||||||||||||||
| * [Prebid Server Bid Params](#prebid-server-bid-params) | ||||||||||||||||||||||
| * [Banner](#banner) | ||||||||||||||||||||||
| * [Native](#native) | ||||||||||||||||||||||
| * [Prebid Server Test Request](#prebid-server-test-request) | ||||||||||||||||||||||
|
Comment on lines
+18
to
+27
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
bidder pages do not have a TOC ( yet ). This may be handled in the general template in the future. |
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Modules | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| SharedID: We need you to include SharedID module, which is used to get prebid user commonid. It can better differentiating users to bid on ads. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Note | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The SuperEdge Bidding adapter requires setup before beginning. Please contact us at <op@superedge.co.jp> | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Bid Params | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Prebid.js Bid Params | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {: .table .table-bordered .table-striped } | ||||||||||||||||||||||
| |-------------|-------------|-------------------------------------------------------------------------------------------------|--------------|-----------| | ||||||||||||||||||||||
| | Name | Scope | Description | Example | Type | | ||||||||||||||||||||||
| | `sk` | required | Publisher token, communicated by SuperEdge. | `'12341235'` | `string` | | ||||||||||||||||||||||
| | `publisher` | required | Publisher ID, communicated by SuperEdge. | `'abcdefg'` | `string` | | ||||||||||||||||||||||
| | `region` | recommended | Server region: `US`, `EU` or `APAC`. Default is `US`. | `'US'` | `string` | | ||||||||||||||||||||||
| | `test` | recommended | 0 (default): production mode.<br>1: dev mode, no charge, higher bid frequency for easier debug. | `1` / `0` | `integer` | | ||||||||||||||||||||||
| | `bidfloor` | recommended | Sets a floor price for the bid. | `0.05` | `float` | | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ### Prebid Server Bid Params | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {: .table .table-bordered .table-striped } | ||||||||||||||||||||||
| |----------|-------------|-------------------------------------------------------|--------------|----------| | ||||||||||||||||||||||
| | Name | Scope | Description | Example | Type | | ||||||||||||||||||||||
| | `sk` | required | Publisher token, communicated by SuperEdge. | `'12341235'` | `string` | | ||||||||||||||||||||||
| | `region` | recommended | Server region: `US`, `EU` or `APAC`. Default is `US`. | `'US'` | `string` | | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Banner | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```javascript | ||||||||||||||||||||||
| var adUnits = [{ | ||||||||||||||||||||||
| code: 'test-div', | ||||||||||||||||||||||
| mediaTypes: { | ||||||||||||||||||||||
| banner: { | ||||||||||||||||||||||
| sizes: [ | ||||||||||||||||||||||
| [300, 250], | ||||||||||||||||||||||
| [300, 600] | ||||||||||||||||||||||
| ] | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| bids: [{ | ||||||||||||||||||||||
| bidder: 'superedge', | ||||||||||||||||||||||
| params: { | ||||||||||||||||||||||
| sk: '12341235', // required | ||||||||||||||||||||||
| publisher: 'abcdefg', // required | ||||||||||||||||||||||
| region: 'US', // recommended - US, EU, or APAC | ||||||||||||||||||||||
| test: 0, // recommended - 0: production, 1: dev | ||||||||||||||||||||||
| bidfloor: 0.05 // recommended | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }] | ||||||||||||||||||||||
| }]; | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Native | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```javascript | ||||||||||||||||||||||
| var adUnits = [{ | ||||||||||||||||||||||
| code: 'test-div-native', | ||||||||||||||||||||||
| mediaTypes: { | ||||||||||||||||||||||
| native: { | ||||||||||||||||||||||
| ortb: { | ||||||||||||||||||||||
| assets: [{ | ||||||||||||||||||||||
| id: 1, | ||||||||||||||||||||||
| required: 1, | ||||||||||||||||||||||
| img: { | ||||||||||||||||||||||
| type: 3, | ||||||||||||||||||||||
| w: 150, | ||||||||||||||||||||||
| h: 50 | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| id: 2, | ||||||||||||||||||||||
| required: 1, | ||||||||||||||||||||||
| title: { | ||||||||||||||||||||||
| len: 80 | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| id: 3, | ||||||||||||||||||||||
| required: 1, | ||||||||||||||||||||||
| data: { | ||||||||||||||||||||||
| type: 1 | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| id: 4, | ||||||||||||||||||||||
| required: 1, | ||||||||||||||||||||||
| data: { | ||||||||||||||||||||||
| type: 2 | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }] | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| bids: [{ | ||||||||||||||||||||||
| bidder: 'superedge', | ||||||||||||||||||||||
| params: { | ||||||||||||||||||||||
| sk: '12341235', // required | ||||||||||||||||||||||
| publisher: 'abcdefg', // required | ||||||||||||||||||||||
| region: 'US', // recommended - US, EU, or APAC | ||||||||||||||||||||||
| test: 0, // recommended - 0: production, 1: dev | ||||||||||||||||||||||
| bidfloor: 0.05 // recommended | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }] | ||||||||||||||||||||||
| }]; | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Prebid Server Test Request | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The following test parameters can be used to verify that Prebid Server is working properly with the | ||||||||||||||||||||||
| server-side SuperEdge adapter. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ```json | ||||||||||||||||||||||
| { | ||||||||||||||||||||||
| "imp": [{ | ||||||||||||||||||||||
| "id": "some-impression-id", | ||||||||||||||||||||||
| "banner": { | ||||||||||||||||||||||
| "format": [{ | ||||||||||||||||||||||
| "w": 300, | ||||||||||||||||||||||
| "h": 250 | ||||||||||||||||||||||
| }, { | ||||||||||||||||||||||
| "w": 300, | ||||||||||||||||||||||
| "h": 600 | ||||||||||||||||||||||
| }] | ||||||||||||||||||||||
| }, | ||||||||||||||||||||||
| "ext": { | ||||||||||||||||||||||
| "bidder": { | ||||||||||||||||||||||
| "sk": "12341235", | ||||||||||||||||||||||
| "region": "US" | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| }] | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
| ``` | ||||||||||||||||||||||
Oops, something went wrong.
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.
Please add as many meta data as possible to help publishers vet your bidder.
https://docs.prebid.org/dev-docs/bidder-adaptor.html#submitting-your-adapter