/** * Video Impression Verifier interface. All implementations of a Video Impression Verifier must comply with this interface. * @description adds tracking markers to an ad and extracts the bid identifiers from ad event information. * @typedef {Object} VideoImpressionVerifier * @function trackBid - requests that a bid's ad be tracked for impression verification. * @function getBidIdentifiers - requests information from the ad event data that can be used to match the ad to a tracked bid. */ /** * @function VideoImpressionVerifier#trackBid * @param {Object} bid - Bid that should be tracked. * @return {String} - Identifier for the bid being tracked. */ /** * @function VideoImpressionVerifier#getBidIdentifiers * @param {String} adId - In the VAST tag, this value is present in the Ad element's id property. * @param {String} adTagUrl - The ad tag url that was loaded into the player. * @param {[String]} adWrapperIds - List of ad id's that were obtained from the different wrappers. Each redirect points to an ad wrapper. * @return {bidIdentifier} - Object allowing the bid matching the ad event to be identified. */ /** * @typedef {Object} bidIdentifier * @property {String} adId - Bid identifier. * @property {String} adUnitCode - Identifier for the Ad Unit for which the bid was made. * @property {String} auctionId - Id of the auction in which the bid was made. * @property {String} requestId - Id of the bid request which resulted in the bid. */ /** * Factory function for obtaining a Video Impression Verifier. * @param {Boolean} isCacheUsed - wether Prebid is configured to use a cache. * @return {VideoImpressionVerifier} */ export function videoImpressionVerifierFactory(isCacheUsed: boolean): VideoImpressionVerifier; export function videoImpressionVerifier(vastXmlEditor_: any, bidTracker_: any): { trackBid: (bid: any) => string; getBidIdentifiers: (adId: any, adTagUrl: any, adWrapperIds: any) => any; }; export function cachedVideoImpressionVerifier(vastXmlEditor_: any, bidTracker_: any): { trackBid: (bid: any) => string; getBidIdentifiers: (adId: any, adTagUrl: any, adWrapperIds: any) => any; }; export function baseImpressionVerifier(bidTracker_: any): { trackBid: (bid: any) => string; getBidIdentifiers: (adId: any, adTagUrl: any, adWrapperIds: any) => any; }; export function tracker(): { store: (key: any, value: any) => void; remove: (key: any) => any; }; export const PB_PREFIX: "pb_"; export const UUID_MARKER: string; /** * Video Impression Verifier interface. All implementations of a Video Impression Verifier must comply with this interface. */ export type VideoImpressionVerifier = any; export type bidIdentifier = { /** * - Bid identifier. */ adId: string; /** * - Identifier for the Ad Unit for which the bid was made. */ adUnitCode: string; /** * - Id of the auction in which the bid was made. */ auctionId: string; /** * - Id of the bid request which resulted in the bid. */ requestId: string; };