diff --git a/modules/mediagoBidAdapter.js b/modules/mediagoBidAdapter.js
index a9c670f35d8..8513fba94c4 100644
--- a/modules/mediagoBidAdapter.js
+++ b/modules/mediagoBidAdapter.js
@@ -11,40 +11,105 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
const BIDDER_CODE = 'mediago';
// const PROTOCOL = window.document.location.protocol;
const ENDPOINT_URL = 'https://gbid.mediago.io/api/bid?tn=';
-const COOKY_SYNC_URL = 'https://gtrace.mediago.io/ju/cs/eplist';
+// const COOKY_SYNC_URL = 'https://gtrace.mediago.io/ju/cs/eplist';
const COOKY_SYNC_IFRAME_URL = 'https://cdn.mediago.io/js/cookieSync.html';
+export const THIRD_PARTY_COOKIE_ORIGIN = 'https://cdn.mediago.io';
const TIME_TO_LIVE = 500;
const GVLID = 1020;
// const ENDPOINT_URL = '/api/bid?tn=';
-const storage = getStorageManager({ bidderCode: BIDDER_CODE });
+export const storage = getStorageManager({bidderCode: BIDDER_CODE});
let globals = {};
let itemMaps = {};
/* ----- mguid:start ------ */
-const COOKIE_KEY_MGUID = '__mguid_';
-const STORE_MAX_AGE = 1000 * 60 * 60 * 24 * 365;
+export const COOKIE_KEY_MGUID = '__mguid_';
+const COOKIE_KEY_PMGUID = '__pmguid_';
+const COOKIE_RETENTION_TIME = 365 * 24 * 60 * 60 * 1000; // 1 year
let reqTimes = 0;
+/**
+ * get page title
+ * @returns {string}
+ */
+
+export function getPageTitle(win = window) {
+ try {
+ const ogTitle = win.top.document.querySelector('meta[property="og:title"]')
+ return win.top.document.title || (ogTitle && ogTitle.content) || '';
+ } catch (e) {
+ const ogTitle = document.querySelector('meta[property="og:title"]')
+ return document.title || (ogTitle && ogTitle.content) || '';
+ }
+}
/**
- * 获取用户id
- * @return {string}
+ * get page description
+ *
+ * @returns {string}
+ */
+export function getPageDescription(win = window) {
+ let element;
+
+ try {
+ element = win.top.document.querySelector('meta[name="description"]') ||
+ win.top.document.querySelector('meta[property="og:description"]')
+ } catch (e) {
+ element = document.querySelector('meta[name="description"]') ||
+ document.querySelector('meta[property="og:description"]')
+ }
+
+ return (element && element.content) || '';
+}
+
+/**
+ * get page keywords
+ * @returns {string}
+ */
+export function getPageKeywords(win = window) {
+ let element;
+
+ try {
+ element = win.top.document.querySelector('meta[name="keywords"]');
+ } catch (e) {
+ element = document.querySelector('meta[name="keywords"]');
+ }
+
+ return (element && element.content) || '';
+}
+
+/**
+ * get connection downlink
+ * @returns {number}
*/
-const getUserID = () => {
- const i = storage.getCookie(COOKIE_KEY_MGUID);
+export function getConnectionDownLink(win = window) {
+ const nav = win.navigator || {};
+ return nav && nav.connection && nav.connection.downlink >= 0 ? nav.connection.downlink.toString() : undefined;
+}
- if (i === null) {
- const uuid = utils.generateUUID();
- storage.setCookie(COOKIE_KEY_MGUID, uuid, STORE_MAX_AGE);
- return uuid;
+/**
+ * get pmg uid
+ * 获取并生成用户的id
+ *
+ * @return {string}
+ */
+export const getPmgUID = () => {
+ if (!storage.cookiesAreEnabled()) return;
+
+ let pmgUid = storage.getCookie(COOKIE_KEY_PMGUID);
+ if (!pmgUid) {
+ pmgUid = utils.generateUUID();
+ try {
+ storage.setCookie(COOKIE_KEY_PMGUID, pmgUid, getCurrentTimeToUTCString());
+ } catch (e) {}
}
- return i;
+ return pmgUid;
};
-/* ----- mguid:end ------ */
+/* ----- pmguid:end ------ */
/**
* 获取一个对象的某个值，如果没有则返回空字符串
+ *
* @param {Object} obj 对象
* @param {...string} keys 键名
* @return {any}
@@ -283,6 +348,16 @@ function getReferrer(bidRequest = {}, bidderRequest = {}) {
return pageUrl;
}
+/**
+ * get current time to UTC string
+ * @returns utc string
+ */
+export function getCurrentTimeToUTCString() {
+ const date = new Date();
+ date.setTime(date.getTime() + COOKIE_RETENTION_TIME);
+ return date.toUTCString();
+}
+
/**
* 获取rtb请求参数
*
@@ -317,6 +392,10 @@ function getParam(validBidRequests, bidderRequest) {
const timeout = bidderRequest.timeout || 2000;
const firstPartyData = bidderRequest.ortb2;
+ const topWindow = window.top;
+ const title = getPageTitle();
+ const desc = getPageDescription();
+ const keywords = getPageKeywords();
if (items && items.length) {
let c = {
@@ -344,11 +423,23 @@ function getParam(validBidRequests, bidderRequest) {
firstPartyData,
content,
cat,
- reqTimes
+ reqTimes,
+ pmguid: getPmgUID(),
+ page: {
+ title: title ? title.slice(0, 100) : undefined,
+ desc: desc ? desc.slice(0, 300) : undefined,
+ keywords: keywords ? keywords.slice(0, 100) : undefined,
+ hLen: topWindow.history?.length || undefined,
+ },
+ device: {
+ nbw: getConnectionDownLink(),
+ hc: topWindow.navigator?.hardwareConcurrency || undefined,
+ dm: topWindow.navigator?.deviceMemory || undefined,
+ }
},
user: {
- buyeruid: getUserID(),
- id: sharedid || pubcid
+ buyeruid: storage.getCookie(COOKIE_KEY_MGUID) || undefined,
+ id: sharedid || pubcid,
},
eids,
site: {
@@ -407,13 +498,12 @@ export const spec = {
return {
method: 'POST',
url: ENDPOINT_URL + globals['token'],
- data: payloadString
+ data: payloadString,
};
},
/**
* Unpack the response from the server into a list of bids.
- *
* @param {ServerResponse} serverResponse A successful response from the server.
* @return {Bid[]} An array of bids which were nested inside the server.
*/
@@ -471,19 +561,26 @@ export const spec = {
}
if (syncOptions.iframeEnabled) {
+ window.addEventListener('message', function handler(event) {
+ if (!event.data || event.origin != THIRD_PARTY_COOKIE_ORIGIN) {
+ return;
+ }
+
+ this.removeEventListener('message', handler);
+
+ event.stopImmediatePropagation();
+
+ const response = event.data;
+ if (!response.optout && response.mguid) {
+ storage.setCookie(COOKIE_KEY_MGUID, response.mguid, getCurrentTimeToUTCString());
+ }
+ }, true);
return [
{
type: 'iframe',
url: `${COOKY_SYNC_IFRAME_URL}?${syncParamUrl}`
}
];
- } else {
- return [
- {
- type: 'image',
- url: `${COOKY_SYNC_URL}?${syncParamUrl}`
- }
- ];
}
},
diff --git a/test/spec/modules/mediagoBidAdapter_spec.js b/test/spec/modules/mediagoBidAdapter_spec.js
index 601bcff527a..6e58217b3d3 100644
--- a/test/spec/modules/mediagoBidAdapter_spec.js
+++ b/test/spec/modules/mediagoBidAdapter_spec.js
@@ -1,5 +1,17 @@
import { expect } from 'chai';
-import { spec } from 'modules/mediagoBidAdapter.js';
+import {
+ spec,
+ getPmgUID,
+ storage,
+ getPageTitle,
+ getPageDescription,
+ getPageKeywords,
+ getConnectionDownLink,
+ THIRD_PARTY_COOKIE_ORIGIN,
+ COOKIE_KEY_MGUID,
+ getCurrentTimeToUTCString
+} from 'modules/mediagoBidAdapter.js';
+import * as utils from 'src/utils.js';
describe('mediago:BidAdapterTests', function () {
let bidRequestData = {
@@ -161,6 +173,47 @@ describe('mediago:BidAdapterTests', function () {
expect(req_data.imp).to.have.lengthOf(1);
});
+ describe('mediago: buildRequests', function() {
+ describe('getPmgUID function', function() {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.sandbox.create();
+ sandbox.stub(storage, 'getCookie');
+ sandbox.stub(storage, 'setCookie');
+ sandbox.stub(utils, 'generateUUID').returns('new-uuid');
+ sandbox.stub(storage, 'cookiesAreEnabled');
+ })
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should generate new UUID and set cookie if not exists', () => {
+ storage.cookiesAreEnabled.callsFake(() => true);
+ storage.getCookie.callsFake(() => null);
+ const uid = getPmgUID();
+ expect(uid).to.equal('new-uuid');
+ expect(storage.setCookie.calledOnce).to.be.true;
+ });
+
+ it('should return existing UUID from cookie', () => {
+ storage.cookiesAreEnabled.callsFake(() => true);
+ storage.getCookie.callsFake(() => 'existing-uuid');
+ const uid = getPmgUID();
+ expect(uid).to.equal('existing-uuid');
+ expect(storage.setCookie.called).to.be.false;
+ });
+
+ it('should not set new UUID when cookies are not enabled', () => {
+ storage.cookiesAreEnabled.callsFake(() => false);
+ storage.getCookie.callsFake(() => null);
+ getPmgUID();
+ expect(storage.setCookie.calledOnce).to.be.false;
+ });
+ })
+ });
+
it('mediago:validate_response_params', function () {
let adm =
'';
@@ -207,4 +260,324 @@ describe('mediago:BidAdapterTests', function () {
expect(bid.height).to.equal(250);
expect(bid.currency).to.equal('USD');
});
+
+ describe('mediago: getUserSyncs', function() {
+ const COOKY_SYNC_IFRAME_URL = 'https://cdn.mediago.io/js/cookieSync.html';
+ const IFRAME_ENABLED = {
+ iframeEnabled: true,
+ pixelEnabled: false,
+ };
+ const IFRAME_DISABLED = {
+ iframeEnabled: false,
+ pixelEnabled: false,
+ };
+ const GDPR_CONSENT = {
+ consentString: 'gdprConsentString',
+ gdprApplies: true
+ };
+ const USP_CONSENT = {
+ consentString: 'uspConsentString'
+ }
+
+ let syncParamUrl = `dm=${encodeURIComponent(location.origin || `https://${location.host}`)}`;
+ syncParamUrl += '&gdpr=1&gdpr_consent=gdprConsentString&ccpa_consent=uspConsentString';
+ const expectedIframeSyncs = [
+ {
+ type: 'iframe',
+ url: `${COOKY_SYNC_IFRAME_URL}?${syncParamUrl}`
+ }
+ ];
+
+ it('should return nothing if iframe is disabled', () => {
+ const userSyncs = spec.getUserSyncs(IFRAME_DISABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
+ expect(userSyncs).to.be.undefined;
+ });
+
+ it('should do userSyncs if iframe is enabled', () => {
+ const userSyncs = spec.getUserSyncs(IFRAME_ENABLED, undefined, GDPR_CONSENT, USP_CONSENT, undefined);
+ expect(userSyncs).to.deep.equal(expectedIframeSyncs);
+ });
+ });
+});
+
+describe('mediago Bid Adapter Tests', function () {
+ describe('buildRequests', () => {
+ describe('getPageTitle function', function() {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.createSandbox();
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should return the top document title if available', function() {
+ const fakeTopDocument = {
+ title: 'Top Document Title',
+ querySelector: () => ({ content: 'Top Document Title test' })
+ };
+ const fakeTopWindow = {
+ document: fakeTopDocument
+ };
+ const result = getPageTitle({ top: fakeTopWindow });
+ expect(result).to.equal('Top Document Title');
+ });
+
+ it('should return the content of top og:title meta tag if title is empty', function() {
+ const ogTitleContent = 'Top OG Title Content';
+ const fakeTopWindow = {
+ document: {
+ title: '',
+ querySelector: sandbox.stub().withArgs('meta[property="og:title"]').returns({ content: ogTitleContent })
+ }
+ };
+
+ const result = getPageTitle({ top: fakeTopWindow });
+ expect(result).to.equal(ogTitleContent);
+ });
+
+ it('should return the document title if no og:title meta tag is present', function() {
+ document.title = 'Test Page Title';
+ sandbox.stub(document, 'querySelector').withArgs('meta[property="og:title"]').returns(null);
+
+ const result = getPageTitle({ top: undefined });
+ expect(result).to.equal('Test Page Title');
+ });
+
+ it('should return the content of og:title meta tag if present', function() {
+ document.title = '';
+ const ogTitleContent = 'Top OG Title Content';
+ sandbox.stub(document, 'querySelector').withArgs('meta[property="og:title"]').returns({ content: ogTitleContent });
+ const result = getPageTitle({ top: undefined });
+ expect(result).to.equal(ogTitleContent);
+ });
+
+ it('should return an empty string if no title or og:title meta tag is found', function() {
+ document.title = '';
+ sandbox.stub(document, 'querySelector').withArgs('meta[property="og:title"]').returns(null);
+ const result = getPageTitle({ top: undefined });
+ expect(result).to.equal('');
+ });
+
+ it('should handle exceptions when accessing top.document and fallback to current document', function() {
+ const fakeWindow = {
+ get top() {
+ throw new Error('Access denied');
+ }
+ };
+ const ogTitleContent = 'Current OG Title Content';
+ document.title = 'Current Document Title';
+ sandbox.stub(document, 'querySelector').withArgs('meta[property="og:title"]').returns({ content: ogTitleContent });
+ const result = getPageTitle(fakeWindow);
+ expect(result).to.equal('Current Document Title');
+ });
+ });
+
+ describe('getPageDescription function', function() {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.createSandbox();
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should return the top document description if available', function() {
+ const descriptionContent = 'Top Document Description';
+ const fakeTopDocument = {
+ querySelector: sandbox.stub().withArgs('meta[name="description"]').returns({ content: descriptionContent })
+ };
+ const fakeTopWindow = { document: fakeTopDocument };
+ const result = getPageDescription({ top: fakeTopWindow });
+ expect(result).to.equal(descriptionContent);
+ });
+
+ it('should return the top document og:description if description is not present', function() {
+ const ogDescriptionContent = 'Top OG Description';
+ const fakeTopDocument = {
+ querySelector: sandbox.stub().withArgs('meta[property="og:description"]').returns({ content: ogDescriptionContent })
+ };
+ const fakeTopWindow = { document: fakeTopDocument };
+ const result = getPageDescription({ top: fakeTopWindow });
+ expect(result).to.equal(ogDescriptionContent);
+ });
+
+ it('should return the current document description if top document is not accessible', function() {
+ const descriptionContent = 'Current Document Description';
+ sandbox.stub(document, 'querySelector')
+ .withArgs('meta[name="description"]').returns({ content: descriptionContent })
+ const fakeWindow = {
+ get top() {
+ throw new Error('Access denied');
+ }
+ };
+ const result = getPageDescription(fakeWindow);
+ expect(result).to.equal(descriptionContent);
+ });
+
+ it('should return the current document og:description if description is not present and top document is not accessible', function() {
+ const ogDescriptionContent = 'Current OG Description';
+ sandbox.stub(document, 'querySelector')
+ .withArgs('meta[property="og:description"]').returns({ content: ogDescriptionContent });
+
+ const fakeWindow = {
+ get top() {
+ throw new Error('Access denied');
+ }
+ };
+ const result = getPageDescription(fakeWindow);
+ expect(result).to.equal(ogDescriptionContent);
+ });
+ });
+
+ describe('getPageKeywords function', function() {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.createSandbox();
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should return the top document keywords if available', function() {
+ const keywordsContent = 'keyword1, keyword2, keyword3';
+ const fakeTopDocument = {
+ querySelector: sandbox.stub()
+ .withArgs('meta[name="keywords"]').returns({ content: keywordsContent })
+ };
+ const fakeTopWindow = { document: fakeTopDocument };
+
+ const result = getPageKeywords({ top: fakeTopWindow });
+ expect(result).to.equal(keywordsContent);
+ });
+
+ it('should return the current document keywords if top document is not accessible', function() {
+ const keywordsContent = 'keyword1, keyword2, keyword3';
+ sandbox.stub(document, 'querySelector')
+ .withArgs('meta[name="keywords"]').returns({ content: keywordsContent });
+
+ // 模拟顶层窗口访问异常
+ const fakeWindow = {
+ get top() {
+ throw new Error('Access denied');
+ }
+ };
+
+ const result = getPageKeywords(fakeWindow);
+ expect(result).to.equal(keywordsContent);
+ });
+
+ it('should return an empty string if no keywords meta tag is found', function() {
+ sandbox.stub(document, 'querySelector').withArgs('meta[name="keywords"]').returns(null);
+
+ const result = getPageKeywords();
+ expect(result).to.equal('');
+ });
+ });
+ describe('getConnectionDownLink function', function() {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.createSandbox();
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should return the downlink value as a string if available', function() {
+ const downlinkValue = 2.5;
+ const fakeNavigator = {
+ connection: {
+ downlink: downlinkValue
+ }
+ };
+
+ const result = getConnectionDownLink({ navigator: fakeNavigator });
+ expect(result).to.equal(downlinkValue.toString());
+ });
+
+ it('should return undefined if downlink is not available', function() {
+ const fakeNavigator = {
+ connection: {}
+ };
+
+ const result = getConnectionDownLink({ navigator: fakeNavigator });
+ expect(result).to.be.undefined;
+ });
+
+ it('should return undefined if connection is not available', function() {
+ const fakeNavigator = {};
+
+ const result = getConnectionDownLink({ navigator: fakeNavigator });
+ expect(result).to.be.undefined;
+ });
+
+ it('should handle cases where navigator is not defined', function() {
+ const result = getConnectionDownLink({});
+ expect(result).to.be.undefined;
+ });
+ });
+
+ describe('getUserSyncs with message event listener', function() {
+ function messageHandler(event) {
+ if (!event.data || event.origin !== THIRD_PARTY_COOKIE_ORIGIN) {
+ return;
+ }
+
+ window.removeEventListener('message', messageHandler, true);
+ event.stopImmediatePropagation();
+
+ const response = event.data;
+ if (!response.optout && response.mguid) {
+ storage.setCookie(COOKIE_KEY_MGUID, response.mguid, getCurrentTimeToUTCString());
+ }
+ }
+
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.createSandbox();
+ sandbox.stub(storage, 'setCookie');
+ sandbox.stub(window, 'removeEventListener');
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ it('should set a cookie when a valid message is received', () => {
+ const fakeEvent = {
+ data: { optout: '', mguid: '12345' },
+ origin: THIRD_PARTY_COOKIE_ORIGIN,
+ stopImmediatePropagation: sinon.spy()
+ };
+
+ messageHandler(fakeEvent);
+
+ expect(fakeEvent.stopImmediatePropagation.calledOnce).to.be.true;
+ expect(window.removeEventListener.calledWith('message', messageHandler, true)).to.be.true;
+ expect(storage.setCookie.calledWith(COOKIE_KEY_MGUID, '12345', sinon.match.string)).to.be.true;
+ });
+ it('should not do anything when an invalid message is received', () => {
+ const fakeEvent = {
+ data: null,
+ origin: 'http://invalid-origin.com',
+ stopImmediatePropagation: sinon.spy()
+ };
+
+ messageHandler(fakeEvent);
+
+ expect(fakeEvent.stopImmediatePropagation.notCalled).to.be.true;
+ expect(window.removeEventListener.notCalled).to.be.true;
+ expect(storage.setCookie.notCalled).to.be.true;
+ });
+ });
+ });
});
