Skip to content

Commit

Permalink
Merge branch 'master' of github.com:prebid/prebid.github.io into add-…
Browse files Browse the repository at this point in the history
…melozen-doc
  • Loading branch information
benben2001 committed Jul 9, 2024
2 parents c940918 + c6eed11 commit 79f6d77
Show file tree
Hide file tree
Showing 29 changed files with 564 additions and 336 deletions.
8 changes: 0 additions & 8 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -257,14 +257,6 @@
sectionTitle:
subgroup: 1

- sbSecId: 1
title: Legacy Browser Example
link: /dev-docs/examples/legacy-browser-example.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 1
title: Using Prebid.js with Microsoft Monetize Ad Server
link: /dev-docs/examples/use-prebid-with-appnexus-ad-server.html
Expand Down
15 changes: 14 additions & 1 deletion dev-docs/analytics/concert.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,21 @@ title: Concert
description: Concert Analytics Adapter
modulecode: concert
enable_download: false
prebid_member: false
tcfeu_supported: false
usp_supported: true
gvl_id: N/A
coppa_supported: false
---

#### Registration

Please visit [concert.io](https://concert.io/) for more information.
The Concert analytics adapter requires setup and approval from the Concert team. Please reach out to <[email protected]> or visit [concert.io](https://concert.io/) for more information.

### Example Configuration

```javascript
pbjs.enableAnalytics({
provider: 'concert',
});
```
19 changes: 17 additions & 2 deletions dev-docs/bidders/adnuntius.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ pbjs.setBidderConfig({
});
```

### Disable cookies for adnuntius
### Disable cookies for Adnuntius

You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuintius will not set it for internal ads.
You have the option to tell adnuntius not to set cookies in your browser. This does not mean that third party ads being served through the ad server will not set cookies. Just that Adnuntius will not set it for internal ads.

```js
pbjs.setBidderConfig({
Expand All @@ -101,6 +101,21 @@ pbjs.setBidderConfig({

Use cookie will always be set to true by default. Changing it to false will disable cookies.

### Trigger Advertiser Transparency Mode in Adnuntius

You have the option to tell Adnuntius to only serve ads that have their Advertiser's legal name specified.

```js
pbjs.setBidderConfig({
bidders: ['adnuntius'],
config: {
advertiserTransparency: true
}
});
```

By default, `advertiserTransparency` is set to `false`, meaning there is no restriction on which ads can deliver. By setting `advertiserTransparency` to `true`, ad delivery is restricted to those that have their Advertiser's legal name specified.

### Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the server-side Adnuntius adapter. the `auId` below will not return a creative. Please substitute it with your own.
Expand Down
9 changes: 5 additions & 4 deletions dev-docs/bidders/blasto.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,18 @@ userIds: all

### Note

The Example Bidding adapter requires setup before beginning. Please contact us at <[email protected]>. Blasto will only respond to the first impression and that multiple ad formats of that single impression are not supported.
The Example Bidding adapter requires setup before beginning. Please contact us at <[email protected]>.
Blasto will only respond to the first impression.

### Bid Params for Prebid Server and Prebid Mobile
### Bid Params for Prebid Server
Blasto supports diffrent regions for the prebid server. By default US East.
Please deploy the prebid config in each of your datacenters with the appropriate regional subdomain.

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------|-----------|-----------|
| `sourceId` | required | Unique hash provided by blasto | `'6dllcEHSxYdSb6yLmCqE'` | `string` |
| `accountId` | required | Unique name provided by blasto | `'blasto-test'` | `string` |
| `host` | optional | Blasto server region. US East by default | `'us-e-node1'` | `string` |
| `placementId` | required | Deprecated parameter. Please use sourceId instead |`'6dllcEHSxYdSb6yLmCqE'`|`string` |

### Bid Params for Prebid.js

Expand Down
1 change: 1 addition & 0 deletions dev-docs/bidders/cointraffic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: bidder
title: Cointraffic
description: Prebid Cointraffic Bidder Adaptor
pbjs: true
pbs: true
biddercode: cointraffic
sidebarType: 1
---
Expand Down
4 changes: 0 additions & 4 deletions dev-docs/bidders/colossus.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ pbs_app_supported: true
sidebarType: 1
---

### Disclosure

This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.

### Prebid.Server Bid Params

{: .table .table-bordered .table-striped }
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders/colossusssp.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ sidebarType: 1
| `group_id` | optional | Group Id will be generated on Colossus SSP Platform. Use instead of placement_id | `0` | `integer` |
| `traffic` | optional | Type traffic | `'banner'` | `string` |

*For colossus prebid server parametres, look into colossus.md*
*For colossus prebid server parameters, look into colossus.md*
5 changes: 4 additions & 1 deletion dev-docs/bidders/concert.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ title: Concert
description: Prebid Concert Bidder Adaptor
hide: true
pbjs: true
pbs: true
biddercode: concert
media_types: banner
media_types: banner, audio, video
pbs_app_supported: true
deals_supported: true
tcfeu_supported: false
usp_supported: true
gpp_supported: true
Expand Down
35 changes: 35 additions & 0 deletions dev-docs/bidders/copper6ssp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: bidder
title: Copper6SSP
description: Prebid Copper6SSP Bidder Adapter
biddercode: copper6ssp
gpp_sids: usstate_all
tcfeu_supported: false
usp_supported: true
coppa_supported: true
schain_supported: true
deals_supported: false
floors_supported: true
fpd_supported: false
ortb_blocking_supported: false
media_types: banner, video, native
multiformat_supported: will-bid-on-one
userIds: all
pbjs: true
pbs: false
pbs_app_supported: true
safeframes_ok: true
sidebarType: 1
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|--------------|---------------------------------|------------|
| `placementId` | optional | Placement Id | `'0'` | `'string'` |
| `endpointId` | optional | Endpoint Id | `'0'` | `'string'` |

### Note

For the prebid server and prebid.js you only need to use one parameter: either placementId or endpointId
6 changes: 4 additions & 2 deletions dev-docs/bidders/inmobi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ For queries, write to us at <[email protected]>

### User Sync Disclosure

InMobi has partnered with a third party, ID5, to use their ID as our primary user identifier for mobile web supply. We will also rely on ID5 IDs to handle compliance flows related to Data Subject Right requests in our systems. Hence, we require the publisher to use ID5’s sync URL for user syncing and passing the corresponding ID5 ID to InMobi in the bid request. For this purpose, we provide ID5’s sync URL in our Prebid adapter for User ID sync. Note that, InMobi has a direct contract with ID5 for consuming ID5 ID and the user sync via Prebid does not require the publisher to get into a contractual relationship with ID5.
Third-party cookie syncing helps publishers leverage their audience data, enhance targeting capabilities, and drive better ad performance. InMobi third party cookie syncing improves monetization for publishers by giving them a competitive positioning in the digital advertising ecosystem.
Ids for third parties can be synced through our pixel: `https://sync.inmobi.com/prebid?gdpr={GDPR}&gdpr_consent={GDPR_CONSENT}&us_privacy={US_PRIVACY}&redirect={RedirectURL}` .
The RedirectURL should contain uuid macro, which is {ID5UID}.

To opt out of InMobi ads on mobile web inventory or for any other requests, the user needs to visit the Opt-out page on InMobi website (<https://www.inmobi.com/page/opt-out/>). For opting out of ID5 ID entirely, the user needs to visit ID5’s opt out page: <https://id5.io/platform-privacy-policy/>.
To opt out of InMobi ads on web inventory the user needs to visit the Opt-out page on InMobi website `https://www.inmobi.com/page/opt-out/`.

### Bid Params

Expand Down
4 changes: 0 additions & 4 deletions dev-docs/bidders/kargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ pbjs_version_notes: if you require schains, avoid versions 7.46 to 7.53
sidebarType: 1
---

### Disclosure

This adapter is known to use an HTTP 1 endpoint. Header bidding often generates multiple requests to the same host and bidders are encouraged to change to HTTP 2 or above to help improve publisher page performance via multiplexing.

### Note

Kargo is an invitation-only marketplace. Please reach out to your Kargo account manager to get setup. Also, you *must* test on a mobile device, or emulate a mobile device by manipulating the user agent string sent to the server.
Expand Down
39 changes: 39 additions & 0 deletions dev-docs/bidders/markapp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
layout: bidder
title: MarkApp
description: MarkApp Bidder Adapter
biddercode: markapp
aliasCode : smarthub
usp_supported: true
coppa_supported: true
schain_supported: true
dchain_supported: true
media_types: banner, video, native
safeframes_ok: true
deals_supported: true
floors_supported: true
fpd_supported: false
pbjs: true
pbs: true
pbs_app_supported: true
multiformat_supported: will-bid-on-any
---

### Prebid.js Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------------------|-------------------------------------|-----------|
| `seat` | required | Seat value | `'9Q20EdGxzgWdfPYShScl'` | `string` |
| `token` | required | Token | `'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW'` | `string` |
| `iabCat` | optional | Array of IAB content categories that describe the content producer | `['IAB1-1', 'IAB3-1', 'IAB4-3']` | `Array(String)` |
| `minBidfloor` | optional | Minimal CPM value | `0.03` | `float` |
| `pos` | optional | The position of the placement on the page, see Open RTB spec v2.5. | `4` | `number` |

### Prebid Server Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------|--------------------------------------|----------|
| `seat` | required | Seat value | `'9Q20EdGxzgWdfPYShScl'` | `string` |
| `token` | required | Token | `'eKmw6alpP3zWQhRCe3flOpz0wpuwRFjW'` | `string` |
8 changes: 6 additions & 2 deletions dev-docs/bidders/mgidX.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@ layout: bidder
title: MgidX
description: Prebid MgidX Bidder Adapter
biddercode: mgidX
usp_supported: true
gdpr_supported: true
gpp_sids: usstate_all
tcfeu_supported: true
usp_supported: true
coppa_supported: true
schain_supported: true
deals_supported: false
floors_supported: true
fpd_supported: false
ortb_blocking_supported: false
media_types: banner, video, native
multiformat_supported: will-not-bid
userIds: all
pbjs: true
pbs: true
pbs_app_supported: true
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/bidders/openweb.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ gpp_supported: true
gpp_sids: tcfeu, usstate_all, usp
usp_supported: true
safeframes_ok: false
pbs: false
pbs: true
floors_supported: true
userIds: all
fpd_supported: true
Expand Down
34 changes: 30 additions & 4 deletions dev-docs/bidders/admixerwl.md → dev-docs/bidders/rtbstack.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: bidder
title: AdmixerWL
title: RTB Stack
description: Prebid AdMixer Bidder Adaptor
pbjs: true
biddercode: admixerwl
biddercode: rtbstack
aliasCode: admixer
media_types: banner, video, native
tcfeu_supported: true
Expand All @@ -18,11 +18,37 @@ multiformat_supported: will-bid-on-any
safeframes_ok: true
---

#### Bidder Configuration

RTB Stack bidder requires bidderURL to be set. Please note that rtbstack bids will not be requested without this config. It must be set before auction starts.

```js
pbjs.setBidderConfig({
bidders: ['rtbstack'],
config: {
bidderURL: 'https://us-adx-example.rtb-stack.com/prebid?client=44e2d241-5051-4b58-8ac6-f17e13732339&ssp=3&endpoint=777'
}
});
```

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------------|----------|--------------------------------------------------------------------------------------------|------------------------------|----------|
| `endpointId` | required | Unique Entity ID. Could be obtained from your account manager. | 51772 | `int` |
| `clientId` | required | Unique Entity ID. Could be obtained from your account manager. | 312 | `int` |
| `tagId` | required |The unique identifier of the ad placement. Will be used for comparison of statistics. | 51772 | `int` |
| `kvTargeting` | optional | Key/Value - a pair of the unique values that will be used for the custom targeting option. | {key1: value2, key2: value2} | `object` |

#### Bid Example

```js
{
bidder: 'rtbstack',
params: {
tagId: '12345',
kvTargeting: {
example: 'test'
}
}
}
```
18 changes: 13 additions & 5 deletions dev-docs/bidders/smilewanted.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@
layout: bidder
title: Smile Wanted
description: SmileWanted Bidder Adapter
media_types: banner, video
pbjs: true
pbs: true
biddercode: smilewanted
tcfeu_supported: false
gvl_id: 639
usp_supported: true
coppa_supported: true
schain_supported: true
userIds: all
gvl_id: 639
media_types: banner, video, native
safeframes_ok: true
deals_supported: true
floors_supported: true
pbjs: true
pbs: true
prebid_member: false
multiformat_supported: will-bid-on-one
privacy_sandbox: no
sidebarType: 1
---

Expand Down Expand Up @@ -37,7 +45,7 @@ You can add `#sw_test_campaign` to the end of any URL. This will have the effect

Add the following code to enable user sync. Smile Wanted strongly recommends enabling user syncing through iFrames. This functionality improves partners' user match rates and increases the Smile Wanted bid rate and bid price. Be sure to call `pbjs.setConfig()` only once.

```
```javascript
pbjs.setConfig({
userSync: {
iframeEnabled: true,
Expand Down
31 changes: 31 additions & 0 deletions dev-docs/bidders/stailamedia.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: bidder
title: stailamedia
description: stailamedia Bidder Adapter
biddercode: stailamedia
aliasCode: appnexus
tcfeu_supported: true
gvl_id: 32
schain_supported: true
userId: all
media_types: banner, video, native
safeframes_ok: true
deals_supported: true
pbjs: true
pbs: true
prebid_member: false
multiformat_supported: will-bid-on-any
sidebarType: 1
---
### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------|-----------|-----------|
| `placement_id` (PBS+PBJS) or `placementId` (PBJS) | required | Placement id | `'33037108'` | `string` |

stailamedia is an aliased bidder for AppNexus.

### Note

For setup with stailamedia, please reach out to [[email protected]](mailto:[email protected])
5 changes: 3 additions & 2 deletions dev-docs/bidders/teads.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ fpd_supported: false
sidebarType: 1
---

### Note
### Notes

The Teads Bidding adapter requires setup before beginning. Please contact us on <https://teads.tv/teads-contact/>
1. The Teads Bidding adapter requires setup before beginning. Please contact us on <https://teads.tv/teads-contact/>
2. When this adapter is enabled and Prebid.js is used in an iOS WebView, the WebView should allow videos to play inline. This is required because the Teads adapter delivers video ads and starts by detecting the autoplay capability of the device.

### Bid Params

Expand Down
Loading

0 comments on commit 79f6d77

Please sign in to comment.