Skip to content

Fix #6154 Recommend typescript as adapter language #6157

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

Merged
patmmccann merged 5 commits into from
Jul 27, 2025
Merged

Fix #6154 Recommend typescript as adapter language #6157

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89d1d33
Recommend typescript as adapter language
muuki88 Jul 17, 2025
9637d2d
add back .ts extension
muuki88 Jul 22, 2025
6f24217
add back
muuki88 Jul 22, 2025
165b205
Merge branch 'master' into mention-ts
muuki88 Jul 23, 2025
f27ac04
Update dev-docs/bidder-adaptor.md
patmmccann Jul 27, 2025
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
13 changes: 7 additions & 6 deletions dev-docs/bidder-adaptor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ This page has instructions for writing your own bidder adapter. The instruction
* [Required Files](#bidder-adaptor-Required-Files)
* [Designing your Bid Params](#bidder-adaptor-Designing-your-Bid-Params)
* [HTTP Simple Requests](#bidder-adaptor-HTTP-simple-requests)
* We recommend submitting your adapter written in TypeScript, but you can opt-out and use JavaScript

<a name="bidder-adaptor-Required-Adapter-Conventions"></a>

Expand All @@ -50,7 +51,7 @@ The above list is **not** the full list of requirements. Failure to follow any o

With each adapter submission, there are two files required to be in the pull request:

* `modules/exampleBidAdapter.js`: the file containing the code for the adapter
* `modules/exampleBidAdapter.ts`: the file containing the code for the adapter
* `modules/exampleBidAdapter.md`: a markdown file containing key information about the adapter:
* The contact email of the adapter's maintainer.
* A test ad unit that will consistently return test creatives. This helps us to ensure future Prebid.js updates do not break your adapter. Note that if your adapter supports video (instream and/or outstream context) or native, you must also provide example parameters for each type.
Expand Down Expand Up @@ -196,7 +197,7 @@ If your adapter interfaces with an ORTB backend, you may take advantage of Prebi

### Overview

The new code will reside under the `modules` directory with the name of the bidder suffixed by 'BidAdapter', e.g., `exampleBidAdapter.js`.
The new code will reside under the `modules` directory with the name of the bidder suffixed by 'BidAdapter', e.g., `exampleBidAdapter.ts`.

Here are some guidelines for choosing a bidder code:

Expand All @@ -220,7 +221,7 @@ A high level example of the structure:
import * as utils from 'src/utils';
import { registerBidder } from 'src/adapters/bidderFactory';
import { config } from 'src/config';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.js';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.ts';
const BIDDER_CODE = 'example';
export const spec = {
code: BIDDER_CODE,
Expand Down Expand Up @@ -1138,7 +1139,7 @@ If `image` is a string, `hb_native_image` will be populated with that string (a

For some time, Prebid engineers will try to ensure that legacy-style request definitions will continue to work. However, Prebid.JS is internally converting everything to OpenRTB. So, OpenRTB is the way to go if you want to ensure your native adapter will continue to work for the long run.

We assume that in the first times all adapters will only understand legacy-style native, so we expose two functions in `native.js`:
We assume that in the first times all adapters will only understand legacy-style native, so we expose two functions in `native.ts`:

* `convertOrtbRequestToProprietaryNative(bidRequests)` - this function will convert OpenRTB-style native requests to legacy format. Actually, we've already added this conversion to all adapters so they will not fail when an OpenRTB definition is used by publisher.

Expand All @@ -1161,7 +1162,7 @@ For example tests, see [the existing adapter test suites](https://github.com/pre
import * as utils from 'src/utils';
import {config} from 'src/config';
import {registerBidder} from 'src/adapters/bidderFactory';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.js';
import {BANNER, VIDEO, NATIVE} from 'src/mediaTypes.ts';
const BIDDER_CODE = 'example';
export const spec = {
code: BIDDER_CODE,
Expand Down Expand Up @@ -1316,7 +1317,7 @@ registerBidder(spec);
* Fork the repo
* Copy a file in [dev-docs/bidders](https://github.com/prebid/prebid.github.io/tree/master/dev-docs/bidders) and name it to exactly the same as your biddercode. Add the following metadata to the header of your .md file:
* Add 'biddercode' and set it to the code that publishers should be using to reference your bidder in an AdUnit. _This needs to be the same name as the docs file!_
* Add 'aliasCode' if your biddercode is not the same name as your PBJS implementation file. e.g. if your biddercode is "ex", but the file in the PBJS repo is exampleBidAdapter.js, this value needs to be "example".
* Add 'aliasCode' if your biddercode is not the same name as your PBJS implementation file. e.g. if your biddercode is "ex", but the file in the PBJS repo is exampleBidAdapter.ts, this value needs to be "example".
* Add `pbjs: true`. If you also have a [Prebid Server bid adapter](/prebid-server/developers/add-new-bidder-go.html), add `pbs: true`. Default is false for both.
* If you're on the IAB Global Vendor List (including just [Canada](https://vendor-list.consensu.org/v2/ca/vendor-list.json)), add your ID number in `gvl_id`.
* If you support the IAB's TCF-EU consent string format and have a GVL ID, you may add `tcfeu_supported: true`. Default is false.
Expand Down