Skip to content

Commit

Permalink
Merge branch 'prebid:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrj-rtbh authored May 12, 2023
2 parents 3d8f7d6 + 75c9e1c commit ac4e2fd
Show file tree
Hide file tree
Showing 7 changed files with 470 additions and 120 deletions.
14 changes: 7 additions & 7 deletions dev-docs/bidders/axonix.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ sidebarType: 1
The Axonix Bidding adapter requires setup before beginning. Please contact us at support.axonix@emodoinc.com.

### Bid Params

| Name | Scope | Description | Example |
| :------------ | :------- | :---------------------------------------------- | :------------------------------------- |
| `supplyId` | required | Supply UUID | `'2c426f78-bb18-4a16-abf4-62c6cd0ee8de'` |
| `region` | optional | Cloud region | `'us-east-1'` |
| `endpoint` | optional | Supply custom endpoint | `'https://open-rtb.axonix.com/custom'` |
| `instl` | optional | Set to 1 if using interstitial (default: 0) | `1` |
{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|-------|----------------------------------------------|-------------------------------------|------|
| `supplyId` | required | Supply UUID | `'2c426f78-bb18-4a16-abf4-62c6cd0ee8de'` | string |
| `region` | optional | Cloud region | `'us-east-1'` | string |
| `endpoint` | optional | Supply custom endpoint | `'https://open-rtb.axonix.com/custom'` | string |
| `instl` | optional | Set to 1 if using interstitial (default: 0) | `1` | integer |
3 changes: 3 additions & 0 deletions dev-docs/bidders/emx_digital.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ userIds: identityLink, uid2
sidebarType: 1
---

{: .alert.alert-warning :}
The emx_digital bidder is deprecated, and will be removed in a future release of Prebid.js and Prebid Server.

### Registration

To use this bidder you will need an account and a valid tagid from our exchange. For further information, please contact your Account Manager or adops@emxdigital.com.
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/freewheelssp.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: bidder
title: freeWheelssp
title: FreeWheelssp
description: Freewheel Bidder Adaptor
pbjs: true
pbs: true
Expand All @@ -9,6 +9,7 @@ aliasCode: freewheel-ssp
gvl_id: 285
gdpr_supported: true
usp_supported: true
gpp_supported: true
coppa_supported: true
schain_supported: true
media_types: video
Expand Down
6 changes: 3 additions & 3 deletions dev-docs/bidders/ix.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ In this configuration Prebid.js calls Index directly from the browser using our
}
});
```
5. (Optional) Set up First Party Data (FPD) using the Index bidder-specific FPD (preferred method) setting or the Prebid FPD module. For more information, see the [Set up First Party Data (FPD)](#set-up-first-party-data-fpd) section below.
5. (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the [Set up First Party Data (FPD)](#set-up-first-party-data-fpd) section below.
6. (Optional) If you want to monetize instream video, you need to enable a cache endpoint in the [pbjs.setConfig()](https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html) function as follows: <br />
```javascript
pbjs.setConfig({
Expand Down Expand Up @@ -160,7 +160,7 @@ In this configuration, Prebid.js makes a call to Prebid Server and then Prebid S
}
});
```
6. (Optional) Set up First Party Data (FPD) using the Index bidder-specific FPD (preferred method) setting or the Prebid FPD module. For more information, see the [Set up First Party Data (FPD)](#set-up-first-party-data-fpd) section below.
6. (Optional) Set up First Party Data (FPD). For more information about the data types we support and the instructions for each option, see the [Set up First Party Data (FPD)](#set-up-first-party-data-fpd) section below.
7. (Optional) If you want to monetize instream video, you need to enable a cache endpoint in the `[pbjs.setConfig()]` function as follows:
```javascript
pbjs.setConfig({
Expand Down Expand Up @@ -226,7 +226,7 @@ pbjs.setConfig({

### Index bidder-specific data

Use this data type to specify key-value pairs that will be included in your query string when targeting deals. For example, if a user visits a news page, you can pass that information by submitting a key-value pair for `category = news`. You can then create a deal in the Index UI and activate the deal only on pages that contain `category = news` as the key-value pair.
This data type is available from Prebid version 7.49.0 and above. You can use it to specify key-value pairs that will be included in your query string when targeting deals. For example, if a user visits a news page, you can pass that information by submitting a key-value pair for `category = news`. You can then create a deal in the Index UI and activate the deal only on pages that contain `category = news` as the key-value pair.

To include the FPD in a bid request, in the `[pbjs.setConfig()]` object at the `ix` bidder level, provide the key-values in the `firstPartyData` parameter. Make sure that you set it before the `pbjs.requestBids` configuration. If you want to change the values, you can update the `pbjs.setConfig` once again. The change will be reflected in all future bid requests.

Expand Down
133 changes: 133 additions & 0 deletions dev-docs/bidders/relevantdigital.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
layout: bidder
title: Relevant Digital
description: Relevant Digital Bid Adapter
biddercode: relevantdigital
pbjs: true
gdpr_supported: true
usp_supported: true
coppa_supported: false
schain_supported: true
floors_supported: true
media_types: banner, video, native
userIds: all
prebid_member: true
safeframes_ok: true
deals_supported: true
pbs: false
pbs_app_supported: false
fpd_supported: true
ortb_blocking_supported: no
gvl_id: 1100
multiformat_supported: true
sidebarType: 1
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------------------------------------------|----------------------------|--------------|
| `placementId` | required | The placement id. | `'6204e83a077_620f9e8e4fe'` | `String` |
| `pbsHost` | required if not set in config | Host name of the server. | `'pbs-example.relevant-digital.com'` | `String` |
| `accountId` | required if not set in config | The account id. | `'6204e5fa70e3ad108'` | `String` |
| `useSourceBidderCode` | optional | Set to `true` in order to use the bidder code of the actual server-side bidder in bid responses. You **MUST** also use `allowAlternateBidderCodes: true` in `bidderSettings` if you enabled this - as otherwise the bids will be rejected.| `true` | `Boolean` |

### Config Parameters

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------------------------------------------|----------------------------|--------------|
| `pbsHost` | required if not set in bid parameters | Host name of the server. | `'pbs-example.relevant-digital.com'` | `String` |
| `accountId` | required if not set in bid parameters | The account id. | `'6204e5fa70e3ad108'` | `String` |
| `pbsBufferMs` | optional | How much less in *milliseconds* the server's internal timeout should be compared to the normal Prebid timeout. Default is *250*. To be increased in cases of frequent timeouts. | `250` | `Integer` |
| `useSourceBidderCode` | optional | Set to `true` in order to use the bidder code of the actual server-side bidder in bid responses. You **MUST** also use `allowAlternateBidderCodes: true` in `bidderSettings` if you enabled this - as otherwise the bids will be rejected.| `true` | `Boolean` |

### Example setup using pbjs.setConfig()
This is the recommended method to set the global configuration parameters.
```javascript
pbjs.setConfig({
relevantdigital: {
pbsHost: 'pbs-example.relevant-digital.com',
accountId: '6204e5fa70e3ad10821b84ff',
},
});

var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'relevantdigital',
params: {
placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
}
}
],
}
];
```
# Example setup using only bid params
This method to set the global configuration parameters (like **pbsHost**) in **params** could simplify integration of a provider for some publishers. Setting different global config-parameters on different bids is not supported in general*, as the first settings found will be used and any subsequent global settings will be ignored.

 * _The exception is `useSourceBidderCode` which can be overriden individually per ad unit._
```javascript
var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'relevantdigital',
params: {
placementId: '6204e83a077c5825441b8508_620f9e8e4fe67c1f87cd30ed',
pbsHost: 'pbs-example.relevant-digital.com',
accountId: '6204e5fa70e3ad10821b84ff',
}
}
],
}
];
```

### Example setup with multiple providers
**Notice:** Placements below are _not_ live test placements
```javascript

pbjs.aliasBidder('relevantdigital', 'providerA');
pbjs.aliasBidder('relevantdigital', 'providerB');

pbjs.setConfig({
providerA: {
pbsHost: 'pbs-example-a.relevant-digital.com',
accountId: '620533ae7f5bbe1691bbb815',
},
providerB: {
pbsHost: 'pbs-example-b.relevant-digital.com',
accountId: '990533ae7f5bbe1691bbb815',
},
});

var adUnits = [
{
code: 'test-div',
mediaTypes: { banner: { sizes: [[300, 250], [320, 320]] }},
bids: [
{
bidder: 'providerA',
params: {
placementId: '610525862d7517bfd4bbb81e_620523b7d1dbed6b0fbbb817',
}
},
{
bidder: 'providerB',
params: {
placementId: '990525862d7517bfd4bbb81e_770523b7d1dbed6b0fbbb817',
}
},
],
}
];
```

Loading

0 comments on commit ac4e2fd

Please sign in to comment.