-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add Alva (alvads) bidder adapter documentation #6231
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a983122
Add Alva (alvads) bidder adapter documentation
0c68c7b
initial doc
b6d2b5f
Merge branch 'master' into alvads
SamuelAlejandroNT d65911d
added bidfloor support
8160306
Merge branch 'alvads' of https://github.com/SamuelAlejandroNT/prebid.…
507911f
Merge branch 'master' into alvads
SamuelAlejandroNT 1e14b38
Merge branch 'master' into alvads
lpagnypubstack 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
Some comments aren't visible on the classic Files Changed page.
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,140 @@ | ||
| --- | ||
| layout: bidder | ||
| title: Alva | ||
| description: Prebid Alva Bidder Adapter | ||
| pbjs: true | ||
| pbs_app_supported: false | ||
| biddercode: alvads | ||
| media_types: banner, video | ||
| gdpr_supported: true | ||
| usp_supported: true | ||
| coppa_supported: false | ||
| --- | ||
|
|
||
| # Overview | ||
|
|
||
| **Module Name:** alvadsBidAdapter | ||
| **Module Type:** Bidder | ||
| **Maintainer:** [[email protected]](mailto:[email protected]) | ||
|
|
||
| --- | ||
|
|
||
| # Description | ||
|
|
||
| The **Alva Bid Adapter** allows publishers to connect their banner and video inventory with the Alva demand platform. | ||
|
|
||
| - **Bidder Code:** `alvads` | ||
| - **Supported Media Types:** `banner`, `video` | ||
| - **Protocols:** OpenRTB 2.5 via `POST` (banner and video) | ||
| - **Dynamic Endpoints:** The adapter uses a default endpoint, but can be overridden via `params.endpoint`. | ||
|
|
||
| --- | ||
|
|
||
| # Test Parameters | ||
SamuelAlejandroNT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Banner Example | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: 'div-banner', | ||
| mediaTypes: { | ||
| banner: { | ||
| sizes: [[300, 250], [320, 100]] | ||
| } | ||
| }, | ||
| bids: [{ | ||
| bidder: 'alvads', | ||
| params: { | ||
| publisherId: 'pub-123', // required | ||
| tagid: 'tag-456', // required for banner | ||
| bidfloor: 0.50, // optional | ||
| userId: '+59165352182', // optional | ||
| endpoint: 'https://custom-endpoint.com/openrtb' // optional, overrides default | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| ### Video Example | ||
|
|
||
| ```javascript | ||
| var adUnits = [{ | ||
| code: 'video-ad', | ||
| mediaTypes: { | ||
| video: { | ||
| context: 'instream', | ||
| playerSize: [[640, 360]] | ||
| } | ||
| }, | ||
| bids: [{ | ||
| bidder: 'alvads', | ||
| params: { | ||
| publisherId: 'pub-123', // required | ||
| bidfloor: 0.5, // optional | ||
| userId: '+59165352182', // optional | ||
| endpoint: 'https://custom-endpoint.com/video' // optional, overrides default | ||
| } | ||
| }] | ||
| }]; | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| # Request Information | ||
|
|
||
| ### Banner / Video | ||
| - **Default Endpoint:** | ||
| ``` | ||
| https://helios-ads-qa-core.ssidevops.com/decision/openrtb | ||
| ``` | ||
| - **Method:** `POST` | ||
| - **Payload:** OpenRTB 2.5 request containing `site`, `device`, `user`, `regs`, and `imp`. | ||
| - **Dynamic Endpoint:** Can be overridden via `bid.params.endpoint`. | ||
|
|
||
| --- | ||
|
|
||
| # Response Information | ||
|
|
||
| ### Banner | ||
| The response is standard OpenRTB with `seatbid`. | ||
|
|
||
| ```json | ||
| { | ||
| "id": "response-id", | ||
| "seatbid": [{ | ||
| "bid": [{ | ||
| "impid": "imp-123", | ||
| "price": 0.50, | ||
| "adm": "<div>Creative</div>", | ||
| "crid": "creative-1", | ||
| "w": 320, | ||
| "h": 100, | ||
| "ext": { | ||
| "vast_url": "http://example.com/vast.xml" | ||
| }, | ||
| "adomain": ["example.com"] | ||
| }] | ||
| }], | ||
| "cur": "USD" | ||
| } | ||
| ``` | ||
|
|
||
| ### Interpretation | ||
| - If `adm` contains `<VAST>`, the adapter sets `mediaType: 'video'` and includes `vastXml` & `vastUrl`. | ||
| - Otherwise, `mediaType: 'banner'` and the ad contains the HTML markup. | ||
|
|
||
| --- | ||
|
|
||
| # Additional Details | ||
|
|
||
| - **Defaults:** | ||
| - `netRevenue = true` | ||
| - `ttl = 300` | ||
| - Banner fallback size: `320x100` | ||
| - Video fallback size: `1280x720` | ||
|
|
||
| - **Callbacks:** | ||
| - `onTimeout` → logs timeout events | ||
| - `onBidWon` → logs winning bids | ||
|
|
||
| --- | ||
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.
Uh oh!
There was an error while loading. Please reload this page.