Skip to content
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
11 changes: 9 additions & 2 deletions dev-docs/bidder-adaptor.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ Prebid.js core now includes support for gzip compression of bidder request paylo
Prebid will pass compressed payloads if the following criteria are met:

* Participating bidders must implement compression support on their server-side endpoint before making a change in their bid adapter in Prebid.js
* Once server-side support is present, `request.options.endpointCompression = true` needs to be set for a bidder's outgoing requests within their Prebid.js bid adapter (An example of this can be viewed [here](https://github.com/prebid/Prebid.js/blob/master/modules/pubmaticBidAdapter.js#L730))
* Once server-side support is present, `request.options.endpointCompression = true` needs to be set for a bidder's outgoing requests within their Prebid.js bid adapter (see the [PubMatic adapter example](https://github.com/prebid/Prebid.js/blob/master/modules/pubmaticBidAdapter.js#L730))
* The browser must support gzip compression (Prebid core has a built-in utility function to check this)

If the above criteria is met, Prebid.js core will do the following:
Expand Down Expand Up @@ -389,6 +389,7 @@ When disabled, `auctionId`/`transactionId` are set to `null`; `ortb2.source.tid`
There are a number of important values that a publisher expects to be handled in a standard way across all Prebid.js adapters:

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

| Parameter | Description | Example |
| ----- | ------------ | ---------- |
| Ad Server Currency | If your endpoint supports responding in different currencies, read this value. | config.getConfig('currency.adServerCurrency') |
Expand Down Expand Up @@ -423,6 +424,7 @@ You shouldn't call your bid endpoint directly. Rather, the end result of your bu
ServerRequest objects. These objects have this structure:

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

| Attribute | Type | Description | Example Value |
|-----------+------------------+--------------------------------------------------------------------+-----------------------------|
| `method` | String | Which HTTP method should be used. | `POST` |
Expand Down Expand Up @@ -504,6 +506,7 @@ particularly useful. Publishers may have analytics or security vendors with the
The parameters of the `bidResponse` object are:

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

| Key | Scope | Description | Example |
|--------------+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------|
| `requestId` | Required | The bid ID that was sent to `spec.buildRequests` as `bidRequests[].bidId`. Used to tie this bid back to the request. | 12345 |
Expand Down Expand Up @@ -760,6 +763,7 @@ spec.aliases can be an array of strings or objects.
If the alias entry is an object, the following attributes are supported:

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

| Name | Scope | Description | Type |
|-------|-------|---------------|-----------|
| `code` | required | shortcode/partner name | `string` |
Expand Down Expand Up @@ -962,7 +966,7 @@ Adapter must add following new properties to bid response
}
```

Appnexus Adapter uses above explained approach. You can refer [here](https://github.com/prebid/Prebid.js/blob/master/modules/appnexusBidAdapter.js)
Appnexus Adapter uses the approach explained above. You can see an example in the [AppNexus adapter](https://github.com/prebid/Prebid.js/blob/master/modules/appnexusBidAdapter.js)

Adapter must return one [IAB accepted subcategories](https://iabtechlab.com/wp-content/uploads/2017/11/IAB_Tech_Lab_Content_Taxonomy_V2_Final_2017-11.xlsx) (links to MS Excel file) if they want to support competitive separation. These IAB sub categories will be converted to Ad server industry/group. If adapter is returning their own proprietary categroy, it is the responsibility of the adapter to convert their categories into [IAB accepted subcategories](https://iabtechlab.com/wp-content/uploads/2017/11/IAB_Tech_Lab_Content_Taxonomy_V2_Final_2017-11.xlsx) (links to MS Excel file).

Expand All @@ -971,6 +975,7 @@ If the demand partner is going to use Prebid API for this process, their adapter
**Params**

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

| Key | Scope | Description | Example |
|-----------------|----------|----------------------------------------------------------------------------------------------------|----------------------------|
| `url` | Required | The URL to the mapping file. | `"//example.com/mapping.json"` |
Expand Down Expand Up @@ -1000,6 +1005,7 @@ getIabSubCategory(bidderCode, pCategory)
**Params**

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

| Key | Scope | Description | Example |
|--------------|----------|-----------------------------------------------|-----------------------|
| `bidderCode` | Required | BIDDER_CODE defined in spec. | `"sample-biddercode"` |
Expand Down Expand Up @@ -1370,6 +1376,7 @@ The Example Bidding adapter requires setup before beginning. Please contact us a
### Bid Params

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

| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------|-----------|-----------|
| `placement` | required | Placement id | `'11111'` | `string` |
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/modules/tcfControl.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The following fields related to anonymizing aspects of the auction are supported
Notes:

* <a id="strictStorageEnforcement"></a> By default, Prebid allows some limited use of storage even when purpose 1 consent was not given: this is limited to non-PII, such as [category translation mappings](/dev-docs/modules/categoryTranslation.html), or temporary test data used to probe the browser's storage features. If `strictStorageEnforcement` is true, Purpose 1 consent will always be enforced for any access to storage.
* To accomodate Prebid.js modules and adapters that don't have GVL IDs, the vendorExceptions list is based on Prebid.js biddercodes instead of Global Vendor List (GVL) IDs (i.e. "bidderA" instead of "12345").
* To accommodate Prebid.js modules and adapters that don't have GVL IDs, the vendorExceptions list is based on Prebid.js biddercodes instead of Global Vendor List (GVL) IDs (i.e. "bidderA" instead of "12345").
* An alternate way of establishing a GVL mapping is to define a 'gvlMapping' object:

```javascript
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/plugins/bc/bc-prebid-plugin-render-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ String that can be one of the following:
* `'start'` (for preroll)
* `'end'` (for postroll)
* `'hh:mm:ss'` (to specify a midroll at a specific time)
* `'hh:mm:ss.mmm'` (to specify a midroll at a specfic time, including millseconds)
* `'hh:mm:ss.mmm'` (to specify a midroll at a specific time, including milliseconds)
* `'n%'` (to specify a midroll to play after the specified percentage of the content video has played)

