Add The Trade Desk to prebid (#1773)

Co-authored-by: Emma Imber <[email protected]>

.changeset/sour-chairs-clean.md

@@ -0,0 +1,5 @@
+---
+'@guardian/commercial': minor
+---
+
+Add The Trade Desk behind 0% test

package.json

@@ -101,7 +101,7 @@
 		"webpack-merge": "^6.0.1"
 	},
 	"dependencies": {
-		"@guardian/prebid.js": "8.52.0-12",
+		"@guardian/prebid.js": "8.52.0-13",
 		"fastdom": "^1.0.12",
 		"lodash-es": "^4.17.21",
 		"process": "^0.11.10",

src/experiments/ab-tests.ts

@@ -2,6 +2,7 @@ import type { ABTest } from '@guardian/ab-core';
 import { mpuWhenNoEpic } from './tests/mpu-when-no-epic';
 import { optOutFrequencyCap } from './tests/opt-out-frequency-cap';
 import { prebidKeywords } from './tests/prebid-keywords';
+import { ttdPrebidBidder } from './tests/ttd-prebid';
 
 /**
  * You only need to add tests to this file if the code you are testing is here in
@@ -13,4 +14,5 @@ export const concurrentTests: ABTest[] = [
 	mpuWhenNoEpic,
 	optOutFrequencyCap,
 	prebidKeywords,
+	ttdPrebidBidder,
 ];

src/experiments/tests/ttd-prebid.ts

@@ -0,0 +1,28 @@
+import type { ABTest } from '@guardian/ab-core';
+
+export const ttdPrebidBidder: ABTest = {
+	id: 'TheTradeDesk',
+	author: '@commercial-dev',
+	start: '2025-01-30',
+	expiry: '2025-02-28',
+	audience: 0 / 100,
+	audienceOffset: 0 / 100,
+	audienceCriteria: '',
+	successMeasure: 'Verify The Trade Desk bidder is added to Prebid.js',
+	description: 'Verify The Trade Desk bidder is added to Prebid.js',
+	variants: [
+		{
+			id: 'control',
+			test: (): void => {
+				/* no-op */
+			},
+		},
+		{
+			id: 'variant',
+			test: (): void => {
+				/* no-op */
+			},
+		},
+	],
+	canRun: () => true,
+};

src/lib/header-bidding/prebid-types.ts

@@ -113,6 +113,12 @@ export type PrebidMagniteParams = {
 	keywords: string[];
 };
 
+export type PrebidTheTradeDeskParams = {
+	supplySourceId: number;
+	publisherId: number;
+	placementId: string;
+};
+
 export type BidderCode =
 	| 'adyoulike'
 	| 'and'
@@ -127,7 +133,8 @@ export type BidderCode =
 	| 'pubmatic'
 	| 'triplelift'
 	| 'trustx'
-	| 'xhb';
+	| 'xhb'
+	| 'ttd';
 
 export type PrebidParams =
 	| PrebidAdYouLikeParams
@@ -142,7 +149,8 @@ export type PrebidParams =
 	| PrebidPubmaticParams
 	| PrebidTripleLiftParams
 	| PrebidTrustXParams
-	| PrebidXaxisParams;
+	| PrebidXaxisParams
+	| PrebidTheTradeDeskParams;
 
 export type PrebidBidder = {
 	name: BidderCode;

src/lib/header-bidding/prebid/bid-config.spec.ts

@@ -35,6 +35,7 @@ const getBidders = () =>
 		'dfp-ad--top-above-nav',
 		[createAdSize(728, 90)],
 		mockPageTargeting,
+		'gpid',
 	).map((bid) => bid.bidder);
 
 const {
@@ -289,6 +290,7 @@ describe('bids', () => {
 				'dfp-right',
 				[createAdSize(300, 600), createAdSize(300, 250)],
 				mockPageTargeting,
+				'gpid',
 			).map((bid) => bid.bidder);
 		expect(rightSlotBidders()).toEqual(['ix', 'ix', 'criteo', 'adyoulike']);
 	});
