-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add documentation for new stailamedia aliases (msftstaila) #6671
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
Pubstream
wants to merge
12
commits into
prebid:master
Choose a base branch
from
Click-Performance-GmbH:master
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.
Open
Changes from 2 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
486c3eb
Add documentation for new scoremedia aliases (msftstalia)
Pubstream 472f2ae
Update msftstalia.md
Pubstream f342234
Update dev-docs/bidders/msftstalia.md
Pubstream 7ccb0c8
Update dev-docs/bidders/msftstalia.md
Pubstream faaec84
Update dev-docs/bidders/msftstalia.md
Pubstream 781cfe3
Update dev-docs/bidders/msftstalia.md
Pubstream 20a1c96
Update dev-docs/bidders/msftstalia.md
Pubstream a3d0776
Update dev-docs/bidders/msftstalia.md
Pubstream 4c3ad50
Update dev-docs/bidders/msftstalia.md
Pubstream c01d5ca
Update dev-docs/bidders/msftstalia.md
Pubstream f37f410
Rename msftstalia.md to msftstaila.md
Pubstream fe85b5b
apply 2 markdownlint fixes
Pubstream 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,99 @@ | ||
| --- | ||
| layout: bidder | ||
| title: msftstaila | ||
| description: Prebid Microsoft Bidder Adaptor | ||
| biddercode: msftstaila | ||
| aliasCode : msft | ||
| media_types: banner, video, native | ||
| tcfeu_supported: true | ||
| dsa_supported: true | ||
| prebid_member: true | ||
| userIds: all (with commercial activation) | ||
| schain_supported: true | ||
| coppa_supported: true | ||
| usp_supported: true | ||
| gpp_supported: true | ||
| floors_supported: true | ||
| fpd_supported: true | ||
| pbjs: true | ||
| pbjs_version_notes: | ||
| pbs: true | ||
| gvl_id: 32 | ||
| sidebarType: 1 | ||
| --- | ||
|
|
||
| ## Bid Params | ||
|
|
||
| **NOTE** | ||
| msftstaila is an aliased bidder of Microsoft. | ||
| Either `placement_id` OR both `member` and `inv_code` are required. Please don't specify all three together, it may impact delivery. | ||
|
|
||
| **NOTE** | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
| We recommend to use the “use_pmt_rule” parameter set to true, when integrating, to ensure the bidding is net. | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
|
|
||
| For setup with Staila Media, please reach out to [prebid@stailamedia.com](mailto:prebid@stailamedia.com). | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
|
|
||
| | Name | Scope | Description | Example | Type | | ||
| | :--- | :--- | :--- | :--- | :--- | | ||
| | `placement_id` | required (see note above) | The placement ID from Microsoft Monetize. You may identify a placement using the `inv_code` and `member` instead of a placement ID. | `11223344` | `integer` | | ||
| | `member` | required (see note above) | The member ID from Microsoft Monetize. Must be used with `inv_code`. | `1234` | `integer` | | ||
| | `inv_code` | required (see note above) | The inventory code from Microsoft Monetize. Must be used with `member`. | `'abc123'` | `string` | | ||
| | `allow_smaller_sizes` | optional | If `true`, ads smaller than the values in your ad unit's `sizes` array will be allowed to serve. Defaults to `false`. | `true` | `boolean` | | ||
| | `use_pmt_rule` | optional | If `true`, Microsoft Monetize will return net price to Prebid.js after publisher payment rules have been applied. | `true` | `boolean` | | ||
| | `keywords` | optional | A comma-delimited string of key-value pairs (or terms) applied to this specific ad slot on the page. Mapped to [buy-side segment targeting](https://learn.microsoft.com/en-us/xandr/monetize/segment-targeting) (login required). A maximum of 100 key/value pairs can be defined at the request/page level. Each tag can have up to 100 additional key/value pairs defined. If you want to pass keywords for all adUnits, please use the relevant keywords fields in the First Party Data feature. Note that to use keyword with the Prebid Server adapter, that feature must be enabled for your account by an Microsoft Monetize account manager. | `pet=dog,food,brand=oldroy` | `string` | | ||
| | `traffic_source_code` | optional | Specifies the third-party source of this impression. | `'my_traffic_source'` | `string` | | ||
| | `pubclick` | optional | Specifies a publisher-supplied URL for third-party click tracking. This is just a placeholder into which the publisher can insert their own click tracker. This parameter should be used for an unencoded tracker. This parameter is expected to be the last parameter in the URL. Please note that the click tracker placed in this parameter will only fire if the creative winning the auction is using Microsoft Monetize click tracking properly. | `'http://click.adserver.com/'` | `string` | | ||
| | `ext_inv_code` | optional | Specifies predefined value passed on the query string that can be used in reporting. The value must be entered into the system before it is logged. | `'10039'` | `string` | | ||
| | `ext_imp_id` | optional | Specifies the unique identifier of an externally generated auction. | `'bacbab02626452b097f6030b3c89ac05'` | `string` | | ||
| | `banner_frameworks` | optional | Array of integers listing API frameworks for Banner supported by the publisher. | `[1,2]` | `array of integers` | | ||
|
|
||
| <a name="migration-from-appnexus-bid-params"></a> | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Migrating from the AppNexus Bid Adapter & Bid Params | ||
|
|
||
| If you are migrating from the AppNexus bid adapter, a number of the previously available AppNexus bid parameters have been deprecated as available options for the Microsoft bid parameters. These deprecated bid parameters are still available however, they're just read from other standarized locations offered within Prebid.js. This change was implemented to help us align better to the publisher-aligned features (such as First Party Data) to use a single setup for many bidders. | ||
|
|
||
| The Microsoft Bid Adapter connects to Microsoft's advertising exchange for bids. This adapter supports banner, video (instream and outstream), and native ad formats using OpenRTB 2.5 standards. | ||
|
|
||
| For reference, here is the IAB OpenRTB 2.5 [specification](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) | ||
|
|
||
| The following table shows how the bid parameters have changed between the two adapters: | ||
|
|
||
| {: .table .table-bordered .table-striped } | ||
|
|
||
| | AppNexus Parameter | Microsoft Parameter | Description | | ||
| | :--- | :--- | :--- | | ||
| | `params.placementId` | `params.placement_id` | Placement ID (**only** the underscore case is now supported in the name, value **only** accepts integers) | | ||
| | `params.member` | `params.member` | Member ID (value **only** accepts integers) | | ||
| | `params.inv_code` | `params.inv_code` | Inventory code (unchanged) | | ||
| | `params.publisher_id` | Use `ortb2.publisher.id` | Publisher ID (moved to ortb2 config) | | ||
| | `params.frameworks` | `params.banner_frameworks` | Banner API frameworks array (small name change to clarify banner only) | | ||
| | `params.user` | Use `ortb2.user` | User data (moved to ortb2 config) | | ||
| | `params.allow_smaller_sizes` | `params.allow_smaller_sizes` | Allow smaller ad sizes (unchanged) | | ||
| | `params.use_pmt_rule` | `params.use_pmt_rule` | Use payment rule (unchanged) | | ||
| | `params.keywords` | `params.keywords` | Tag/Imp-level keywords (use ORTB format of comma-delimited string value; eg `'pet=cat,food,brand=fancyfeast'`) | | ||
| | `params.video` | Use `mediaTypes.video` | Video parameters (moved to mediaTypes) | | ||
| | `params.video.frameworks` | Use `mediaTypes.video.api` | Video API frameworks (moved to mediaTypes) | | ||
| | `params.app` | Use `ortb2.app` | App data (moved to ortb2 config) | | ||
| | `params.reserve` | Use bidfloor module | Reserve price (use bidfloor module) | | ||
| | `params.position` | Use `mediaTypes.banner.pos` | Banner position (moved to mediaTypes) | | ||
| | `params.traffic_source_code` | `params.traffic_source_code` | Traffic source code (unchanged) | | ||
| | `params.supply_type` | Use `ortb2.site` or `ortb2.app` | Supply type (moved to ortb2 config) | | ||
| | `params.pub_click` | `params.pubclick` | Publisher click URL (dropped underscore to align to endpoint) | | ||
| | `params.ext_inv_code` | `params.ext_inv_code` | External inventory code (unchanged) | | ||
| | `params.external_imp_id` | `params.ext_imp_id` | External impression ID (shortend to ext) | | ||
|
|
||
| ### Keywords | ||
| With the AppNexus adapter, keywords followed this format: keyname=keyvalue1,keyvalue2,keyvalue3 | ||
|
|
||
| In the Microsoft Bid Adapter, the new required format is: keyname=keyvalue1,keyname=keyvalue2,keyname=keyvalue3 | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### First Party Data | ||
|
|
||
| Publishers should use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
|
|
||
| PBS/PSP supports all first party data fields: site, user, segments, and imp-level first party data. | ||
|
|
||
| <a name="debug-auction"></a> | ||
|
Pubstream marked this conversation as resolved.
Outdated
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.