Skip to content
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

Jump to bottom

AMX Bid Adapter : remove hardcoded, depricated fields, cast sync settings, add configuration data #12234

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

AMX Bid Adapter : remove hardcoded, depricated fields, cast sync settings, add configuration data #12234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0092b92
AMX: remove hardcoded, depricated fields, cast sync settings to corre…
nickjacob Sep 12, 2024
5ad919f
update documentation to reflect required 'tagId' parameter
nickjacob Sep 12, 2024
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
104 changes: 65 additions & 39 deletions modules/amxBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@ import { fetch } from '../src/ajax.js';

const BIDDER_CODE = 'amx';
const storage = getStorageManager({ bidderCode: BIDDER_CODE });
const SIMPLE_TLD_TEST = /\.com?\.\w{2,4}$/;
const DEFAULT_ENDPOINT = 'https://prebid.a-mo.net/a/c';
const VERSION = 'pba1.3.4';
const VERSION = 'pba1.4.0';
const VAST_RXP = /^\s*<\??(?:vast|xml)/i;
const TRACKING_BASE = 'https://1x1.a-mo.net/';
const TRACKING_ENDPOINT = TRACKING_BASE + 'hbx/';
Expand Down Expand Up @@ -59,7 +58,7 @@ function flatMap(input, mapFn) {
const isVideoADM = (html) => html != null && VAST_RXP.test(html);

function getMediaType(bid) {
if (isVideoADM(bid.adm)) {
if (isVideoADM(bid.adm) || bid.mtype === 2) {
return VIDEO;
}

Expand All @@ -68,14 +67,6 @@ function getMediaType(bid) {

const nullOrType = (value, type) => value == null || typeof value === type; // eslint-disable-line valid-typeof

function getID(loc) {
const host = loc.hostname.split('.');
const short = host
.slice(host.length - (SIMPLE_TLD_TEST.test(loc.hostname) ? 3 : 2))
.join('.');
return btoa(short).replace(/=+$/, '');
}

const enc = encodeURIComponent;

function getUIDSafe() {
Expand All @@ -94,15 +85,6 @@ function setUIDSafe(uid) {
}
}

function nestedQs(qsData) {
const out = [];
Object.keys(qsData || {}).forEach((key) => {
out.push(enc(key) + '=' + enc(String(qsData[key])));
});

return enc(out.join('&'));
}

function createBidMap(bids) {
const out = {};
_each(bids, (bid) => {
Expand All @@ -111,6 +93,24 @@ function createBidMap(bids) {
return out;
}

function ensureNumber(value, defaultValue) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would this be generaly useful? perhaps import it from somewhere others can access

if (value == null) {
return defaultValue;
}

const valueType = typeof value;
if (valueType === 'number') {
return value;
}

if (valueType !== 'string' || isNaN(value)) {
return defaultValue;
}

const parsed = parseFloat(value);
return isFinite(parsed) ? parsed : defaultValue;
}

const trackEvent = (eventName, data) =>
triggerPixel(
`${TRACKING_ENDPOINT}g_${eventName}?${formatQS({
Expand All @@ -132,7 +132,10 @@ function ensureFloor(floorValue) {

function getFloor(bid) {
if (!isFn(bid.getFloor)) {
return deepAccess(bid, 'params.floor', DEFAULT_MIN_FLOOR);
return ensureNumber(
deepAccess(bid, 'params.floor', DEFAULT_MIN_FLOOR),
DEFAULT_MIN_FLOOR
);
}

try {
Expand All @@ -142,6 +145,7 @@ function getFloor(bid) {
size: '*',
bidRequest: bid,
});

return floor.floor;
} catch (e) {
logError('call to getFloor failed: ', e);
Expand All @@ -161,8 +165,8 @@ function convertRequest(bid) {

const au =
bid.params != null &&
typeof bid.params.adUnitId === 'string' &&
bid.params.adUnitId !== ''
typeof bid.params.adUnitId === 'string' &&
bid.params.adUnitId !== ''
? bid.params.adUnitId
: bid.adUnitCode;

Expand Down Expand Up @@ -240,11 +244,12 @@ function getSyncSettings() {
}

const settings = {
d: syncConfig.syncDelay,
l: syncConfig.syncsPerBidder,
d: ensureNumber(syncConfig.syncDelay),
l: ensureNumber(syncConfig.syncsPerBidder),
t: 0,
e: syncConfig.syncEnabled,
e: isTrue(syncConfig.syncEnabled),
};

const all = isSyncEnabled(syncConfig.filterSettings, 'all');

if (all) {
Expand Down Expand Up @@ -301,6 +306,29 @@ function buildReferrerInfo(bidderRequest) {
const isTrue = (boolValue) =>
boolValue === true || boolValue === 1 || boolValue === 'true';

const NONE = Symbol('None');
const [getConfig, readConfig] = (() => {
let _config = null;
return [
(key, defaultValue = null) => {
_config ??= config.getConfig() ?? {};
const value = deepAccess(_config, key, NONE);
return value === NONE ? defaultValue : value;
},
() => {
_config = null;
},
];
})();

function extractConfig() {
return {
bce: getConfig('useBidCache'),
mbc: getConfig('minBidCacheTTL', -1),
ttl: getConfig('ttlBuffer', 1),
};
}

export const spec = {
code: BIDDER_CODE,
gvlid: 737,
Expand All @@ -314,6 +342,8 @@ export const spec = {
},

buildRequests(bidRequests, bidderRequest) {
readConfig();

const loc = getLocation(bidderRequest);
const tagId = deepAccess(bidRequests[0], 'params.tagId', null);
const testMode = deepAccess(bidRequests[0], 'params.testMode', 0);
Expand All @@ -328,19 +358,15 @@ export const spec = {

const payload = {
a: generateUUID(),
B: 0,
b: loc.host,
brc: fbid.bidderRequestsCount || 0,
bwc: fbid.bidderWinsCount || 0,
trc: fbid.bidRequestsCount || 0,
tm: isTrue(testMode),
V: '$prebid.version$',
vg: '$$PREBID_GLOBAL$$',
i: testMode && tagId != null ? tagId : getID(loc),
l: {},
f: 0.01,
i: testMode && tagId != null ? tagId : null,
cv: VERSION,
st: 'prebid',
h: screen.height,
w: screen.width,
gs: deepAccess(bidderRequest, 'gdprConsent.gdprApplies', ''),
Expand All @@ -351,15 +377,14 @@ export const spec = {
re: refInfo(bidderRequest, 'ref'),
am: getUIDSafe(),
usp: bidderRequest.uspConsent || '1---',
smt: 1,
d: '',
m: createBidMap(bidRequests),
cpp: config.getConfig('coppa') ? 1 : 0,
cpp: getConfig('coppa', false) ? 1 : 0,
fpd2: bidderRequest.ortb2,
tmax: bidderRequest.timeout,
amp: refInfo(bidderRequest, 'isAmp', null),
ri: buildReferrerInfo(bidderRequest),
sync: getSyncSettings(),
conf: extractConfig(),
eids: values(
bidRequests.reduce((all, bid) => {
// we only want unique ones in here
Expand Down Expand Up @@ -418,9 +443,9 @@ export const spec = {
const output = [];
let hasFrame = false;

_each(serverResponses, function({ body: response }) {
_each(serverResponses, function ({ body: response }) {
if (response != null && response.p != null && response.p.hreq) {
_each(response.p.hreq, function(syncPixel) {
_each(response.p.hreq, function (syncPixel) {
const pixelType =
syncPixel.indexOf('__st=iframe') !== -1 ? 'iframe' : 'image';
if (syncOptions.iframeEnabled || pixelType === 'image') {
Expand Down Expand Up @@ -473,7 +498,9 @@ export const spec = {
const { bc: bidderCode, ds: demandSource } = bid.ext ?? {};

return {
...(bidderCode != null && allowAlternateBidderCodes ? { bidderCode } : {}),
...(bidderCode != null && allowAlternateBidderCodes
? { bidderCode }
: {}),
requestId: bidID,
cpm: bid.price,
width: size[0],
Expand Down Expand Up @@ -509,7 +536,6 @@ export const spec = {
np: targetingData.cpm,
aud: targetingData.requestId,
a: targetingData.adUnitCode,
c2: nestedQs(targetingData.adserverTargeting),
cn3: targetingData.timeToRespond,
});
},
Expand Down Expand Up @@ -559,7 +585,7 @@ export const spec = {
body: payload,
keepalive: true,
withCredentials: true,
method: 'POST'
method: 'POST',
}).catch((_e) => {
// do nothing; ignore errors
});
Expand Down
2 changes: 1 addition & 1 deletion modules/amxBidAdapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This module connects web publishers to AMX RTB video and display demand.
| Key | Required | Example | Description |
| --- | -------- | ------- | ----------- |
| `testMode` | no | `true` | this will activate test mode / 100% fill with sample ads |
| `tagId` | no | `"cHJlYmlkLm9yZw"` | can be used for more specific targeting of inventory. Your account manager will provide this ID if needed |
| `tagId` | yes | `"cHJlYmlkLm9yZw"` | can be used for more specific targeting of inventory. Your account manager will provide this ID if needed |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

making this required appears to be breaking?

| `adUnitId` | no | `"sticky_banner"` | optional. To override the bid.adUnitCode provided by prebid. For use in ad-unit level reporting |

# Test Parameters
Expand Down
Loading