From 4ceb2d252424bacbce09982baa3db78aa6b7ed29 Mon Sep 17 00:00:00 2001 From: Samuel Adu Date: Thu, 1 Jun 2023 15:41:42 +0100 Subject: [PATCH] Yahoo bid adapter: User sync pixels, consent signals update (#10028) * YahooSSP bid adapter: Consume GPP signals * Test updates and logic fixes --------- Co-authored-by: slimkrazy --- modules/yahoosspBidAdapter.js | 48 +++++- modules/yahoosspBidAdapter.md | 2 +- test/spec/modules/yahoosspBidAdapter_spec.js | 154 +++++++++++++------ 3 files changed, 149 insertions(+), 55 deletions(-) diff --git a/modules/yahoosspBidAdapter.js b/modules/yahoosspBidAdapter.js index 249a088ed1c..7a414c0d2ee 100644 --- a/modules/yahoosspBidAdapter.js +++ b/modules/yahoosspBidAdapter.js @@ -101,6 +101,37 @@ function extractUserSyncUrls(syncOptions, pixels) { return userSyncObjects; } +/** + * @param {string} url + * @param {object} consentData + * @param {object} consentData.gpp + * @param {string} consentData.gpp.gppConsent + * @param {array} consentData.gpp.applicableSections + * @param {object} consentData.gdpr + * @param {object} consentData.gdpr.consentString + * @param {object} consentData.gdpr.gdprApplies + * @param {string} consentData.uspConsent + */ +function updateConsentQueryParams(url, consentData) { + const parameterMap = { + 'gdpr_consent': consentData.gdpr.consentString, + 'gdpr': consentData.gdpr.gdprApplies ? '1' : '0', + 'us_privacy': consentData.uspConsent, + 'gpp': consentData.gpp.gppString, + 'gpp_sid': consentData.gpp.applicableSections ? consentData.gpp.applicableSections.join(',') : '' + } + + const existingUrl = new URL(url); + const params = existingUrl.searchParams; + + for (const [key, value] of Object.entries(parameterMap)) { + params.set(key, value); + } + + existingUrl.search = params.toString(); + return existingUrl.toString(); +}; + function getSupportedEids(bid) { if (isArray(deepAccess(bid, 'userIdAsEids'))) { return bid.userIdAsEids.filter(eid => { @@ -244,7 +275,9 @@ function generateOpenRtbObject(bidderRequest, bid) { regs: { ext: { 'us_privacy': bidderRequest.uspConsent ? bidderRequest.uspConsent : '', - gdpr: bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies ? 1 : 0 + gdpr: bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies ? 1 : 0, + gpp: bidderRequest.gppConsent.gppString, + gpp_sid: bidderRequest.gppConsent.applicableSections } }, source: { @@ -518,6 +551,7 @@ function createRenderer(bidderRequest, bidResponse) { } return renderer; } + /* Utility functions */ export const spec = { @@ -634,11 +668,19 @@ export const spec = { return response; }, - getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) { + getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) { const bidResponse = !isEmpty(serverResponses) && serverResponses[0].body; if (bidResponse && bidResponse.ext && bidResponse.ext.pixels) { - return extractUserSyncUrls(syncOptions, bidResponse.ext.pixels); + const userSyncObjects = extractUserSyncUrls(syncOptions, bidResponse.ext.pixels); + userSyncObjects.forEach(userSyncObject => { + userSyncObject.url = updateConsentQueryParams(userSyncObject.url, { + gpp: gppConsent, + gdpr: gdprConsent, + uspConsent: uspConsent + }); + }); + return userSyncObjects; } return []; diff --git a/modules/yahoosspBidAdapter.md b/modules/yahoosspBidAdapter.md index e0d1b365acd..35a640b92b1 100644 --- a/modules/yahoosspBidAdapter.md +++ b/modules/yahoosspBidAdapter.md @@ -827,6 +827,6 @@ const adUnits = [{ This adapter does not support passing legacy overrides via 'bidder.params.ext' since most of the data should be passed using prebid modules (First Party Data, Schain, Price Floors etc.). If you do not know how to pass a custom parameter that you previously used, please contact us using the information provided above. -Thanks you, +Thank you, Yahoo SSP diff --git a/test/spec/modules/yahoosspBidAdapter_spec.js b/test/spec/modules/yahoosspBidAdapter_spec.js index f558089b7b0..b0030c89371 100644 --- a/test/spec/modules/yahoosspBidAdapter_spec.js +++ b/test/spec/modules/yahoosspBidAdapter_spec.js @@ -89,11 +89,16 @@ let generateBidderRequest = (bidRequestArray, adUnitCode, ortb2 = {}) => { numIframes: 0, stack: ['https://publisher-test.com'], }, + uspConsent: '1-Y-', gdprConsent: { consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA', vendorData: {}, gdprApplies: true }, + gppConsent: { + gppString: 'DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN', + applicableSections: [1, 2, 3] + }, start: new Date().getTime(), timeout: 1000, ortb2 @@ -177,11 +182,6 @@ const generateResponseMock = (admPayloadType, vastVersion, videoContext) => { // Unit tests describe('YahooSSP Bid Adapter:', () => { - it('PLACEHOLDER TO PASS GULP', () => { - const obj = {}; - expect(obj).to.be.an('object'); - }); - describe('Validate basic properties', () => { it('should define the correct bidder code', () => { expect(spec.code).to.equal('yahoossp') @@ -193,40 +193,38 @@ describe('YahooSSP Bid Adapter:', () => { }); describe('getUserSyncs()', () => { - const IMAGE_PIXEL_URL = 'http://image-pixel.com/foo/bar?1234&baz=true'; - const IFRAME_ONE_URL = 'http://image-iframe.com/foo/bar?1234&baz=true'; + const IMAGE_PIXEL_URL = 'http://image-pixel.com/foo/bar?1234&baz=true&gdpr=foo&gdpr_consent=bar'; + const IFRAME_ONE_URL = 'http://image-iframe.com/foo/bar?1234&baz=true&us_privacy=hello&gpp=goodbye'; const IFRAME_TWO_URL = 'http://image-iframe-two.com/foo/bar?1234&baz=true'; - - let serverResponses = []; - beforeEach(() => { - serverResponses[0] = { - body: { - ext: { - pixels: `` - } + const SERVER_RESPONSES = [{ + body: { + ext: { + pixels: `` } } - }); - - after(() => { - serverResponses = undefined; - }); + }]; + const bidderRequest = generateBuildRequestMock({}).bidderRequest; it('for only iframe enabled syncs', () => { let syncOptions = { iframeEnabled: true, pixelEnabled: false }; - let pixelsObjects = spec.getUserSyncs(syncOptions, serverResponses); - expect(pixelsObjects.length).to.equal(2); - expect(pixelsObjects).to.deep.equal( - [ - {type: 'iframe', 'url': IFRAME_ONE_URL}, - {type: 'iframe', 'url': IFRAME_TWO_URL} - ] - ) + let pixelObjects = spec.getUserSyncs( + syncOptions, + SERVER_RESPONSES, + bidderRequest.gdprConsent, + bidderRequest.uspConsent, + bidderRequest.gppConsent + ); + expect(pixelObjects.length).to.equal(2); + + pixelObjects.forEach(pixelObject => { + expect(pixelObject).to.have.all.keys('type', 'url'); + expect(pixelObject.type).to.equal('iframe'); + }); }); it('for only pixel enabled syncs', () => { @@ -234,13 +232,16 @@ describe('YahooSSP Bid Adapter:', () => { iframeEnabled: false, pixelEnabled: true }; - let pixelsObjects = spec.getUserSyncs(syncOptions, serverResponses); - expect(pixelsObjects.length).to.equal(1); - expect(pixelsObjects).to.deep.equal( - [ - {type: 'image', 'url': IMAGE_PIXEL_URL} - ] - ) + let pixelObjects = spec.getUserSyncs( + syncOptions, + SERVER_RESPONSES, + bidderRequest.gdprConsent, + bidderRequest.uspConsent, + bidderRequest.gppConsent + ); + expect(pixelObjects.length).to.equal(1); + expect(pixelObjects[0]).to.have.all.keys('type', 'url'); + expect(pixelObjects[0].type).to.equal('image'); }); it('for both pixel and iframe enabled syncs', () => { @@ -248,15 +249,56 @@ describe('YahooSSP Bid Adapter:', () => { iframeEnabled: true, pixelEnabled: true }; - let pixelsObjects = spec.getUserSyncs(syncOptions, serverResponses); - expect(pixelsObjects.length).to.equal(3); - expect(pixelsObjects).to.deep.equal( - [ - {type: 'iframe', 'url': IFRAME_ONE_URL}, - {type: 'image', 'url': IMAGE_PIXEL_URL}, - {type: 'iframe', 'url': IFRAME_TWO_URL} - ] - ) + let pixelObjects = spec.getUserSyncs( + syncOptions, + SERVER_RESPONSES, + bidderRequest.gdprConsent, + bidderRequest.uspConsent, + bidderRequest.gppConsent + ); + expect(pixelObjects.length).to.equal(3); + let iframeCount = 0; + let imageCount = 0; + pixelObjects.forEach(pixelObject => { + if (pixelObject.type == 'iframe') { + iframeCount++; + } else if (pixelObject.type == 'image') { + imageCount++; + } + }); + expect(iframeCount).to.equal(2); + expect(imageCount).to.equal(1); + }); + + describe('user consent parameters are updated', () => { + let syncOptions = { + iframeEnabled: true, + pixelEnabled: true + }; + let pixelObjects = spec.getUserSyncs( + syncOptions, + SERVER_RESPONSES, + bidderRequest.gdprConsent, + bidderRequest.uspConsent, + bidderRequest.gppConsent + ); + pixelObjects.forEach(pixelObject => { + let url = pixelObject.url; + let urlParams = new URL(url).searchParams; + const expectedParams = { + 'baz': 'true', + 'gdpr_consent': bidderRequest.gdprConsent.consentString, + 'gdpr': bidderRequest.gdprConsent.gdprApplies ? '1' : '0', + 'us_privacy': bidderRequest.uspConsent, + 'gpp': bidderRequest.gppConsent.gppString, + 'gpp_sid': Array.isArray(bidderRequest.gppConsent.applicableSections) ? bidderRequest.gppConsent.applicableSections.join(',') : '' + } + for (const [key, value] of Object.entries(expectedParams)) { + it(`Updates the ${key} consent param in user sync URL ${url}`, () => { + expect(urlParams.get(key)).to.equal(value); + }); + }; + }); }); }); @@ -749,7 +791,15 @@ describe('YahooSSP Bid Adapter:', () => { expect(options.withCredentials).to.be.false; }); - it('adds the ortb2 gpp consent info to the request', function () { + it('set the GPP consent data from the data within the bid request', function () { + const { validBidRequests, bidderRequest } = generateBuildRequestMock({}); + let clonedBidderRequest = {...bidderRequest}; + const data = spec.buildRequests(validBidRequests, clonedBidderRequest)[0].data; + expect(data.regs.ext.gpp).to.equal(bidderRequest.gppConsent.gppString); + expect(data.regs.ext.gpp_sid).to.eql(bidderRequest.gppConsent.applicableSections); + }); + + it('overrides the GPP consent data using data from the ortb2 config object', function () { const { validBidRequests, bidderRequest } = generateBuildRequestMock({}); const ortb2 = { regs: { @@ -759,8 +809,8 @@ describe('YahooSSP Bid Adapter:', () => { }; let clonedBidderRequest = {...bidderRequest, ortb2}; const data = spec.buildRequests(validBidRequests, clonedBidderRequest)[0].data; - expect(data.regs.ext.gpp).to.equal('somegppstring'); - expect(data.regs.ext.gpp_sid).to.eql([6, 7]); + expect(data.regs.ext.gpp).to.equal(ortb2.regs.gpp); + expect(data.regs.ext.gpp_sid).to.eql(ortb2.regs.gpp_sid); }); }); @@ -930,8 +980,10 @@ describe('YahooSSP Bid Adapter:', () => { expect(data.regs).to.deep.equal({ ext: { - 'us_privacy': '', - gdpr: 1 + 'us_privacy': bidderRequest.uspConsent, + gdpr: 1, + gpp: bidderRequest.gppConsent.gppString, + gpp_sid: bidderRequest.gppConsent.applicableSections } });