Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
macinjosh32 authored Oct 31, 2023
2 parents ebf984c + 972f543 commit 3de6ddc
Show file tree
Hide file tree
Showing 9 changed files with 193 additions and 45 deletions.
2 changes: 1 addition & 1 deletion _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@

- sbSecId: 2
title: Prebid Plugin Renderer
link: /prebid-mobile/pbm-api/android/pbm-plugin-rederer.html
link: /prebid-mobile/pbm-api/android/pbm-plugin-renderer.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
Expand Down
6 changes: 5 additions & 1 deletion dev-docs/bidders/adagio.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ pbjs.bidderSettings = {
| `adUnitElementId` | required | Refers to the adunit html attribute id in a page. | `'gpt-ban-atf'` | `string` |
| `pagetype`* | highly recommended | Describes what kind of content will be present in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'article'` | `string` |
| `category`* | recommended | Category of the content displayed in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'sport'` | `string` |
| `video` | optional | OpenRTB video options object. All options will override ones defined in mediaTypes video.<br>Mandatory: <br>- api <small><i>(your video player must at least support the value 2 and/or 7)</i></small><br> Highly recommended: <br> - playbackmethod | `{api: [2, 7], playbackmethod: [6], skip: 1, startdelay: 0}` |
| `video` | optional | OpenRTB 2.5 video options object. All options will override ones defined in mediaTypes video.<br>Mandatory: <br>- api <small><i>(your video player must at least support the value 2)</i></small><br> Highly recommended: <br> - playbackmethod <br> Not supported: <br>`protocol`, `companionad`, `companiontype`, `ext` options| `{api: [2], playbackmethod: [6], skip: 1, startdelay: 0}` |
| `native` | optional | Partial OpenRTB Native 1.2 request object. Supported fields are:<br>- context<br>- plcmttype | `{context: 1, plcmttype: 2}` | `object` |
| `splitKeyword` | optional | Keyword that can later be used in a split rule targeting to trigger the rule (especially for Direct Seats AB testing) | `'splitrule-one'` | `string` |
| `dataLayer` | optional | A set of arbitrary key-value pairs. This can be used to configure mappings. The keys and values must be strings. | `{placement: 'my-placement', siteid: 'my-siteid'}` | `object` |
Expand All @@ -89,3 +89,7 @@ Adagio will use FPD data as fallback for the params below:
- category

If the FPD value is an array, the 1st value of this array will be used.

### Video outstream

The AdagioBidAdapter includes a default video player powered by [Blue Billywig](https://www.bluebillywig.com). This default player is used when no renderer is configured for the adUnit.
26 changes: 26 additions & 0 deletions dev-docs/bidders/iqx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: bidder
title: IQX
description: IQX Bidder Adapter
biddercode: iqx
media_types: banner, video, native
coppa_supported: true
tcfeu_supported: false
usp_supported: true
prebid_member: false
pbjs: false
pbs: true
schain_supported: true
floors_supported: true
multiformat_supported: will-bid-on-any
sidebarType: 1
safeframes_ok: true
---

### Prebid Server Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|-------------------------------|------------------------------------|-----------|
| `env` | required | Environment name | `iqx-stage` | `string` |
| `pid` | required | unique placement ID | `aa8217e20131c095fe9dba67981040b0` | `string` |
3 changes: 0 additions & 3 deletions dev-docs/bidders/kobler.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ Kobler identifies the placement using the combination of the page URL and the al

In order to see a sample bid from Kobler (without a proper setup), you have to also do the following:

- Change the [`refererInfo` function](https://github.com/prebid/Prebid.js/blob/master/src/refererDetection.js) to return `'https://www.tv2.no/a/11734615'` as a `page`. This is necessary because Kobler only bids on recognized articles.
- Change the adapter's [`BIDDER_ENDPOINT`](https://github.com/prebid/Prebid.js/blob/master/modules/koblerBidAdapter.js#L8) to `'https://bid-service.dev.essrtb.com/bid/prebid_rtb_call'`. This endpoint belongs to the development server that is set up to always return a bid for the correct `placementId` and page URL combination.

- Set the `test` parameter to `true`.
- Set `config.pageUrl` to `'https://www.tv2.no/mening-og-analyse/14555348/'`. This is necessary because Kobler only bids on recognized articles. Kobler runs its own test campaign to make sure there is always a bid for this specific page URL.

Expand Down
62 changes: 53 additions & 9 deletions dev-docs/bidders/lemmadigital.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@ description: Prebid Lemmadigital Bidder Adapter
biddercode: lemmadigital
media_types: video,banner
pbjs: true
pbs: true
schain_supported: true
floors_supported: true
pbs_app_supported: true
multiformat_supported: will-bid-on-one
safeframes_ok: true
ortb_blocking_supported: partial
userIds: all
sidebarType: 1
---
Expand All @@ -16,15 +21,17 @@ sidebarType: 1
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------|----------|---------------------------------|----------|-----------|
| `pubId` | required | Lemmadigital publisher Id provided by your Lemma representative | `1` | `integer` |
| `adunitId` | required | Lemmadigital ad unit Id provided by your Lemma representative | `3768` | `string` |
| `device_type` | optional | Device Type | `'2'` | `integer` |
| `latitude` | optional | Latitude | `'40.712775'` | `string` |
| `longitude` | optional | Longitude | `'-74.005973'` | `string` |
| `currency` | optional | Currency | `'USD'` | `string` |
| `bidFloor` | optional | Bid Floor | `1.00` | `integer` |
| `category` | optional | Allowed categories | `[ 'IAB1-5', 'IAB1-6' ]` | `array of strings` |
| `page_category` | optional | Allowed page categories | `[ 'IAB1-5', 'IAB1-6' ]` | `array of strings` |
| `pid` | required (for prebid-server) | Lemmadigital publisher Id provided by your Lemma representative | `1` | `integer` |
| `aid` | required (for prebid-server) | Lemmadigital ad unit Id provided by your Lemma representative | `3768` | `integer` |
| `pubId` | required (for prebid.js) | Lemmadigital publisher Id provided by your Lemma representative | `1` | `integer` |
| `adunitId` | required (for prebid.js) | Lemmadigital ad unit Id provided by your Lemma representative | `3768` | `string` |
| `device_type` | optional (for prebid.js) | Device Type | `'2'` | `integer` |
| `latitude` | optional (for prebid.js) | Latitude | `'40.712775'` | `string` |
| `longitude` | optional (for prebid.js) | Longitude | `'-74.005973'` | `string` |
| `currency` | optional (for prebid.js) | Currency | `'USD'` | `string` |
| `bidFloor` | optional (for prebid.js) | Bid Floor | `1.00` | `integer` |
| `category` | optional (for prebid.js) | Allowed categories | `[ 'IAB1-5', 'IAB1-6' ]` | `array of strings` |
| `page_category` | optional (for prebid.js) | Allowed page categories | `[ 'IAB1-5', 'IAB1-6' ]` | `array of strings` |

### Description

Expand Down Expand Up @@ -104,3 +111,40 @@ var bannerAdUnits = [
### Additional Configuration

Lemmadigital recommends setting UserSync by iframe for monetization.

### Prebid Server Test Request

The following test request can be used to verify that Prebid Server is working properly with the lemmadigital adapter. This example includes an `imp` object with a Lemma test publisher id, and ad id.

```json
{
"id": "test-request-id",
"imp": [{
"id": "test-imp-id",
"banner": {
"format": [{
"w": 1920,
"h": 1080
}],
"w": 1920,
"h": 1080
},
"ext": {
"lemmadigital": {
"aid": 3768,
"pid": 1
}
},
"bidfloor": 0.1
}],
"device": {
"ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36"
},
"site": {
"id": "siteID",
"publisher": {
"id": "1"
}
}
}
```
58 changes: 58 additions & 0 deletions dev-docs/bidders/sparteo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: bidder
title: Sparteo
description: Prebid Sparteo Bidder Adaptor
pbjs: true
pbs: false
biddercode: sparteo
media_types: banner, video
tcfeu_supported: true
gvl_id: 1028
usp_supported: true
prebid_member: false
schain_supported: false
safeframes_ok: true
deals_supported: false
floors_supported: false
fpd_supported: false
ortb_blocking_supported: false
multiformat_supported: will-bid-on-any
sidebarType: 1
---

### Note

Sparteo Header Bidding adapter requires setup and approval. Please reach out to <prebid@sparteo.com> for more details.

### Bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|---------------------------------------------------------------------------------------------|------------|-----------|
| `pid` | required | Your publisher ID. This information will be given to you by the Sparteo team. | `1234` | `integer` |

### Banner Object

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|--------|----------|--------------------------------------------------------|--------------|-----------|
| `size` | required | The size (width, height) of the banner, in pixels. | `[640, 480]` | `String` |
| `pos` | required | The position of the banner following the OpenRTB spec. | `0` | `integer` |

### Video Object

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|--------------------------------------------------------------------------|----------------|------------------|
| `context` | required | The video context, either 'instream', 'outstream'. | `'instream'` | `String` |
| `playerSize` | required | The size (width, height) of the video player on the page, in pixels. | `[640, 480]` | `Array<integer>` |
| `playbackmethod` | required | Defines how the video inventory is initiated following the OpenRTB spec. | `[4, 5]` | `Array<integer>` |
| `protocols` | required | Defines the video protocols allowed. | `[1, 2]` | `Array<integer>` |
| `api` | required | Defines the video api allowed. | `[1, 2]` | `Array<integer>` |
| `mimes` | required | Defines the video mimes allowed. | `['video/mp4']` | `Array<String>` |
| `skip` | required | Defines if skip is allowed. | `1` | `integer` |
| `startdelay` | required | Defines the startDelay. | `0` | `integer` |
| `placement` | required | Defines the placement. | `1` | `integer` |
| `linearity` | required | Defines the linearity. | `1` | `integer` |
| `minduration` | required | Defines the video minduration. | `1` | `integer` |
| `maxduration` | required | Defines the video maxduration. | `160` | `integer` |
38 changes: 27 additions & 11 deletions dev-docs/modules/oxxionRtdProvide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,60 @@ sidebarType : 1

## Overview

Module Name: Oxxion Rtd Provider
Module Type: Rtd Provider
Maintainer: <tech@oxxion.io>

## Oxxion Real-Time-Data submodule

Oxxion helps you to understand how your prebid stack performs.
This Rtd module is to use in order to improve video events tracking.
This Rtd module purpose is to filter bidders requested.

## Integration

Make sure to have the following modules listed while building prebid : `rtdModule,oxxionRtdProvider`
`rtbModule` is required to activate real-time-data submodules.
`rtdModule` is required to activate real-time-data submodules.
For example :

```bash
gulp build --modules=rtdModule,oxxionRtdProvider
gulp build --modules=schain,priceFloors,currency,consentManagement,appnexusBidAdapter,rubiconBidAdapter,rtdModule,oxxionRtdProvider
```

Then add the oxxion Rtd module to your prebid configuration :

```javascript
pbjs.setConfig({
//...
pbjs.setConfig(
...
realTimeData: {
auctionDelay: 200,
auctionDelay: 300,
dataProviders: [
{
name: "oxxionRtd",
waitForIt: true,
params: {
domain: "test.endpoint",
contexts: ["instream", "outstream"],
threshold: false,
samplingRate: 10,
}
}
]
}
// ...
});
...
)
```

## setConfig Parameters
## setConfig Parameters General

{: .table .table-bordered .table-striped }
| Name | Type | Description |
|:---------------------------------|:---------|:------------------------------------------------------------------------------------------------------------|
| domain | String | This string identifies yourself in Oxxion's systems and is provided to you by your Oxxion representative. |
| contexts | Array | Array defining which video contexts to add tracking events into. Values can be instream and/or outstream. |

## setConfig Parameters for bidder filtering

{: .table .table-bordered .table-striped }
| Name | Type | Description |
|:---------------------------------|:-----------|:------------------------------------------------------------------------------------------------------------|
| threshold | Float/Bool | False or minimum expected bid rate to call a bidder (ex: 1.0 for 1% bid rate). |
| samplingRate | Integer | Percentage of request not meeting the criterias to run anyway in order to check for any change. |
| bidders | Array | Optional: If set, filtering will only be applied to bidders listed.
39 changes: 21 additions & 18 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions prebid-mobile/pbm-api/android/pbm-plugin-renderer.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ In case of Interstitial ad this is just inflated in the foreground regardless th
### Setup

* Provide your Prebid Bidder Adapter
* [Go integration](prebid-server/developers/add-new-bidder-go.html)
* [Java integration](prebid-server/developers/add-new-bidder-java.html)
* [Go integration](/prebid-server/developers/add-new-bidder-go.html)
* [Java integration](/prebid-server/developers/add-new-bidder-java.html)
* Create your implementation from the interface `PrebidMobilePluginRenderer`
* Initialise your Plugin Renderer before starting to request ads
* Take advantage of the Plugin Renderer fields
Expand Down

0 comments on commit 3de6ddc

Please sign in to comment.