-
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
Merged
Merged
Changes from 16 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
5ef437a
add scalibure md file to dev-docs
39c6370
move scalibure md to bidders folder
465cd09
add scalibur bidder adapter doc and tested
c09feb1
Add Scalibur bidder adapter documentation
5643efe
fix scalibur md file
dec36a6
revert package json to origin
fa91399
revert package json to origin
595aa8b
fix annotations
4009cc5
more annotation fixes
98750a8
more annotation fixes
8f9cefe
fix bid params rendering
aa119ac
Merge remote-tracking branch 'origin' into scalibur
5e0c231
t :wq
9b80b67
Merge branch 'master' into scalibur
22a0719
Merge branch 'master' into scalibur
6c79ea6
Merge branch 'master' into scalibur
20bce84
pr comments and other format issues fixed
de76362
Merge branch 'master' into scalibur
40b248a
Merge branch 'master' into scalibur
1458443
Merge branch 'master' into scalibur
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,213 @@ | ||||
| --- | ||||
| layout: bidder | ||||
| title: Scalibur | ||||
| description: Prebid Scalibur Bidder Adapter | ||||
| biddercode: scalibur | ||||
| gvlid: 1471 | ||||
| media_types: banner, video | ||||
| tcfeu_supported: true | ||||
| 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? |
||||
| usp_supported: true | ||||
| 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 | ||||
| --- | ||||
|
|
||||
| # Scalibur Bidder | ||||
|
|
||||
| ## Description | ||||
|
|
||||
| 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. | ||||
|
|
||||
| **Key Features:** | ||||
|
|
||||
| - Banner and Video (instream) ad support | ||||
| - OpenRTB 2.x compliant requests | ||||
| - Privacy regulation compliance | ||||
| - First-party data collection and storage | ||||
| - User sync capabilities (iframe and image) | ||||
| - Supply chain transparency (schain) | ||||
| - Floor pricing support | ||||
| - First Party Data (FPD) support | ||||
|
|
||||
| ## Bid Params | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| {: .table .table-bordered .table-striped } | ||||
| | Name | Scope | Description | Example | Type | | ||||
| |------|-------|-------------|---------|------| | ||||
| | `placementId` | required | Placement identifier provided by Scalibur | `'test-placement-123'` | `string` | | ||||
|
|
||||
| ## Test Parameters | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| For testing purposes, you can use the following ad unit configurations: | ||||
|
|
||||
| ### Banner Ad Unit | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| ```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 | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| ```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 | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| ```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 | ||||
|
|
||||
| ## Supply Chain Transparency | ||||
|
|
||||
| The adapter supports the Supply Chain Object (schain) for transparency in programmatic advertising transactions, helping to combat fraud and improve trust between buyers and sellers. | ||||
|
|
||||
| ## Floor Prices | ||||
|
|
||||
| The adapter respects floor prices set via: | ||||
|
|
||||
| - Prebid.js Price Floors module | ||||
| - Ad unit level floor configuration | ||||
| - Global floor configuration | ||||
|
|
||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| ## User Sync | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| 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 | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| ```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 | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| For technical support or integration assistance: | ||||
|
|
||||
| - **Email**: [support@scalibur.io](mailto:support@scalibur.io) | ||||
| - **Documentation**: Contact Scalibur Support Team | ||||
|
|
||||
| ## Notes | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
|
|
||||
| - The adapter requires a valid `placementId` parameter provided by Scalibur | ||||
bTimor marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||
| - 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 | ||||
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.