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.

Sign up for GitHub

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

Fix #5358 Normalize headings in bidder docs #5706

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Fix #5358 Normalize headings in bidder docs #5706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion dev-docs/bidders/admatic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ AdMatic header bidding adapter connects with AdMatic demand sources to fetch bid
### Bid params

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

| Name | Scope | Description | Example | Type |
|--------------|----------|------------------------------------|------------|----------|
| `networkId` | required | The network ID from AdMatic | `12345` | `number` |
Expand Down Expand Up @@ -76,7 +77,7 @@ var adUnits = [{
}];
```

## UserSync example
### UserSync example

```javascript
pbjs.setConfig({
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/admaticde.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ AdMatic GMBH header bidding adapter connects with AdMatic GMBH demand sources to
### Bid params

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

| Name | Scope | Description | Example | Type |
|-------------|----------|-------------------------------------|----------|----------|
| `networkId` | required | The network ID from AdMatic GMBH | `12345` | `number` |
Expand Down Expand Up @@ -77,7 +78,7 @@ var adUnits = [{
}];
```

## UserSync example
### UserSync example

```javascript
pbjs.setConfig({
Expand Down
14 changes: 10 additions & 4 deletions dev-docs/bidders/aidem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ ortb_blocking_supported: false
sidebarType: 1
---

## Description
### Description

This module connects publishers to AIDEM demand.

Expand All @@ -31,6 +31,7 @@ This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
### Global Bid Params

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

| Name | Scope | Description | Example | Type |
|---------------|----------|---------------------|------------|----------|
| `siteId` | required | Unique site ID | `'ABCDEF'` | `String` |
Expand All @@ -41,13 +42,15 @@ This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
#### Banner Bid Params

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

| Name | Scope | Description | Example | Type |
|------------|----------|--------------------------|---------------------------|---------|
| `sizes` | required | List of the sizes wanted | `[[300, 250], [300,600]]` | `Array` |

#### Video Bid Params

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

| Name | Scope | Description | Example | Type |
|---------------|----------|-----------------------------------------|-----------------|-----------|
| `context` | required | One of instream, outstream, adpod | `'instream'` | `String` |
Expand All @@ -60,6 +63,7 @@ This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
#### Additional Config

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

| Name | Scope | Description | Example | Type |
|---------------------|----------|---------------------------------------------------------|---------|-----------|
| `coppa` | optional | Child Online Privacy Protection Act | `true` | `Boolean` |
Expand All @@ -68,6 +72,7 @@ This module is GDPR and CCPA compliant, and no 3rd party userIds are allowed.
#### Consent Management Object

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

| Name | Scope | Description | Example | Type |
|--------|----------|--------------------------------------------------------------------------------------------------|---------|----------|
| `gdpr` | optional | GDPR Object see [Prebid.js doc](https://docs.prebid.org/dev-docs/modules/consentManagementTcf.html) | `{}` | `Object` |
Expand Down Expand Up @@ -182,12 +187,13 @@ pbjs.que.push(function (){
### Supported Media Types

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

| Type | Support |
|--------|--------------------------------------------------------------------|
| Banner | Support all [AIDEM Sizes](https://kb.aidem.com/ssp/lists/adsizes/) |
| Video | Support all [AIDEM Sizes](https://kb.aidem.com/ssp/lists/adsizes/) |

## Setup / Dev Guide
### Setup / Dev Guide

```shell
nvm use
Expand All @@ -210,9 +216,9 @@ gulp test --file "test/spec/modules/aidemBidAdapter_spec.js"

For video: gulp serve --modules=aidemBidAdapter,dfpAdServerVideo

## FAQs
### FAQs

### How do I view AIDEM bid request?
#### How do I view AIDEM bid request?

Navigate to a page where AIDEM is setup to bid. In the network tab,
search for requests to `zero.aidemsrv.com/bid/request`.
12 changes: 6 additions & 6 deletions dev-docs/bidders/ampliffy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ multiformat_supported: will-bid-on-one
safeframes_ok: true
---

## Table of contents
### Table of contents

* [Table of contents](#table-of-contents)
* [Introduction](#introduction)
Expand All @@ -23,13 +23,13 @@ safeframes_ok: true
* [Video](#video)
* [Examples](#examples)

## Introduction
### Introduction

Publishers can use Prebid.js to call Ampliffy through our client-side adapter: Prebid.js calls ampliffy directly from the browser using our client-side adapter. For configuration instructions, see the below on this page.

### Example

## Supported media types
### Supported media types

The following table lists the media types that Ampliffy supports.

Expand All @@ -41,7 +41,7 @@ The following table lists the media types that Ampliffy supports.
| video |
| native |

## Modules to include in your build process
### Modules to include in your build process

If you are building the JS binary on your own from source code, follow the instructions in [Prebid.js project README](https://github.com/prebid/Prebid.js/blob/master/README.md#build-optimization). You will need to include the `ampliffyBidAdapter`. To show video ads with Google Ad Manager, you need to include the `dfpAdServerVideo` module. We highly recommend adding the `gptPreAuction` module as well, which improves a DSP's ability to bid accurately on your supply. The following is an example build command that include these modules: <br />
`gulp build --modules=ampliffyBidAdapter,dfpAdServerVideo,gptPreAuction`
Expand All @@ -56,7 +56,7 @@ If you are using a JSON file to specify modules, add `ampliffyBidAdapter` and `d
]
```

## Bid request parameters
### Bid request parameters

### Banner

Expand All @@ -82,7 +82,7 @@ You must include these parameters at the bidder level.
| `format` | Required | String | specify 'video' for this kind of inventory` |
| `server` | Optional | String | An Ampliffy-specific identifier that is associated with this ad unit` |

## Examples
### Examples

**Video (instream):** <br />

Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/browsi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ For more information about [Browsi](https://www.browsi.com), please contact [sup
### Bid Params

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

| Name | Scope | Description | Example | Type |
|------------------|----------|------------------|------------------------------|----------|
| `pubId` | required | Publisher ID | `'117a476f-9791-4a82-80db-4c01c1683db0'` | `string` |
| `tagId` | required | Tag ID | `'1'` | `string` |

# Sample Ad Unit: For Publishers
### Sample Ad Unit: For Publishers

```javascript
let videoAdUnit = [
Expand Down
16 changes: 10 additions & 6 deletions dev-docs/bidders/consumable-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The Consumable bid adapter may cycle the ad initially shown with a new one at va
### Bid Params

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

| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------|---------|-----------|
| `siteId` | required | The site ID from Consumable. | `12345` | `integer` |
Expand All @@ -41,7 +42,7 @@ The Consumable bid adapter may cycle the ad initially shown with a new one at va
| `unitName` | required | The unit name from Consumable. | `cnsmbl-unit` | `string` |
| `placementId` | required | the placementid from Consumable. | `0421008445828ceb46f496700a5fa65e` | `string` |

## Table of contents
### Table of contents

* [Table of contents](#table-of-contents)
* [Introduction](#introduction)
Expand All @@ -55,26 +56,27 @@ The Consumable bid adapter may cycle the ad initially shown with a new one at va
* [App](#app-or-ctv-banner-video-audio)
* [Examples](#examples)

## Introduction
### Introduction

Publishers can use Prebid Server in any of the following ways with Consumable. Consumable's adapter supports all of the following methods:

* If you want to call Consumable from a web environment, you can use Prebid.js to call Prebid Server, and then Prebid Server uses our server-side adapter to call Consumable. This reduces workload on the browser. For set up instructions, see [Call Consumable from a web browser](#call-consumable-from-a-web-browser) section on this page.
* In mobile apps, you can use the Prebid Mobile SDK to call Prebid Server and then Prebid Server uses our server-side adapter to call Consumable. For set up instructions, see [Call Consumable from Prebid Mobile SDK](#call-consumable-from-prebid-mobile-sdk) section on this page.
* In CTV apps and other long-form video environments, you (or the SSAI vendor) can make a call to Prebid Server using OpenRTB, and then Prebid Server uses our server-side adapter to call Consumable. For set up instructions, see [Call Consumable from CTV/long-form video environment](#call-consumable-from-ctvlong-form-video-environment) section on this page.

## Supported media types
### Supported media types

The following table lists the media types that Consumable supports. For information about the the Time-To-Live (TTL) for each media type, see [How Consumable counts impressions](https://kb.Consumableexchange.com/publishers/billing/how_Consumable_counts_impressions.htm) in our Knowledge Base.

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

| Type | Prebid Server support |
| ----------- | ----------- |
| banner | Supported |
| video | Supported, including ad pods for OTT |
| audio | Supported |

## Setup instructions to call Consumable through Prebid Server
### Setup instructions to call Consumable through Prebid Server

**Note:** If you are hosting your own Prebid Server instance, you must contact your Consumable Exchange Representative to get an endpoint and setup instructions.

Expand Down Expand Up @@ -152,14 +154,15 @@ To add Consumable as a bidder:
2. Define the Consumable-specific parameters at the bidder level. For information about these parameters, see the [Bid request parameters](#bid-request-parameters) section below.
3. Include any ad unit level required or optional parameters provided in Prebid's [/openrtb2/video](/prebid-server/endpoints/openrtb2/pbs-endpoint-video.html) documentation.

## Bid request parameters
### Bid request parameters

For a list of the OpenRTB fields that Consumable supports in bid requests, see [List of supported OpenRTB bid request fields for sellers](https://kb.Consumableexchange.com/publishers/openrtb_integration/list_of_supported_openrtb_bid_request_fields_for_sellers.htm#List_of_supported_OpenRTB_bid_request_fields_for_sellers). The following are the required fields for the various supported media types.
### Site (Banner, Video, Audio)

You must include these parameters at the bidder level.

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

| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------|---------|-----------|
| `siteId` | required | The site ID from Consumable. | `12345` | `integer` |
Expand All @@ -172,11 +175,12 @@ You must include these parameters at the bidder level.
You must include these parameters at the bidder level.

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

| Key | Scope | Type | Description |
|---|---|---|---|
| `placementId` | Required | String | An Consumable-specific identifier that is associated with this ad unit. It will be associated with the single size, if the size is provided. This is similar to a placement ID or an ad unit ID that some other modules have. For example, `'0421008445828ceb46f496700a5fa65e'`|

## Examples
### Examples

**Banner**

Expand Down
19 changes: 11 additions & 8 deletions dev-docs/bidders/consumable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,15 @@ The Consumable bid adapter may cycle the ad initially shown with a new one at va
### Bid Params

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

| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------|---------|-----------|
| `siteId` | required | The site ID from Consumable. | `12345` | `integer` |
| `networkId` | required | The network ID from Consumable. | `9969` | `integer` |
| `unitId` | required | The unit ID from Consumable. | `987654` | `integer` |
| `unitName` | required | The unit name from Consumable. | `cnsmbl-unit` | `string` |

## Table of contents
### Table of contents

* [Table of contents](#table-of-contents)
* [Introduction](#introduction)
Expand All @@ -56,7 +57,7 @@ The Consumable bid adapter may cycle the ad initially shown with a new one at va
* [Video](#video)
* [Examples](#examples)

## Introduction
### Introduction

Publishers can use Prebid.js to call Consumable Exchange (Consumable) in any of the following ways:

Expand All @@ -77,7 +78,7 @@ pbjs.bidderSettings = {
};
```

## Supported media types
### Supported media types

The following table lists the media types that Consumable supports.

Expand All @@ -88,11 +89,11 @@ The following table lists the media types that Consumable supports.
| banner | Supported |
| video | Supported |

## Set up Prebid.js to call Consumable directly from the browser (client-side adapter)
### Set up Prebid.js to call Consumable directly from the browser (client-side adapter)

To call Consumable from a web browser environment using a Prebid Server integration, see the Consumable-specific configuration steps in [Setup instructions to call Consumable through Prebid Server](/dev-docs/bidders/consumable-server.html#setup-instructions-to-call-consumable-through-prebid-server) in our Prebid Server documentation on the Prebid site.

## Set up Prebid.js to call Consumable through Prebid Server (server-side adapter)
### Set up Prebid.js to call Consumable through Prebid Server (server-side adapter)

In this configuration, Prebid.js makes a call to Prebid Server and then Prebid Server uses our server-side adapter to call Consumable. Complete the following steps to configure Consumable as a demand source:

Expand Down Expand Up @@ -127,7 +128,7 @@ In this configuration, Prebid.js makes a call to Prebid Server and then Prebid S
});
```

## Set up First Party Data (FPD)
### Set up First Party Data (FPD)

You can set up the Prebid.js FPD module using Global data, Consumable bidder-specific site data, or ad unit-specific data. Consumable supports deal targeting in all the three FPD types.

Expand Down Expand Up @@ -183,13 +184,14 @@ ortb2Imp: {
}
```

## Bid request parameters
### Bid request parameters

### Banner

You must include these parameters at the bidder level.

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

| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------|---------|-----------|
| `siteId` | required | The site ID from Consumable. | `12345` | `integer` |
Expand All @@ -202,14 +204,15 @@ You must include these parameters at the bidder level.
You must include these parameters at the bidder level.

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

| Name | Scope | Description | Example | Type |
|-------------|----------|--------------------------------|---------|-----------|
| `siteId` | required | The site ID from Consumable. | `12345` | `integer` |
| `networkId` | required | The network ID from Consumable. | `9969` | `integer` |
| `unitId` | required | The unit ID from Consumable. | `987654` | `integer` |
| `unitName` | required | The unit name from Consumable. | `cnsmbl-unit` | `string` |

## Examples
### Examples

**Banner**

Expand Down
4 changes: 2 additions & 2 deletions dev-docs/bidders/contxtful.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ multiformar_supported: will-bid-on-any
ortb_blocking_supported: true
---

# Note
### Note

The Contxtful bidder adapter requires some setup. Contact us at [contact@contxtful.com](mailto:contact@contxtful.com)

## User Sync
### User Sync
Contxtful recommends enabling [User Syncing](https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing) to optimize match rate and monetization.

```javascript
Expand Down
3 changes: 2 additions & 1 deletion dev-docs/bidders/exco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@ sidebarType: 1
### Bid Params

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

| Name | Scope | Description | Example | Type |
|------------|----------|-------------------------------------------------------------------------------------------|------------------------------|----------|
| `cId` | required | The connection ID from Exco. | `'562524b21b1c1f08117fc7f9'` | `string` |
| `pId` | required | The publisher ID from Exco. | `'59ac17c192832d0011283fe3'` | `string` |
| `bidFloor` | optional | The minimum bid value desired. Exco will not respond with bids lower than this value. | `0.90` | `float` |

## Example
### Example

```javascript
var adUnits = [{
Expand Down
Loading