-
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
Changes from all commits
a983122
0c68c7b
b6d2b5f
d65911d
8160306
507911f
1e14b38
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| --- | ||
| 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`. | ||
| - **Price Floors:** Supported via `bid.getFloor()`. If configured, the adapter will send `bidfloor` and `bidfloorcur` per impression. | ||
|
|
||
| --- | ||
SamuelAlejandroNT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # Parameters | ||
SamuelAlejandroNT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| | Parameter | Required | Description | | ||
| |------------ |---------------- |------------ | | ||
| | publisherId | Yes | Publisher ID assigned by Alva | | ||
| | tagid | Banner only | Required for banner impressions | | ||
| | bidfloor | No | Optional; adapter supports floors module via `bid.getFloor()` | | ||
| | userId | No | Optional; used for user identification | | ||
| | endpoint | No | Optional; overrides default endpoint | | ||
|
|
||
| --- | ||
|
|
||
| # Test Parameters | ||
SamuelAlejandroNT marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Banner Example | ||
|
Check failure on line 47 in dev-docs/bidders/alvads.md
|
||
|
|
||
| ```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 | ||
|
Check failure on line 97 in dev-docs/bidders/alvads.md
|
||
| - **Default Endpoint:** | ||
|
Check failure on line 98 in dev-docs/bidders/alvads.md
|
||
| ``` | ||
|
Check failure on line 99 in dev-docs/bidders/alvads.md
|
||
| https://helios-ads-qa-core.ssidevops.com/decision/openrtb | ||
| ``` | ||
|
Check failure on line 101 in dev-docs/bidders/alvads.md
|
||
| - **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 | ||
|
Check failure on line 110 in dev-docs/bidders/alvads.md
|
||
| 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`. | ||
|
Check failure on line 135 in dev-docs/bidders/alvads.md
|
||
| - Otherwise, `mediaType: 'banner'` and the ad contains the HTML markup. | ||
|
|
||
| --- | ||
|
|
||
| # Additional Details | ||
|
|
||
| - **Defaults:** | ||
| - `netRevenue = true` | ||
|
Check failure on line 143 in dev-docs/bidders/alvads.md
|
||
| - `ttl = 300` | ||
|
Check failure on line 144 in dev-docs/bidders/alvads.md
|
||
| - Banner fallback size: `320x100` | ||
| - Video fallback size: `1280x720` | ||
|
|
||
| - **Callbacks:** | ||
| - `onTimeout` → logs timeout events | ||
| - `onBidWon` → logs winning bids | ||
|
|
||
| --- | ||
Uh oh!
There was an error while loading. Please reload this page.