Skip to content
Open
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
37 changes: 29 additions & 8 deletions dev-docs/bidders/showheroes-bs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,28 @@ fpd_supported: true
multiformat_supported: will-bid-on-one
sidebarType: 1
pbs: true
endpoint_compression: true
---



### bid params
## bid params

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
|-------------|----------------------------------|-------------------------------------|------------------------------------------|-----------|
| `unitId` | required | ShowHeroes MAX unit ID | `'1234abcd-5678efgh'` | `string` |
| `unitId` | required | ShowHeroes MAX unit ID | `'1234abcd-5678efgh'` | `string` |

All other parameters should be sent inside openRTB request.

### openRTB2 support
## openRTB2 support

{: .alert.alert-danger :}
Starting with Prebid.js version 9.18 ShowHeores bidder adapter is requesting bids via openRTB protocol.
Publishers can use the `ortb2` method of setting [First Party Data](https://docs.prebid.org/features/firstPartyData.html). Bidder supports all first-party data fields: site, user, segments, and imp-level first-party data.

### testing
## testing

While developing or testing locally, you can request a test request by marking the openRTB as a test.
To do that specifically for `showheroes-Bs` you can do:
Expand All @@ -56,7 +58,7 @@ Or, more easily you can mark the whole request as a test request by doing:
pbjs.setConfig({ortb2: {test: 1}})
```

#### Prebid Server Test Request
### Prebid Server Test Request

To verify that the Prebid Server is working properly with the server-side `Showheroes` adapter a `test` property can be utilized.

Expand All @@ -77,7 +79,7 @@ To verify that the Prebid Server is working properly with the server-side `Showh
}
```

#### Outstream
### Outstream

Example of adunit configuration for the outstream unit:

Expand Down Expand Up @@ -121,7 +123,7 @@ pbjs.que.push(function () {

You could use this example and place it in .html example pages inside the Prebid.js repository.

#### instream
### instream

Example of adunit configuration for the instream unit:

Expand Down Expand Up @@ -164,7 +166,7 @@ pbjs.que.push(function(){

You could use this example and place it in the `test/pages/instream.html` example page inside the Prebid.js repository.

#### banner
### banner

Example of adunit configuration for banner ads:

Expand Down Expand Up @@ -195,3 +197,22 @@ pbjs.que.push(function () {
```

You can use this example and place in the `hello_world` gpt integration test page

## Endpoint Compression

This adapter utilizes gzip compression support built into Prebid.js core. For more information, see [Compression Support for Outgoing Requests](https://docs.prebid.org/dev-docs/bidder-adaptor.html#compression-support-for-outgoing-requests)

### Disabling Compression

You can disable gzip compression at the bidder level using `pbjs.setBidderConfig`. Set the `gzipEnabled` value to false:

```javascript
pbjs.que.push(function () {
pbjs.setBidderConfig({
bidders: ['showheroes'],
config: {
gzipEnabled: false
}
});
});
```
Loading