Skip to content
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

merging text from Prebid Server notes #2248

Merged
merged 1 commit into from
Aug 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions dev-docs/bidders/adtarget.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ pbjs: true
pbs: true
---

### Registration

To use the Adtarget bidder you will need an aid from an exchange account on [https://console.adtarget.com.tr](adtarget.com.tr). For further information, please contact kamil@adtarget.com.tr.

### Bid params

{: .table .table-bordered .table-striped }
Expand Down
7 changes: 7 additions & 0 deletions dev-docs/bidders/audienceNetwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ biddercode: audienceNetwork
media_types: native, video
---

### Registration

Audience Network will not bid on requests made from device simulators.
When testing for Mobile bids, you must make bid requests using a real device.

**Note:** Audience Network is disabled by default. Please enable it in the app config if you wish to use it. Make sure you provide the partnerID for the auctions to run correctly.

### Bid Params

{: .table .table-bordered .table-striped }
Expand Down
5 changes: 5 additions & 0 deletions dev-docs/bidders/avocet.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,15 @@ usp_supported: true
tcf2_supported: true
---

### Registration

Please contact Avocet at info@avocet.io if you would like to get started selling inventory via the Avocet platform.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|-------------|----------|------------------------------|------------------------------|-----------|
| `placement` | required | A Placement ID from Avocet. | `"5ebd27607781b9af3ccc3332"` | `string` |

**Prebid Server Note:** Avocet is disabled by default. Please enable it in the app config if you wish to use it. This can be done by setting `adapters.avocet.disabled` to `false` and by setting `adapters.avocet.endpoint` to a valid Avocet endpoint url.
15 changes: 15 additions & 0 deletions dev-docs/bidders/beachfront.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ pbjs: true
pbs: true
---

### Registration

To use the beachfront bidder you will need an appId (Exchange Id) from an exchange
account on [platform.beachfront.io](https://platform.beachfront.io).

For further information, please contact adops@beachfront.com.

### Bid Params

{: .table .table-bordered .table-striped }
Expand Down Expand Up @@ -59,3 +66,11 @@ pbs: true
| `adPosterColor` | optional | The color of the ad poster formatted as a CSS value. | `'#FFFFFF'` | `string` |
| `expandInView` | optional | Defines whether to expand the player when the ad slot is in view. Defaults to `false`. | `false` | `boolean` |
| `collapseOnComplete` | optional | Defines whether to collapse the player when ad playback has completed. Defaults to `true`. | `true` | `boolean` |

### Prebid Server

As seen in the JSON response from \{your PBS server\}\/bidder\/params [(example)](https://prebid.adnxs.com/pbs/v1/bidders/params), the beachfront bidder can take either an "appId" parameter, or an "appIds" parameter. If the request is for one media type, the appId parameter should be used with the value of the Exchange Id on the Beachfront platform.

The appIds parameter is for requesting a mix of banner and video. It has two parameters, "banner", and "video" for the appIds of two appropriately configured exchanges on the platform. The appIds parameter can be sent with just one of its two parameters and it will behave like the appId parameter.

If the request includes an appId configured for a video response, the videoResponseType parameter can be defined as "nurl", "adm" or "both". These will apply to all video returned. If it is not defined, the response type will be a nurl. The definitions for "nurl" vs. "adm" are here: (https://github.com/mxmCherry/openrtb/blob/master/openrtb2/bid.go).
3 changes: 3 additions & 0 deletions dev-docs/bidders/emx_digital.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ media_types: banner, video
gdpr_supported: true
---

### 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.

### Bid Params

Expand Down
10 changes: 10 additions & 0 deletions dev-docs/bidders/kidoz.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ gdpr_supported: true
coppa_supported: true
---

### Registration

Kidoz is exclusively for Mobile app COPPA compatible ads, 100% kid relevant and appropriate.

In order for a company to receive bids from Kidoz, they must first open a publisher account at Kidoz.net
(https://accounts.kidoz.net/publishers/register) and accept the Kidoz Terms and Conditions and Privacy Policy.
Kidoz publishers must confirm that all of their content properties are COPPA and GDPR compliant and perform no monitoring
or tracking of U13 users in their operations. New publishers are provided a Publisher ID and AccessToken, this can also
be used to login to their dashboard at the Kidoz.net portal to monitor their account activity.

### Bid Params

{: .table .table-bordered .table-striped }
Expand Down
4 changes: 4 additions & 0 deletions dev-docs/bidders/openx.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ prebid_member: true
tcf2_supported: true
---

### Registration

If you have any questions regarding set up, please reach out to your account manager or support@openx.com.

### Bid Parameters
#### Banner

Expand Down
32 changes: 32 additions & 0 deletions dev-docs/bidders/pubmatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,4 +199,36 @@ pbjs.setConfig({
}
});
```

### Prebid Server Test Request

The following test parameters can be used to verify that Prebid Server is working properly with the
PubMatic adapter. This example includes an `imp` object with an PubMatic test publisher ID, ad slot,
and sizes that would match with the test creative.

```
"imp":[
{
"id":“"some-impression-id”,
"banner":{
"format":[
{
"w":300,
"h":250
},
{
"w":300,
"h":600
}
]
},
"ext":{
"pubmatic":{
"publisherId":“156276”,
"adSlot":"pubmatic_test"
}
}
}
]
```
<!-- workaround bug where code blocks at end of a file are incorrectly formatted-->
56 changes: 55 additions & 1 deletion dev-docs/bidders/pubnative.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,64 @@ tcf2_supported: true
prebid_member: true
---

### Registration

Before adding PubNative as a new bidder, there are 3 prerequisites:
- As a Publisher, you need to have Prebid Mobile SDK integrated.
- You need a configured Prebid Server (either self-hosted or hosted by 3rd party).
- You need to be integrated with Ad Server SDK (e.g. Mopub) or internal product which communicates with Prebid Mobile SDK.

Please see [documentation](https://developers.pubnative.net/docs/prebid-adding-pubnative-as-a-bidder) for more info.

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|------------------------|---------|----------|
| zone_id | required | The ad zone identifier | 1111 | integer |
| zone_id | required | The ad zone identifier | 1 | integer |
| app_auth_token | required | The app's authentication token | 'aaaabbbbcccc' | string |

### Test Parameters

Please consult with our Account Manager for testing.
We need to confirm that your ad request is correctly received by our system.

The following test parameters can be used to verify that Prebid Server is working properly with the
Pubnative adapter.

The following json can be used to do a request to prebid server for verifying its integration with Pubnative adapter.

```json
{
"id": "some-impression-id",
"site": {
"page": "https://good.site/url"
},
"imp": [
{
"id": "test-imp-id",
"banner": {
"format": [
{
"w": 300,
"h": 250
}
]
},
"ext": {
"pubnative": {
"zone_id": 1,
"app_auth_token": "b620e282f3c74787beedda34336a4821"
}
}
}
],
"device": {
"os": "android",
"h": 700,
"w": 375
},
"tmax": 500,
"test": 1
}
```
5 changes: 3 additions & 2 deletions dev-docs/bidders/rubicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ pbjs: true
pbs: true
---

### Note:
The Rubicon Project adapter requires setup and approval from the Rubicon Project team, even for existing Rubicon Project publishers. Please reach out to your account team or globalsupport@rubiconproject.com for more information.
### Registration

For both Prebid.js and Prebid Server, the Rubicon Project adapter requires setup and approval from the Magnite team, even for existing accounts. Please reach out to your account team or globalsupport@magnite.com for more information.

### Bid Params

Expand Down
32 changes: 31 additions & 1 deletion dev-docs/bidders/smaato.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pbjs: true
pbs: true
---

### Note
### Registration

The Smaato adapter requires setup and approval from the Smaato team, even for existing Smaato publishers. Please reach out to your account team or prebid@smaato.com for more information.

Expand Down Expand Up @@ -90,3 +90,33 @@ pbjs.setConfig({
}
});
```

### Test Parameters

Following example includes sample `imp` object with publisherId and adSlot which can be used to test Smaato Adapter

```
"imp":[
{
"id":“1C86242D-9535-47D6-9576-7B1FE87F282C,
"banner":{
"format":[
{
"w":300,
"h":50
},
{
"w":300,
"h":250
}
]
},
"ext":{
"smaato":{
"publisherId":"100042525",
"adspaceId":"130563103"
}
}
}
]
```
56 changes: 54 additions & 2 deletions dev-docs/bidders/smartadserver.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ pbjs: true
pbs: true
---

### Note:
### Registration

The Smart AdServer bidder adaptor requires setup and approval from the Smart AdServer Service team. Please reach out to your account manager for more information and start using it.

### Bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------|----------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|-----------|
| `siteId` | required | The placement site ID | `1234` | `integer` |
| `networkId` | required for Prebid Server | The network identifier you have been provided with. | `1234` | `integer` |
| `siteId` | required for Prebid.js | The placement site ID | `1234` | `integer` |
| `pageId` | required | The placement page ID | `1234` | `integer` |
| `formatId` | required | The placement format ID | `1234` | `integer` |
| `domain` | optional | The network domain (default see example) | `'http://prg.smartadserver.com', 'https://prg.smartadserver.com'` | `string` |
Expand All @@ -33,6 +35,8 @@ The Smart AdServer bidder adaptor requires setup and approval from the Smart AdS
| `video` | optional | Parameter object for instream video. See [video Object](#smartadserver-video-object) | `{}` | `object` |
| `schain` | optional | Supply Chain | `'1.0,1!exchange1.com,1234,1,bid-request-1,publisher,publisher.com'` | `string` |

**Note:** The site, page and format identifiers have to all be provided or all empty.

<a name="smartadserver-video-object" />

#### Video Object
Expand All @@ -42,3 +46,51 @@ The Smart AdServer bidder adaptor requires setup and approval from the Smart AdS
|--------------|----------|-------------------------------------------------------------------------------------------------------------------------|------------------------|-----------|
| `protocol` | optional | Maximum open RTB video protocol supported | `8` (VAST 4.0 wrapper) | `integer` |
| `startDelay` | optional | Allowed values: 1 (generic pre-roll, default), 2 (generic mid-roll), 3 (generic post-roll) | `1` | `integer` |

### Examples

Without site/page/format :
```
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 600,
"h": 500
}, {
"w": 300,
"h": 600
}]
},
"ext": {
"smartadserver": {
"networkId": 73
}
}
}]
```

With site/page/format :

```
"imp": [{
"id": "some-impression-id",
"banner": {
"format": [{
"w": 600,
"h": 500
}, {
"w": 300,
"h": 600
}]
},
"ext": {
"smartadserver": {
"networkId": 73
"siteId": 1,
"pageId": 2,
"formatId": 3
}
}
}]
```
Loading