prebid.js 7.25.0 → 7.27.0

package/modules/nexx360BidAdapter.js

@@ -1,176 +1,302 @@
-import {ajax} from '../src/ajax.js';
 import {config} from '../src/config.js';
-import { transformBidderParamKeywords } from '../src/utils.js';
+import * as utils from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from '../src/mediaTypes.js';
+import {getGlobal} from '../src/prebidGlobal.js';
 
+const VIDEO_TARGETING = ['startdelay', 'mimes', 'minduration', 'maxduration', 'delivery',
+  'startdelay', 'skip', 'playbackmethod', 'api', 'protocol', 'boxingallowed', 'maxextended',
+  'linearity', 'delivery', 'protocols', 'placement', 'minbitrate', 'maxbitrate', 'battr', 'ext'];
 const BIDDER_CODE = 'nexx360';
-const BIDDER_URL = 'https://fast.nexx360.io/prebid';
-const CACHE_URL = 'https://fast.nexx360.io/cache';
-const METRICS_TRACKER_URL = 'https://fast.nexx360.io/track-imp';
+const REQUEST_URL = 'https://fast.nexx360.io/booster';
+
+const PAGE_VIEW_ID = utils.generateUUID();
+
+const BIDDER_VERSION = '1.0';
 
 const GVLID = 965;
 
 export const spec = {
   code: BIDDER_CODE,
   gvlid: GVLID,
-  aliases: ['revenuemaker'], // short code
+  aliases: [
+    { code: 'revenuemaker' },
+    { code: 'firstid-ssp' },
+  ],
   supportedMediaTypes: [BANNER, VIDEO],
-  /**
+  isBidRequestValid,
+  buildRequests,
+  interpretResponse,
+  getUserSyncs,
+  // onBidWon,
+};
+
+registerBidder(spec);
+
+/**
          * Determines whether or not the given bid request is valid.
          *
          * @param {BidRequest} bid The bid params to validate.
          * @return boolean True if this is a valid bid, and false otherwise.
          */
-  isBidRequestValid: function(bid) {
-    if (!!bid.params.bidfloorCurrency && !['EUR', 'USD'].includes(bid.params.bidfloorCurrency)) return false;
-    if (!!bid.params.bidfloor && typeof bid.params.bidfloor !== 'number') return false;
-    if (!!bid.params.keywords && typeof bid.params.keywords !== 'object') return false;
-    return !!(bid.params.account && bid.params.tagId);
-  },
-  /**
+function isBidRequestValid(bid) {
+  return !!bid.params.tagId || !!bid.params.videoTagId;
+};
+
+/**
          * Make a server request from the list of BidRequests.
          *
          * @param {validBidRequests[]} - an array of bids
          * @return ServerRequest Info describing the request to the server.
          */
-  buildRequests: function(validBidRequests, bidderRequest) {
-    const adUnits = [];
-    const test = config.getConfig('debug') ? 1 : 0;
-    let adunitValue = null;
-    let userEids = null;
-    Object.keys(validBidRequests).forEach(key => {
-      adunitValue = validBidRequests[key];
-      const foo = {
-        account: adunitValue.params.account,
-        tagId: adunitValue.params.tagId,
-        videoExt: adunitValue.params.videoExt,
-        label: adunitValue.adUnitCode,
-        bidId: adunitValue.bidId,
-        auctionId: adunitValue.auctionId,
-        transactionId: adunitValue.transactionId,
-        mediatypes: adunitValue.mediaTypes,
-        bidfloor: adunitValue.params.bidfloor || 0,
-        bidfloorCurrency: adunitValue.params.bidfloorCurrency || 'USD',
-        keywords: adunitValue.params.keywords ? transformBidderParamKeywords(adunitValue.params.keywords) : [],
+
+function buildRequests(bids, bidderRequest) {
+  const data = getBaseRequest(bids[0], bidderRequest);
+  bids.forEach((bid) => {
+    const impObject = createImpObject(bid);
+    if (isBannerBid(bid)) impObject.banner = getBannerObject(bid);
+    if (isVideoBid(bid)) impObject.video = getVideoObject(bid);
+    data.imp.push(impObject);
+  });
+  return {
+    method: 'POST',
+    url: REQUEST_URL,
+    data,
+  }
+}
+
+function createImpObject(bid) {
+  const floor = getFloor(bid, BANNER);
+  const imp = {
+    id: bid.bidId,
+    tagid: bid.adUnitCode,
+    ext: {
+      divId: bid.adUnitCode,
+      nexx360: {
+        videoTagId: bid.params.videoTagId,
+        tagId: bid.params.tagId,
+        allBids: bid.params.allBids === true,
       }
-      adUnits.push(foo);
-      if (adunitValue.userIdAsEids) userEids = adunitValue.userIdAsEids;
+    }
+  };
+  if (bid.params.customParams) {
+    utils.deepSetValue(imp, 'ext.customParams', bid.params.customParams);
+  }
+  enrichImp(imp, bid, floor);
+  return imp;
+}
+
+function getBannerObject(bid) {
+  return {
+    format: toFormat(bid.mediaTypes.banner.sizes),
+    topframe: utils.inIframe() ? 0 : 1
+  };
+}
+
+function getVideoObject(bid) {
+  let width, height;
+  const videoParams = utils.deepAccess(bid, `mediaTypes.video`);
+  const playerSize = utils.deepAccess(bid, 'mediaTypes.video.playerSize');
+  const context = utils.deepAccess(bid, 'mediaTypes.video.context');
+  // normalize config for video size
+  if (utils.isArray(bid.sizes) && bid.sizes.length === 2 && !utils.isArray(bid.sizes[0])) {
+    width = parseInt(bid.sizes[0], 10);
+    height = parseInt(bid.sizes[1], 10);
+  } else if (utils.isArray(bid.sizes) && utils.isArray(bid.sizes[0]) && bid.sizes[0].length === 2) {
+    width = parseInt(bid.sizes[0][0], 10);
+    height = parseInt(bid.sizes[0][1], 10);
+  } else if (utils.isArray(playerSize) && playerSize.length === 2) {
+    width = parseInt(playerSize[0], 10);
+    height = parseInt(playerSize[1], 10);
+  }
+  const video = {
+    playerSize: [height, width],
+    context,
+  };
+
+  Object.keys(videoParams)
+    .filter(param => VIDEO_TARGETING.includes(param))
+    .forEach(param => video[param] = videoParams[param]);
+  return video;
+}
+
+function isVideoBid(bid) {
+  return utils.deepAccess(bid, 'mediaTypes.video');
+}
+
+function isBannerBid(bid) {
+  return utils.deepAccess(bid, 'mediaTypes.banner') || !isVideoBid(bid);
+}
+
+function toFormat(sizes) {
+  return sizes.map((s) => {
+    return { w: s[0], h: s[1] };
+  });
+}
+
+function getFloor(bid, mediaType) {
+  let floor = 0;
+  if (typeof bid.getFloor === 'function') {
+    const floorInfo = bid.getFloor({
+      currency: 'USD',
+      mediaType: mediaType,
+      size: '*'
     });
-    const payload = {
-      adUnits,
-      // TODO: does the fallback make sense here?
-      href: encodeURIComponent(bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation)
-    };
-    if (bidderRequest) { // modules informations (gdpr, ccpa, schain, userId)
-      if (bidderRequest.gdprConsent) {
-        payload.gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
-        payload.gdprConsent = bidderRequest.gdprConsent.consentString;
-      } else {
-        payload.gdpr = 0;
-        payload.gdprConsent = '';
-      }
-      if (bidderRequest.uspConsent) { payload.uspConsent = bidderRequest.uspConsent; }
-      if (bidderRequest.schain) { payload.schain = bidderRequest.schain; }
-      if (userEids !== null) payload.userEids = userEids;
-    };
-    if (test) payload.test = 1;
-    const payloadString = JSON.stringify(payload);
-    return {
-      method: 'POST',
-      url: BIDDER_URL,
-      data: payloadString,
-    };
-  },
-  /**
+
+    if (typeof floorInfo === 'object' &&
+      floorInfo.currency === 'USD' &&
+      !isNaN(parseFloat(floorInfo.floor))) {
+      floor = Math.max(floor, parseFloat(floorInfo.floor));
+    }
+  }
+
+  return floor;
+}
+
+function enrichImp(imp, bid, floor) {
+  if (bid.params.customParams) {
+    utils.deepSetValue(imp, 'ext.customParams', bid.params.customParams);
+  }
+  if (floor > 0) {
+    imp.bidfloor = floor;
+    imp.bidfloorcur = 'USD';
+  } else if (bid.params.customFloor) {
+    imp.bidfloor = bid.params.customFloor;
+  }
+  if (bid.ortb2Imp && bid.ortb2Imp.ext && bid.ortb2Imp.ext.data) {
+    imp.ext.data = bid.ortb2Imp.ext.data;
+  }
+}
+
+function getBaseRequest(bid, bidderRequest) {
+  let req = {
+    id: bidderRequest.auctionId,
+    imp: [],
+    cur: [config.getConfig('currency.adServerCurrency') || 'USD'],
+    at: 1,
+    tmax: config.getConfig('bidderTimeout'),
+    site: {
+      page: bidderRequest.refererInfo.topmostLocation || bidderRequest.refererInfo.page,
+      domain: bidderRequest.refererInfo.domain,
+    },
+    regs: {
+      coppa: (config.getConfig('coppa') === true || bid.params.coppa) ? 1 : 0,
+    },
+    device: {
+      dnt: (utils.getDNT() || bid.params.doNotTrack) ? 1 : 0,
+      h: screen.height,
+      w: screen.width,
+      ua: window.navigator.userAgent,
+      language: window.navigator.language.split('-').shift()
+    },
+    user: {},
+    ext: {
+      source: 'prebid.js',
+      version: '$prebid.version$',
+      pageViewId: PAGE_VIEW_ID,
+      bidderVersion: BIDDER_VERSION,
+    }
+  };
+
+  if (bid.params.platform) {
+    utils.deepSetValue(req, 'ext.platform', bid.params.platform);
+  }
+  if (bid.params.response_template_name) {
+    utils.deepSetValue(req, 'ext.response_template_name', bid.params.response_template_name);
+  }
+  req.test = config.getConfig('debug') ? 1 : 0;
+  if (bidderRequest.gdprConsent) {
+    if (bidderRequest.gdprConsent.gdprApplies !== undefined) {
+      utils.deepSetValue(req, 'regs.ext.gdpr', bidderRequest.gdprConsent.gdprApplies === true ? 1 : 0);
+    }
+    if (bidderRequest.gdprConsent.consentString !== undefined) {
+      utils.deepSetValue(req, 'user.ext.consent', bidderRequest.gdprConsent.consentString);
+    }
+    if (bidderRequest.gdprConsent.addtlConsent !== undefined) {
+      utils.deepSetValue(req, 'user.ext.ConsentedProvidersSettings.consented_providers', bidderRequest.gdprConsent.addtlConsent);
+    }
+  }
+  if (bidderRequest.uspConsent) {
+    utils.deepSetValue(req, 'regs.ext.us_privacy', bidderRequest.uspConsent);
+  }
+  if (bid.schain) {
+    utils.deepSetValue(req, 'source.ext.schain', bid.schain);
+  }
+  if (bid.userIdAsEids) {
+    utils.deepSetValue(req, 'user.ext.eids', bid.userIdAsEids);
+  }
+  const commonFpd = bidderRequest.ortb2 || {};
+  if (commonFpd.site) {
+    utils.mergeDeep(req, {site: commonFpd.site});
+  }
+  if (commonFpd.user) {
+    utils.mergeDeep(req, {user: commonFpd.user});
+  }
+  return req;
+}
+
+/**
          * 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.
          */
-  interpretResponse: function(serverResponse, bidRequest) {
-    const serverBody = serverResponse.body;
-    const bidResponses = [];
-    let bidResponse = null;
-    let value = null;
-    if (serverBody.hasOwnProperty('responses')) {
-      Object.keys(serverBody['responses']).forEach(key => {
-        value = serverBody['responses'][key];
-        const url = `${CACHE_URL}?uuid=${value['uuid']}`;
-        bidResponse = {
-          requestId: value['bidId'],
-          cpm: value['cpm'],
-          currency: value['currency'],
-          width: value['width'],
-          height: value['height'],
-          ttl: value['ttl'],
-          creativeId: value['creativeId'],
-          netRevenue: true,
-          nexx360: {
-            'ssp': value['bidder'],
-            'consent': value['consent'],
-            'tagId': value['tagId']
-          },
-          /*
-          meta: {
-            'advertiserDomains': value['adomain']
-          }
-          */
-        };
-        if (value.type === 'banner') bidResponse.adUrl = url;
-        if (value.type === 'video') {
-          const params = {
-            type: 'prebid',
-            mediatype: 'video',
-            ssp: value.bidder,
-            tag_id: value.tagId,
-            consent: value.consent,
-            price: value.cpm,
-          };
-          bidResponse.cpm = value.cpm;
-          bidResponse.mediaType = 'video';
-          bidResponse.vastUrl = url;
-          bidResponse.vastImpUrl = `${METRICS_TRACKER_URL}?${new URLSearchParams(params).toString()}`;
-        }
-        bidResponses.push(bidResponse);
-      });
-    }
-    return bidResponses;
-  },
+function interpretResponse(response, req) {
+  const { bidderSettings } = getGlobal();
+  const allowAlternateBidderCodes = bidderSettings && bidderSettings.standard ? bidderSettings.standard.allowAlternateBidderCodes : false;
+  const respBody = response.body;
+  if (!respBody || !Array.isArray(respBody.seatbid)) {
+    return [];
+  }
+
+  let bids = [];
+  respBody.seatbid.forEach(seatbid => {
+    bids = [...bids, ...seatbid.bid.map(bid => {
+      const response = {
+        requestId: bid.impid,
+        cpm: bid.price,
+        width: bid.w,
+        height: bid.h,
+        creativeId: bid.crid,
+        dealId: bid.dealid,
+        currency: respBody.cur || 'USD',
+        netRevenue: true,
+        ttl: 120,
+        bidderCode: allowAlternateBidderCodes ? `n360-${bid.ssp}` : 'nexx360',
+        mediaType: bid.type === 'banner' ? 'banner' : 'video',
+        meta: { advertiserDomains: bid.adomain },
+      };
+      // if (bid.dealid) response.dealid = bid.dealid;
 
-  /**
+      if (response.mediaType === 'banner') {
+        response.adUrl = bid.adUrl;
+      }
+
+      if (['instream', 'outstream'].includes(bid.type)) response.vastXml = bid.vastXml;
+
+      if (bid.ext) {
+        response.meta.networkId = bid.ext.dsp_id;
+        response.meta.advertiserId = bid.ext.buyer_id;
+        response.meta.brandId = bid.ext.brand_id;
+      }
+      return response;
+    })];
+  });
+  return bids;
+}
+
+/**
      * Register the user sync pixels which should be dropped after the auction.
      *
      * @param {SyncOptions} syncOptions Which user syncs are allowed?
      * @param {ServerResponse[]} serverResponses List of server's responses.
      * @return {UserSync[]} The user syncs which should be dropped.
      */
-  getUserSyncs: function(syncOptions, serverResponses, gdprConsent, uspConsent) {
-    if (typeof serverResponses === 'object' && serverResponses != null && serverResponses.length > 0 && serverResponses[0].hasOwnProperty('body') &&
+function getUserSyncs(syncOptions, serverResponses, gdprConsent, uspConsent) {
+  if (typeof serverResponses === 'object' && serverResponses != null && serverResponses.length > 0 && serverResponses[0].hasOwnProperty('body') &&
         serverResponses[0].body.hasOwnProperty('cookies') && typeof serverResponses[0].body.cookies === 'object') {
-      return serverResponses[0].body.cookies.slice(0, 5);
-    } else {
-      return [];
-    }
-  },
-
-  /**
-     * Register bidder specific code, which will execute if a bid from this bidder won the auction
-     * @param {Bid} The bid that won the auction
-     */
-  onBidWon: function(bid) {
-    // fires a pixel to confirm a winning bid
-    const params = { type: 'prebid', mediatype: 'banner' };
-    if (bid.hasOwnProperty('nexx360')) {
-      if (bid.nexx360.hasOwnProperty('ssp')) params.ssp = bid.nexx360.ssp;
-      if (bid.nexx360.hasOwnProperty('tagId')) params.tag_id = bid.nexx360.tagId;
-      if (bid.nexx360.hasOwnProperty('consent')) params.consent = bid.nexx360.consent;
-    };
-    params.price = bid.cpm;
-    const url = `${METRICS_TRACKER_URL}?${new URLSearchParams(params).toString()}`;
-    ajax(url, null, undefined, {method: 'GET', withCredentials: true});
-    return true;
+    return serverResponses[0].body.cookies.slice(0, 5);
+  } else {
+    return [];
   }
-
-}
-registerBidder(spec);
+};

package/modules/pubCommonId.js

@@ -9,8 +9,9 @@ import * as events from '../src/events.js';
 import CONSTANTS from '../src/constants.json';
 import { getStorageManager } from '../src/storageManager.js';
 import {timedAuctionHook} from '../src/utils/perfMetrics.js';
+import {VENDORLESS_GVLID} from '../src/consentHandler.js';
 
-const storage = getStorageManager({moduleName: 'pubCommonId'});
+const storage = getStorageManager({moduleName: 'pubCommonId', gvlid: VENDORLESS_GVLID});
 
 const ID_NAME = '_pubcid';
 const OPTOUT_NAME = '_pubcid_optout';

package/modules/pubProvidedIdSystem.js

@@ -7,6 +7,7 @@
 
 import {submodule} from '../src/hook.js';
 import { logInfo, isArray } from '../src/utils.js';
+import {VENDORLESS_GVLID} from '../src/consentHandler.js';
 
 const MODULE_NAME = 'pubProvidedId';
 
@@ -18,6 +19,7 @@ export const pubProvidedIdSubmodule = {
    * @type {string}
    */
   name: MODULE_NAME,
+  gvlid: VENDORLESS_GVLID,
 
   /**
    * decode the stored id value for passing to bid request

package/modules/rasBidAdapter.js

@@ -1,4 +1,3 @@
-import * as utils from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER } from '../src/mediaTypes.js';
 import { isEmpty, getAdUnitSizes, parseSizesInput, deepAccess } from '../src/utils.js';
@@ -12,9 +11,15 @@ const getEndpoint = (network) => {
 
 function parseParams(params, bidderRequest) {
   const newParams = {};
+  if (params.customParams && typeof params.customParams === 'object') {
+    for (const param in params.customParams) {
+      if (params.customParams.hasOwnProperty(param)) {
+        newParams[param] = params.customParams[param];
+      }
+    }
+  }
   const du = deepAccess(bidderRequest, 'refererInfo.page');
   const dr = deepAccess(bidderRequest, 'refererInfo.ref');
-
   if (du) {
     newParams.du = du;
   }
@@ -93,7 +98,7 @@ const getSlots = (bidRequests) => {
   const batchSize = bidRequests.length;
   for (let i = 0; i < batchSize; i++) {
     const adunit = bidRequests[i];
-    const slotSequence = utils.deepAccess(adunit, 'params.slotSequence');
+    const slotSequence = deepAccess(adunit, 'params.slotSequence');
 
     const sizes = parseSizesInput(getAdUnitSizes(adunit)).join(',');
 

package/modules/rasBidAdapter.md

@@ -34,18 +34,19 @@ var adUnits = [{
 
 # Parameters
 
-| Name | Scope | Type | Description                                                                                                                                                                                                                                                               | Example
-| --- | --- | --- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ---
-| network | required | String | Specific identifier provided by RAS                                                                                                                                                                                                                                       | `"4178463"`
-| site | required | String | Specific identifier name (case-insensitive) that is associated with this ad unit and provided by RAS                                                                                                                                                                      | `"example_com"`
-| area | required | String | Ad unit category name; only case-insensitive alphanumeric with underscores and hyphens are allowed                                                                                                                                                                        | `"sport"`
-| slot | required | String | Ad unit placement name (case-insensitive) provided by RAS                                                                                                                                                                                                                 | `"slot"`
-| slotSequence  | optional | Number | Ad unit sequence position provided by RAS                                                                                                                                                                                                                            | `1`
-| pageContext | optional | Object | Web page context data                                                                                                                                                                                                                                                     | `{}`
-| pageContext.dr | optional | String | Document referrer URL address                                                                                                                                                                                                                                             | `"https://example.com/"`
-| pageContext.du | optional | String | Document URL address                                                                                                                                                                                                                                                      | `"https://example.com/sport/football/article.html?id=932016a5-02fc-4d5c-b643-fafc2f270f06"`
-| pageContext.dv | optional | String | Document virtual address as slash-separated path that may consist of any number of parts (case-insensitive alphanumeric with underscores and hyphens); first part should be the same as `site` value and second as `area` value; next parts may reflect website navigation | `"example_com/sport/football"`
-| pageContext.keyWords | optional | String[] | List of keywords associated with this ad unit; only case-insensitive alphanumeric with underscores and hyphens are allowed                                                                                                                                                | `["euro", "lewandowski"]`
-| pageContext.keyValues | optional | Object | Key-values associated with this ad unit (case-insensitive); following characters are not allowed in the values: `" ' = ! + # * ~ ; ^ ( ) < > [ ] & @`                                                                                                                     | `{}`
-| pageContext.keyValues.ci | optional | String | Content unique identifier                                                                                                                                                                                                                                                 | `"932016a5-02fc-4d5c-b643-fafc2f270f06"`
-| pageContext.keyValues.adunit | optional | String | Ad unit name                                                                                                                                                                                                                                                              | `"example_com/sport"`
+| Name                         | Scope    | Type     | Description                                                                                                                                                                                                                                                                | Example                                                                                     |
+|------------------------------|----------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
+| network                      | required | String   | Specific identifier provided by RAS                                                                                                                                                                                                                                        | `"4178463"`                                                                                 |
+| site                         | required | String   | Specific identifier name (case-insensitive) that is associated with this ad unit and provided by RAS                                                                                                                                                                       | `"example_com"`                                                                             |
+| area                         | required | String   | Ad unit category name; only case-insensitive alphanumeric with underscores and hyphens are allowed                                                                                                                                                                         | `"sport"`                                                                                   |
+| slot                         | required | String   | Ad unit placement name (case-insensitive) provided by RAS                                                                                                                                                                                                                  | `"slot"`                                                                                    |
+| slotSequence                 | optional | Number   | Ad unit sequence position provided by RAS                                                                                                                                                                                                                                  | `1`                                                                                         |
+| pageContext                  | optional | Object   | Web page context data                                                                                                                                                                                                                                                      | `{}`                                                                                        |
+| pageContext.dr               | optional | String   | Document referrer URL address                                                                                                                                                                                                                                              | `"https://example.com/"`                                                                    |
+| pageContext.du               | optional | String   | Document URL address                                                                                                                                                                                                                                                       | `"https://example.com/sport/football/article.html?id=932016a5-02fc-4d5c-b643-fafc2f270f06"` |
+| pageContext.dv               | optional | String   | Document virtual address as slash-separated path that may consist of any number of parts (case-insensitive alphanumeric with underscores and hyphens); first part should be the same as `site` value and second as `area` value; next parts may reflect website navigation | `"example_com/sport/football"`                                                              |
+| pageContext.keyWords         | optional | String[] | List of keywords associated with this ad unit; only case-insensitive alphanumeric with underscores and hyphens are allowed                                                                                                                                                 | `["euro", "lewandowski"]`                                                                   |
+| pageContext.keyValues        | optional | Object   | Key-values associated with this ad unit (case-insensitive); following characters are not allowed in the values: `" ' = ! + # * ~ ; ^ ( ) < > [ ] & @`                                                                                                                      | `{}`                                                                                        |
+| pageContext.keyValues.ci     | optional | String   | Content unique identifier                                                                                                                                                                                                                                                  | `"932016a5-02fc-4d5c-b643-fafc2f270f06"`                                                    |
+| pageContext.keyValues.adunit | optional | String   | Ad unit name                                                                                                                                                                                                                                                               | `"example_com/sport"`                                                                       |
+| customParams                 | optional | Object   | Custom request params                                                                                                                                                                                                                                                      | `{}`                                                                                        |