-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add Scalibur bidder adapter documentation #6235
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
5ef437a
39c6370
465cd09
c09feb1
5643efe
dec36a6
fa91399
595aa8b
4009cc5
98750a8
8f9cefe
aa119ac
5e0c231
9b80b67
22a0719
6c79ea6
20bce84
de76362
40b248a
1458443
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,185 @@ | ||||
| --- | ||||
| layout: bidder | ||||
| title: Scalibur | ||||
| description: Prebid Scalibur Bidder Adapter | ||||
| biddercode: scalibur | ||||
| gvl_id: 1471 | ||||
| media_types: banner, video | ||||
| gpp_supported: true | ||||
|
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
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. Would have been nice to see this removed. Can you do this in a small PR? |
||||
| gpp_sids: tcfeu, usstate_all, usp | ||||
| coppa_supported: true | ||||
| schain_supported: true | ||||
| dchain_supported: false | ||||
| safeframes_ok: true | ||||
| deals_supported: false | ||||
| floors_supported: true | ||||
| fpd_supported: true | ||||
| pbjs: true | ||||
| pbs: false | ||||
| prebid_member: false | ||||
| multiformat_supported: will-bid-on-any | ||||
| ortb_blocking_supported: false | ||||
| userIds: all | ||||
| pbs_app_supported: false | ||||
| --- | ||||
|
|
||||
| The Scalibur Bid Adapter connects publishers to Scalibur's programmatic advertising platform. It supports both banner and video ad formats through OpenRTB 2.x protocol and provides full compliance with privacy regulations. | ||||
|
|
||||
| ### Bid Params | ||||
|
|
||||
| {: .table .table-bordered .table-striped } | ||||
|
|
||||
| | Name | Scope | Type | Description | Example | | ||||
| | ---- | ----- | ---- | ----------- | ------- | | ||||
| | `placementId` | required | String | Placement identifier provided by Scalibur | `'test-placement-123'` | | ||||
|
|
||||
| ### Test Parameters | ||||
|
|
||||
| For testing purposes, you can use the following ad unit configurations: | ||||
|
|
||||
| #### Banner Ad Unit | ||||
|
|
||||
| ```javascript | ||||
| var adUnits = [ | ||||
| { | ||||
| code: 'test-banner-div', | ||||
| mediaTypes: { | ||||
| banner: { | ||||
| sizes: [[300, 250], [728, 90], [320, 50]] | ||||
| } | ||||
| }, | ||||
| bids: [ | ||||
| { | ||||
| bidder: 'scalibur', | ||||
| params: { | ||||
| placementId: 'test-scl-placement' | ||||
| } | ||||
| } | ||||
| ] | ||||
| } | ||||
| ]; | ||||
| ``` | ||||
|
|
||||
| #### Video Ad Unit | ||||
|
|
||||
| ```javascript | ||||
| var adUnits = [ | ||||
| { | ||||
| code: 'test-video-div', | ||||
| mediaTypes: { | ||||
| video: { | ||||
| playerSize: [[640, 480]], | ||||
| context: 'instream', | ||||
| mimes: ['video/mp4'], | ||||
| protocols: [2, 3, 5, 6], | ||||
| minduration: 5, | ||||
| maxduration: 30, | ||||
| startdelay: 0, | ||||
| playbackmethod: [1, 2], | ||||
| api: [1, 2] | ||||
| } | ||||
| }, | ||||
| bids: [ | ||||
| { | ||||
| bidder: 'scalibur', | ||||
| params: { | ||||
| placementId: 'test-scl-placement' // Required | ||||
| } | ||||
| } | ||||
| ] | ||||
| } | ||||
| ]; | ||||
| ``` | ||||
|
|
||||
| #### Multi-format Ad Unit | ||||
|
|
||||
| ```javascript | ||||
| var adUnits = [ | ||||
| { | ||||
| code: 'test-multiformat-div', | ||||
| mediaTypes: { | ||||
| banner: { | ||||
| sizes: [[300, 250], [728, 90]] | ||||
| }, | ||||
| video: { | ||||
| context: 'instream', | ||||
| playerSize: [[300, 169]], | ||||
| mimes: ['video/mp4'], | ||||
| protocols: [2, 3, 5, 6], | ||||
| minduration: 15, | ||||
| maxduration: 30 | ||||
| } | ||||
| }, | ||||
| bids: [ | ||||
| { | ||||
| bidder: 'scalibur', | ||||
| params: { | ||||
| placementId: 'test-scl-placement' | ||||
| } | ||||
| } | ||||
| ] | ||||
| } | ||||
| ]; | ||||
| ``` | ||||
|
|
||||
| ### First Party Data | ||||
|
|
||||
| The adapter supports First Party Data (FPD) in multiple ways: | ||||
|
|
||||
| - **Global FPD**: Automatically includes `pbjs.setConfig({ortb2: {...}})` data | ||||
| - **AdUnit FPD**: Includes ad unit specific `ortb2Imp` data | ||||
| - **Local Storage**: Generates and stores first-party identifiers for enhanced targeting | ||||
|
|
||||
| ### User Sync | ||||
|
|
||||
| The Scalibur adapter supports user synchronization through: | ||||
|
|
||||
| - **Iframe syncs**: For enhanced matching capabilities | ||||
| - **Image syncs**: For lightweight synchronization | ||||
|
|
||||
| All privacy parameters are automatically included in sync requests. | ||||
|
|
||||
| #### Configuration Example | ||||
|
|
||||
| ```javascript | ||||
| pbjs.que.push(function() { | ||||
| pbjs.addAdUnits(adUnits); | ||||
|
|
||||
| pbjs.setConfig({ | ||||
| debug: true, | ||||
| userSync: { | ||||
| filterSettings: { | ||||
| iframe: { | ||||
| bidders: ['scalibur'], | ||||
| filter: 'include' | ||||
| }, | ||||
| image: { | ||||
| bidders: ['scalibur'], | ||||
| filter: 'include' | ||||
| } | ||||
| } | ||||
| } | ||||
| }); | ||||
|
|
||||
| pbjs.requestBids({ | ||||
| timeout: 3000, | ||||
| bidsBackHandler: function(bidResponses) { | ||||
| // Handle bid responses | ||||
| } | ||||
| }); | ||||
| }); | ||||
| ``` | ||||
|
|
||||
| ### Support | ||||
|
|
||||
| For technical support or integration assistance: | ||||
|
|
||||
| - **Email**: [[email protected]](mailto:[email protected]) | ||||
| - **Documentation**: Contact Scalibur Support Team | ||||
|
|
||||
| ### Notes | ||||
|
|
||||
| - Video ads support instream context with standard IAB video parameters | ||||
| - Banner ads support multiple sizes including standard IAB sizes | ||||
| - All requests are sent via secure HTTPS endpoints | ||||
| - The adapter automatically handles device detection and targeting | ||||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Uh oh!
There was an error while loading. Please reload this page.