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

Yandex Bid Adapter: add jsdoc #10884

Merged
merged 1 commit into from
Dec 31, 2023
Merged

Yandex Bid Adapter: add jsdoc #10884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
85 changes: 84 additions & 1 deletion modules/yandexBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,55 @@ import { BANNER, NATIVE } from '../src/mediaTypes.js'
import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
import { config } from '../src/config.js';

/**
* @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
* @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
* @typedef {import('../src/adapters/bidderFactory.js').BidderSpec} BidderSpec
* @typedef {import('../src/adapters/bidderFactory.js').ServerRequest} ServerRequest
* @typedef {import('../src/adapters/bidderFactory.js').ServerResponse} ServerResponse
* @typedef {import('../src/adapters/bidderFactory.js').SyncOptions} SyncOptions
* @typedef {import('../src/adapters/bidderFactory.js').UserSync} UserSync
* @typedef {import('../src/auction.js').BidderRequest} BidderRequest
* @typedef {import('../src/mediaTypes.js').MediaType} MediaType
* @typedef {import('../src/utils.js').MediaTypes} MediaTypes
* @typedef {import('../modules/priceFloors.js').getFloor} GetFloor
*/

/**
* @typedef {Object} CustomServerRequestFields
* @property {BidRequest} bidRequest
*/

/**
* @typedef {ServerRequest & CustomServerRequestFields} YandexServerRequest
*/

/**
* Yandex bidder-specific params which the publisher used in their bid request.
*
* @typedef {Object} YandexBidRequestParams
* @property {string} placementId Possible formats: `R-I-123456-2`, `R-123456-1`, `123456-789`.
* @property {number} [pageId] Deprecated. Please use `placementId` instead.
* @property {number} [impId] Deprecated. Please use `placementId` instead.
*/

/**
* @typedef {Object} AdditionalBidRequestFields
* @property {GetFloor} [getFloor]
* @property {MediaTypes} [mediaTypes]
*/

/**
* @typedef {BidRequest & AdditionalBidRequestFields} ExtendedBidRequest
*/

const BIDDER_CODE = 'yandex';
const BIDDER_URL = 'https://bs.yandex.ru/prebid';
const DEFAULT_TTL = 180;
const DEFAULT_CURRENCY = 'EUR';
/**
* @type {MediaType[]}
*/
const SUPPORTED_MEDIA_TYPES = [ BANNER, NATIVE ];
const SSP_ID = 10500;

Expand Down Expand Up @@ -42,11 +87,18 @@ export const NATIVE_ASSETS = {
const NATIVE_ASSETS_IDS = {};
_each(NATIVE_ASSETS, (asset, key) => { NATIVE_ASSETS_IDS[asset[0]] = key });

/** @type BidderSpec */
export const spec = {
code: BIDDER_CODE,
aliases: ['ya'], // short code
supportedMediaTypes: SUPPORTED_MEDIA_TYPES,

/**
* Determines whether or not the given bid request is valid.
*
* @param {BidRequest} bid The bid request to validate.
* @returns {boolean} True if this is a valid bid, and false otherwise.
*/
isBidRequestValid: function(bid) {
const { params } = bid;
if (!params) {
Expand All @@ -59,6 +111,13 @@ export const spec = {
return true;
},

/**
* Make a server request from the list of BidRequests.
*
* @param {ExtendedBidRequest[]} validBidRequests An array of bids.
* @param {BidderRequest} bidderRequest Bidder request object.
* @returns {YandexServerRequest[]} Objects describing the requests to the server.
*/
buildRequests: function(validBidRequests, bidderRequest) {
validBidRequests = convertOrtbRequestToProprietaryNative(validBidRequests);

Expand Down Expand Up @@ -146,7 +205,11 @@ export const spec = {

interpretResponse: interpretResponse,

onBidWon: function (bid) {
/**
* Register bidder specific code, which will execute if a bid from this bidder won the auction.
* @param {Bid} bid The bid that won the auction.
*/
onBidWon: function(bid) {
const nurl = addRTT(bid['nurl'], bid.timeToRespond);

if (!nurl) {
Expand All @@ -157,6 +220,9 @@ export const spec = {
}
}

/**
* @param {YandexBidRequestParams} bidRequestParams
*/
function extractPlacementIds(bidRequestParams) {
const { placementId } = bidRequestParams;
const result = { pageId: null, impId: null };
Expand Down Expand Up @@ -191,6 +257,9 @@ function extractPlacementIds(bidRequestParams) {
return result;
}

/**
* @param {ExtendedBidRequest} bidRequest
*/
function getBidfloor(bidRequest) {
const floors = [];

Expand All @@ -210,6 +279,9 @@ function getBidfloor(bidRequest) {
return floors.sort((a, b) => b.floor - a.floor)[0];
}

/**
* @param {ExtendedBidRequest} bidRequest
*/
function mapBanner(bidRequest) {
if (deepAccess(bidRequest, 'mediaTypes.banner')) {
const sizes = bidRequest.sizes || bidRequest.mediaTypes.banner.sizes;
Expand All @@ -227,6 +299,9 @@ function mapBanner(bidRequest) {
}
}

/**
* @param {ExtendedBidRequest} bidRequest
*/
function mapNative(bidRequest) {
const adUnitNativeAssets = deepAccess(bidRequest, 'mediaTypes.native');
if (adUnitNativeAssets) {
Expand Down Expand Up @@ -299,6 +374,13 @@ function mapImageAsset(adUnitImageAssetParams, nativeAssetType) {
return img;
}

/**
* Unpack the response from the server into a list of bids.
*
* @param {ServerResponse} serverResponse A successful response from the server.
* @param {YandexServerRequest} yandexServerRequest
* @return {Bid[]} An array of bids which were nested inside the server.
*/
function interpretResponse(serverResponse, { bidRequest }) {
let response = serverResponse.body;
if (!response.seatbid) {
Expand All @@ -313,6 +395,7 @@ function interpretResponse(serverResponse, { bidRequest }) {

return bidsReceived.map(bidReceived => {
const price = bidReceived.price;
/** @type {Bid} */
let prBid = {
requestId: bidRequest.bidId,
cpm: price,
Expand Down