Skip to content

Equativ Bid Adapter: forward all inventory fields #9

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
szhang-str merged 1 commit into from
Jul 13, 2026
Merged

Equativ Bid Adapter: forward all inventory fields #9

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: 1 addition & 2 deletions modules/equativBidAdapter.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ export interface EquativBidderParams {
networkId?: number;
/**
* Placement identifier used to source inventory.
* Forwarded as `imp.ext.bidder.plcmtuuid`. When provided, it takes precedence
* over the deprecated `siteId`, `pageId` and `formatId` parameters.
* Forwarded as `imp.ext.bidder.plcmtuuid`.
*/
placementuuid?: string;
/**
Expand Down
18 changes: 11 additions & 7 deletions modules/equativBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,13 +207,17 @@ export const converter = ortbConverter({
mergeDeep(imp, { rwdd: bidRequest.mediaTypes.video.ext.rewarded });
}

// `placementuuid` is the preferred way to identify inventory. When it is
// provided it takes precedence over the <deprecated> `siteId`, `pageId` and
// `formatId` </deprecated> parameters, which are kept only to support the ramp-up period.
// SSB expects this value in the OpenRTB extension as `plcmtuuid`.
const bidder = placementuuid
? { plcmtuuid: placementuuid }
: { ...(siteId && { siteId }), ...(pageId && { pageId }), ...(formatId && { formatId }) };
// `placementuuid` is the preferred way to identify inventory. The
// <deprecated> `siteId`, `pageId` and `formatId` </deprecated> parameters
// are kept only to support the ramp-up period. Forward all provided fields
// and let the downstream receiver decide which to use.
// SSB expects the `placementuuid` value in the OpenRTB extension as `plcmtuuid`.
const bidder = {
...(placementuuid && { plcmtuuid: placementuuid }),
...(siteId && { siteId }),
...(pageId && { pageId }),
...(formatId && { formatId })
};
if (Object.keys(bidder).length) {
mergeDeep(imp.ext, { bidder });
}
Expand Down
2 changes: 1 addition & 1 deletion modules/equativBidAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ var adUnits = [
| Name | Scope | Description | Type |
|-----------------|----------|------------------------------------------------------------------------------------------------------|----------|
| `networkId` | optional | Equativ network id. Mandatory unless `ortb2.(site\|app\|dooh).publisher.id` is set. | `number` |
| `placementuuid` | optional | Placement identifier used to source inventory. Preferred way to identify inventory; forwarded as `imp.ext.bidder.plcmtuuid` and takes precedence over `siteId`/`pageId`/`formatId` when both are provided. | `string` |
| `placementuuid` | optional | Placement identifier used to source inventory. Preferred way to identify inventory; forwarded as `imp.ext.bidder.plcmtuuid`. When legacy params are also supplied, all fields are forwarded and the downstream receiver decides which to use. | `string` |
| `siteId` | optional | **Deprecated.** Equativ site id. Use `placementuuid` instead. Kept only to support the ramp-up. | `number` |
| `pageId` | optional | **Deprecated.** Equativ page id. Use `placementuuid` instead. Kept only to support the ramp-up. | `number` |
| `formatId` | optional | **Deprecated.** Equativ format id. Use `placementuuid` instead. Kept only to support the ramp-up. | `number` |
5 changes: 4 additions & 1 deletion test/spec/modules/equativBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ describe('Equativ bid adapter tests', () => {
});
});

it('should let placementuuid take precedence over siteId, pageId, formatId when both are provided', () => {
it('should forward plcmtuuid alongside deprecated params when all inventory params are provided', () => {
const bidRequests = [
{
...DEFAULT_BANNER_BID_REQUESTS[0],
Expand All @@ -314,6 +314,9 @@ describe('Equativ bid adapter tests', () => {
const request = spec.buildRequests(bidRequests, bidderRequest)[0];
expect(request.data.imp[0].ext.bidder).to.deep.equal({
plcmtuuid: 'abc-123',
siteId: 123,
pageId: 456,
formatId: 789,
});
});

Expand Down
Loading