@@ -332,6 +334,7 @@ describe('bids', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[3];
 		expect(openXBid?.params).toEqual({
 			customParams: 'someAppNexusTargetingObject',
@@ -347,6 +350,7 @@ describe('bids', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[3];
 		expect(openXBid?.params).toEqual({
 			customParams: 'someAppNexusTargetingObject',
@@ -362,6 +366,7 @@ describe('bids', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[3];
 		expect(openXBid?.params).toEqual({
 			customParams: 'someAppNexusTargetingObject',
@@ -377,6 +382,7 @@ describe('bids', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[3];
 		expect(openXBid?.params).toEqual({
 			customParams: 'someAppNexusTargetingObject',
@@ -392,6 +398,7 @@ describe('bids', () => {
 			'dfp-ad--mobile-sticky',
 			[createAdSize(320, 50)],
 			mockPageTargeting,
+			'gpid',
 		)[3];
 		expect(openXBid?.params).toEqual({
 			customParams: 'someAppNexusTargetingObject',
@@ -431,6 +438,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_topbanner_728x90_prebid',
@@ -447,6 +455,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(728, 90)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_topbanner_728x90_prebid_AU',
@@ -464,6 +473,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--inline1',
 			[createAdSize(300, 250)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_sectionfront_300x250_prebid',
@@ -481,6 +491,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--inline1',
 			[createAdSize(300, 250)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_sectionfront_300x250_prebid_AU',
@@ -498,6 +509,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(320, 50)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_320x50_HDX',
@@ -515,6 +527,7 @@ describe('triplelift adapter', () => {
 			'dfp-ad--top-above-nav',
 			[createAdSize(320, 50)],
 			mockPageTargeting,
+			'gpid',
 		)[2]?.params;
 		expect(tripleLiftBids).toEqual({
 			inventoryCode: 'theguardian_320x50_HDX_AU',

src/lib/header-bidding/prebid/bid-config.ts

@@ -47,6 +47,7 @@ import {
 	shouldIncludeKargo,
 	shouldIncludeMagnite,
 	shouldIncludeOpenx,
+	shouldIncludeTheTradeDesk,
 	shouldIncludeTripleLift,
 	shouldIncludeTrustX,
 	shouldIncludeXaxis,
@@ -629,6 +630,16 @@ const magniteBidder: PrebidBidder = {
 	}),
 };
 
+const theTradeDeskBidder = (gpid: string): PrebidBidder => ({
+	name: 'ttd',
+	switchName: 'prebidTheTradeDesk',
+	bidParams: () => ({
+		supplySourceId: 'theguardian',
+		publisherId: '1',
+		placementId: gpid,
+	}),
+});
+
 // There's an IX bidder for every size that the slot can take
 const indexExchangeBidders = (
 	slotSizes: HeaderBiddingSize[],
@@ -657,6 +668,7 @@ const biddersSwitchedOn = (allBidders: PrebidBidder[]): PrebidBidder[] => {
 const currentBidders = (
 	slotSizes: HeaderBiddingSize[],
 	pageTargeting: PageTargeting,
+	gpid: string,
 ): PrebidBidder[] => {
 	const biddersToCheck: Array<[boolean, PrebidBidder]> = [
 		[true, criteoBidder(slotSizes)],
@@ -672,6 +684,7 @@ const currentBidders = (
 		[shouldIncludeOpenx(), openxClientSideBidder(pageTargeting)],
 		[shouldIncludeKargo(), kargoBidder],
 		[shouldIncludeMagnite(), magniteBidder],
+		[shouldIncludeTheTradeDesk(), theTradeDeskBidder(gpid)],
 	];
 
 	const otherBidders = biddersToCheck
@@ -688,11 +701,14 @@ export const bids = (
 	slotId: string,
 	slotSizes: HeaderBiddingSize[],
 	pageTargeting: PageTargeting,
+	gpid: string,
 ): PrebidBid[] =>
-	currentBidders(slotSizes, pageTargeting).map((bidder: PrebidBidder) => ({
-		bidder: bidder.name,
-		params: bidder.bidParams(slotId, slotSizes),
-	}));
+	currentBidders(slotSizes, pageTargeting, gpid).map(
+		(bidder: PrebidBidder) => ({
+			bidder: bidder.name,
+			params: bidder.bidParams(slotId, slotSizes),
+		}),
+	);
 
 export const _ = {
 	getIndexSiteIdFromConfig,

src/lib/header-bidding/prebid/prebid.ts

@@ -191,7 +191,6 @@ class PrebidAdUnit {
 		pageTargeting: PageTargeting,
 	) {
 		this.code = advert.id;
-		this.bids = bids(advert.id, slot.sizes, pageTargeting);
 		this.mediaTypes = { banner: { sizes: slot.sizes } };
 		this.gpid = this.generateGpid(advert, slot);
 		this.ortb2Imp = {
@@ -203,6 +202,8 @@ class PrebidAdUnit {
 			},
 		};
 
+		this.bids = bids(advert.id, slot.sizes, pageTargeting, this.gpid);
+
 		advert.headerBiddingSizes = slot.sizes;
 		log('commercial', `PrebidAdUnit ${this.code}`, this.bids);
 	}

src/lib/header-bidding/utils.ts

@@ -1,5 +1,7 @@
 import { isString } from '@guardian/libs';
 import { once } from 'lodash-es';
+import { isUserInVariant } from '../../experiments/ab';
+import { ttdPrebidBidder } from '../../experiments/tests/ttd-prebid';
 import { createAdSize } from '../../lib/ad-sizes';
 import {
 	isInAuOrNz,
@@ -189,6 +191,9 @@ export const shouldIncludeKargo = (): boolean => isInUsa();
 export const shouldIncludeMagnite = (): boolean =>
 	!!window.guardian.config.switches.prebidMagnite;
 
+export const shouldIncludeTheTradeDesk = (): boolean =>
+	isUserInVariant(ttdPrebidBidder, 'variant');
+
 export const shouldIncludeMobileSticky = once(
 	(): boolean =>
 		window.location.hash.includes('#mobile-sticky') ||