**Required?**
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/publisher-api-reference/offEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Turns off an event callback defined with [onEvent](/dev-docs/publisher-api-refer
See the [getEvents](/dev-docs/publisher-api-reference/getEvents.html) function for the full list of eventTypes supported.

Causes PBJS to search through registered event callbacks and remove the
supplied callbackFunction for the specifc eventType.
supplied callbackFunction for the specific eventType.

The optional `id` parameter provides more finely-grained event
callback de-registration. This makes it possible to de-register callback
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/show-prebid-ads-on-amp-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ If you're using a custom RTC callout rather than one of the pre-defined [vendor

To review that Prebid on AMP is working properly the following aspects can be looked at:

- Include `#development=1` to the URL to review AMP specifc debug messages in the browser console.
- Include `#development=1` to the URL to review AMP specific debug messages in the browser console.
- Look for the Prebid server call in the network panel. You can open this URL in a new tab to view additional debugging information relating to the Prebid Server Stored Bid Request. If working properly, Prebid server will display the targeting JSON for AMP to use.
- Look for the network call from the Ad Server to ensure that key values are being passed. (For Google Ad Manager these are in the `scp` query string parameter in the network request)
- Most of the debugging information is omitted from the Prebid Server response unless the `debug=1` parameter is present in the Prebid Server query string. AMP won't add this parameter, so you'll need to grab the Prebid Server URL and manually add it to see the additional information provided.
Expand Down
2 changes: 1 addition & 1 deletion overview/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ A URL provided by a bidder requesting to be notified when their bid did not win

### Notice URL (nurl)

A URL provided by a bidder as an alternate source of the creative. See the [nurl FAQ entry](/faq/prebid-server-faq.html#how-does-the-notice-url-work-for-prebid-server) for Prebid-specfic details.
A URL provided by a bidder as an alternate source of the creative. See the [nurl FAQ entry](/faq/prebid-server-faq.html#how-does-the-notice-url-work-for-prebid-server) for Prebid-specific details.

## Prebid Mobile

Expand Down
2 changes: 1 addition & 1 deletion prebid-mobile/prebid-mobile.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Follow these steps to integrate the rendering API:
Currently Prebid Mobile SDK doesn't offer direct analytics capabilities. While we build out analytics in Prebid Server to support the SDK, some options are:

- Generate analytics from the ad server, as key metrics are available there if the line items are broken out by bidder.
- Integrate an analytics package directly into the app. You may have one already that can accomodate header bidding metrics.
- Integrate an analytics package directly into the app. You may have one already that can accommodate header bidding metrics.
- Utilize a server-side [analytics module for Prebid Server](/prebid-server/developers/pbs-build-an-analytics-adapter.html).

## Further Reading
Expand Down
7 changes: 4 additions & 3 deletions prebid-server/pbs-modules/51degrees-device-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebarType : 5
---

{: .alert.alert-warning :}
51Degrees module operates using a data file. You can get started with a free Lite data file that can be downloaded [here](https://github.com/51Degrees/device-detection-data/blob/main/51Degrees-LiteV4.1.hash). The Lite file is updated monthly and detects limited device information. To access the daily updated full data file with comprehensive device information please [contact 51Degrees](https://51degrees.com/contact-us).
51Degrees module operates using a data file. You can get started with a free Lite data file that can be downloaded from the [51Degrees data repository](https://github.com/51Degrees/device-detection-data/blob/main/51Degrees-LiteV4.1.hash). The Lite file is updated monthly and detects limited device information. To access the daily updated full data file with comprehensive device information please [contact 51Degrees](https://51degrees.com/contact-us).

# 51Degrees Device Detection Module
{:.no_toc}
Expand Down Expand Up @@ -43,7 +43,7 @@ pbjs.setConfig({

### Data File Updates

The module operates **fully autonomously and does not make any requests to any cloud services in real time to do device detection**. This is an [on-premise data](https://51degrees.com/developers/deployment-options/on-premise-data) deployment in 51Degrees terminology. The module operates using a local data file that is loaded into memory fully or partially during operation. The data file is occasionally updated to accomodate new devices, so it is recommended to enable automatic data updates in the module configuration. Alternatively `watch_file_system` option can be used and the file may be downloaded and replaced on disk manually. See the configuration options below.
The module operates **fully autonomously and does not make any requests to any cloud services in real time to do device detection**. This is an [on-premise data](https://51degrees.com/developers/deployment-options/on-premise-data) deployment in 51Degrees terminology. The module operates using a local data file that is loaded into memory fully or partially during operation. The data file is occasionally updated to accommodate new devices, so it is recommended to enable automatic data updates in the module configuration. Alternatively `watch_file_system` option can be used and the file may be downloaded and replaced on disk manually. See the configuration options below.

## Setup

Expand Down Expand Up @@ -251,10 +251,11 @@ The parameter names are specified with full path using dot-notation. F.e. `sect
```

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

| PBS-Java Name | PBS-Go Name | Required| Type | Default value | Description |
|:-------|:-------|:------|:------|:------|:---------------------------------------|
| `account-filter` .`allow-list` | `account_filter` .`allow_list` | No | list of strings | [] (empty list) | A list of account IDs that are allowed to use this module - only relevant if enabled globally for the host. If empty, all accounts are allowed. Full-string match is performed (whitespaces and capitalization matter). |
| `data-file` .`path` | `data_file` .`path` | **Yes** | string | null |The full path to the device detection data file. Sample file can be downloaded from [data repo on GitHub](https://github.com/51Degrees/device-detection-data/blob/main/51Degrees-LiteV4.1.hash), or get an Enterprise data file [here](https://51degrees.com/pricing). |
| `data-file` .`path` | `data_file` .`path` | **Yes** | string | null |The full path to the device detection data file. Sample file can be downloaded from the [51Degrees data repository](https://github.com/51Degrees/device-detection-data/blob/main/51Degrees-LiteV4.1.hash), or get an Enterprise data file from the [51Degrees pricing page](https://51degrees.com/pricing). |
| `data-file` .`make-temp-copy` | `data_file` .`make_temp_copy` | No | boolean | true | If true, the engine will create a temporary copy of the data file rather than using the data file directly. |
| `data-file` .`update` .`auto` | `data_file` .`update` .`auto` | No | boolean | true | If enabled, the engine will periodically (at predefined time intervals - see `polling-interval` parameter) check if new data file is available. When the new data file is available engine downloads it and switches to it for device detection. If custom `url` is not specified `license_key` param is required. |
| `data-file` .`update` .`on-startup` | `data_file` .`update` .`on_startup` | No | boolean | true | If enabled, engine will check for the updated data file right away without waiting for the defined time interval. |
Expand Down
2 changes: 1 addition & 1 deletion prebid-server/pbs-modules/ortb2-blocking.md
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ This attribute is related to the 'btype' of the request.

See Table 5.2 in the [OpenRTB 2.5 spec](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) for the possible values.

**Note:** no enforcement is possible because the creative type is not explictly
**Note:** no enforcement is possible because the creative type is not explicitly
part of the response and Prebid Server does not currently contain logic to
parse creatives to derive the type.

Expand Down