@google-psat/common 0.14.1 → 1.2.1

package/dist-types/prebidGlobal.types.d.ts

@@ -0,0 +1,674 @@
+export interface AdUnit {
+    code: string;
+    mediaTypes?: {
+        banner?: {
+            sizes: Array<[number, number]>;
+        };
+        video?: {
+            context: 'instream' | 'outstream';
+            playerSize: Array<[number, number]>;
+        };
+        native?: {
+            adTemplate?: string;
+            rendererUrl?: string;
+            ortb?: object;
+        };
+    };
+    bids: Bid[];
+    sizes?: number[][];
+    ortb2Imp?: object;
+    labelAny?: string[];
+    labelAll?: string[];
+}
+export interface Bid {
+    bidder: string;
+    params: Record<string, any>;
+    labelAny?: string[];
+    labelAll?: string[];
+}
+export interface NoBid {
+    bidder: string;
+    bidderCode: string;
+    adUnitCode: string;
+    auctionId: string;
+    bidId: string;
+    bidderRequestId: string;
+    src?: string;
+    params?: Record<string, any>;
+    mediaTypes?: {
+        banner?: {
+            sizes: Array<[number, number]>;
+        };
+        video?: {
+            context: 'instream' | 'outstream';
+            playerSize: Array<[number, number]>;
+        };
+        native?: object;
+    };
+    status?: string;
+    sizes?: number[][];
+    responseTimestamp?: number;
+    requestTimestamp?: number;
+    timeToRespond?: number;
+}
+export interface BeforeBidderHttpEvent {
+    bidder: string;
+    adUnitCode: string;
+    bidId: string;
+    auctionId: string;
+    bidderRequestId: string;
+    src?: string;
+    params?: Record<string, any>;
+    mediaTypes?: {
+        banner?: {
+            sizes: Array<[number, number]>;
+        };
+        video?: {
+            context: 'instream' | 'outstream';
+            playerSize: Array<[number, number]>;
+        };
+        native?: object;
+    };
+    ortb2Imp?: object;
+    transactionId?: string;
+    sizes?: Array<[number, number]>;
+}
+export interface BidRequestedEvent {
+    bidder: string;
+    auctionId: string;
+    bidderRequestId: string;
+    bidderCode: string;
+    serverResponseTimeMs?: number;
+    bids: Array<{
+        adUnitCode: string;
+        bidId: string;
+        bidder: string;
+        auctionId: string;
+        bidderRequestId: string;
+        params?: Record<string, any>;
+        mediaTypes?: {
+            banner?: {
+                sizes: Array<[number, number]>;
+            };
+            video?: {
+                context: 'instream' | 'outstream';
+                playerSize: Array<[number, number]>;
+            };
+            native?: object;
+        };
+        ortb2Imp?: object;
+        transactionId?: string;
+        sizes?: Array<[number, number]>;
+    }>;
+    start: number;
+    timeout: number;
+    refererInfo?: {
+        referer: string;
+        reachedTop: boolean;
+        numIframes: number;
+        stack: string[];
+    };
+    src?: string;
+    tags?: any[];
+}
+export interface BidWonEvent {
+    adUnitCode: string;
+    requestId: string;
+    cpm: number;
+    currency: string;
+    creativeId: string;
+    dealId?: string;
+    width: number;
+    height: number;
+    ad?: string;
+    adUrl?: string;
+    vastUrl?: string;
+    vastXml?: string;
+    ttl: number;
+    netRevenue: boolean;
+    bidder: string;
+    timeToRespond: number;
+    auctionId: string;
+    responseTimestamp?: number;
+    requestTimestamp?: number;
+    status?: string;
+    adserverTargeting?: Record<string, string>;
+    meta?: {
+        advertiserDomains?: string[];
+        [key: string]: any;
+    };
+    mediaType?: 'banner' | 'video' | 'native';
+    renderer?: any;
+    native?: any;
+}
+export interface AuctionInitEvent {
+    auctionId: string;
+    timestamp: number;
+    timeout: number;
+    adUnits: AdUnit[];
+    auctionStatus: 'inProgress' | 'completed';
+    labels?: string[];
+}
+export interface PrebidEventDataMap {
+    auctionInit: AuctionInitEvent;
+    auctionEnd: AuctionEndEvent;
+    bidRequested: BidRequestedEvent;
+    bidResponse: BidResponse;
+    bidWon: BidWonEvent;
+    bidTimeout: BidTimeoutEvent[];
+    bidRejected: BidRejectedEvent;
+    bidderDone: BidderDoneEvent;
+    noBid: NoBid;
+    bidAccepted: BidAcceptedEvent;
+    beforeRequestBids: BeforeRequestBidsEvent;
+    beforeBidderHttp: BeforeBidderHttpEvent;
+    auctionDebug: AuctionDebugEvent;
+    addAdUnits: Record<string, never>;
+}
+export interface BidderDoneEvent {
+    bidderCode: string;
+    serverResponseTimeMs?: number;
+    timeToRespond: number;
+    bids?: BidResponse[];
+}
+export interface BidTimeoutEvent {
+    bidId: string;
+    bidder: string;
+    adUnitCode: string;
+    auctionId: string;
+    bidderRequestId: string;
+    timeout: number;
+    params?: Record<string, any>;
+}
+export interface BidRejectedEvent {
+    adUnitCode: string;
+    bidder: string;
+    reason: string;
+    bid: Partial<BidResponse>;
+}
+export interface BidAcceptedEvent {
+    adUnitCode: string;
+    requestId: string;
+    cpm: number;
+    currency: string;
+    creativeId: string;
+    dealId?: string;
+    width: number;
+    height: number;
+    ad?: string;
+    adUrl?: string;
+    vastUrl?: string;
+    vastXml?: string;
+    ttl: number;
+    netRevenue: boolean;
+    bidder: string;
+    timeToRespond: number;
+    auctionId: string;
+    responseTimestamp?: number;
+    requestTimestamp?: number;
+    adserverTargeting?: Record<string, string>;
+    meta?: {
+        advertiserDomains?: string[];
+        mediaType?: string;
+        secondaryCatIds?: string[];
+        networkId?: string;
+        agencyId?: string;
+    };
+    mediaType?: 'banner' | 'video' | 'native';
+    renderer?: any;
+    native?: any;
+    status?: string;
+}
+export interface BeforeRequestBidsEvent {
+    timeout: number;
+    adUnits: AdUnit[];
+    labels?: string[];
+    auctionId: string;
+    start?: number;
+}
+export interface AuctionEndEvent {
+    auctionId: string;
+    timestamp: number;
+    timeout: number;
+    adUnits: AdUnit[];
+    bidderRequests: BidRequestedEvent[];
+    bidsReceived: BidResponse[];
+    winningBids: BidWonEvent[];
+    noBids: NoBid[];
+    auctionEnd: number;
+    adUnitCodes: string[];
+}
+export type PrebidEvent = 'auctionInit' | 'auctionEnd' | 'auctionDebug' | 'bidRequested' | 'beforeBidderHttp' | 'bidAccepted' | 'bidResponse' | 'bidWon' | 'bidTimeout' | 'bidRejected' | 'bidderDone' | 'noBid' | 'beforeRequestBids' | 'addAdUnits';
+export interface BidResponse {
+    requestId: string;
+    cpm: number;
+    currency: string;
+    width: number;
+    height: number;
+    ad?: string;
+    adUrl?: string;
+    vastUrl?: string;
+    vastXml?: string;
+    ttl: number;
+    creativeId: string;
+    netRevenue: boolean;
+    bidder: string;
+    bidderCode: string;
+    adUnitCode: string;
+    auctionId: string;
+    bidderRequestId: string;
+    price: number;
+    dealId?: string;
+    mediaType?: 'banner' | 'video' | 'native';
+    meta?: {
+        advertiserDomains?: string[];
+        advertiserId?: string;
+        advertiserName?: string;
+        agencyId?: string;
+        agencyName?: string;
+        brandId?: string;
+        brandName?: string;
+        dchain?: object;
+    };
+    adserverTargeting?: Record<string, string>;
+    status?: 'targetingSet' | 'rendered' | string;
+    statusMessage?: string;
+    pbLg?: string;
+    pbMg?: string;
+    pbHg?: string;
+    pbAg?: string;
+    pbDg?: string;
+    pbCg?: string;
+    size?: string;
+    timeToRespond?: number;
+    responseTimestamp?: number;
+    requestTimestamp?: number;
+    renderer?: any;
+    native?: {
+        title?: string;
+        body?: string;
+        image?: {
+            url: string;
+            height: number;
+            width: number;
+        };
+        icon?: {
+            url: string;
+            height: number;
+            width: number;
+        };
+        clickUrl?: string;
+        clickTrackers?: string[];
+        impressionTrackers?: string[];
+        [key: string]: any;
+    };
+}
+export type AuctionDebugEventType = 'INFO' | 'WARNING' | 'ERROR';
+export interface EID {
+    source: string;
+    uids: UID[];
+}
+export interface UID {
+    id: string;
+    atype: number;
+    ext?: Record<string, any>;
+}
+export interface UserIdConfig {
+    name: string;
+    storage?: {
+        type: 'cookie' | 'html5';
+        name: string;
+        expires?: number;
+        refreshInSeconds?: number;
+    };
+    params?: Record<string, any>;
+    value?: any;
+    bidders?: string[];
+}
+export interface AuctionDebugEvent {
+    type: AuctionDebugEventType;
+    arguments: string[];
+}
+export interface PrebidConfig {
+    debug?: boolean;
+    bidderTimeout?: number;
+    enableSendAllBids?: boolean;
+    bidderSequence?: string;
+    useBidCache?: boolean;
+    eids?: EID[];
+    priceGranularity?: 'low' | 'medium' | 'high' | 'auto' | 'dense' | 'custom';
+    currency?: {
+        adServerCurrency: string;
+        granularityMultiplier?: number;
+        defaultRates?: Record<string, number>;
+        conversionRateFile?: string;
+        rates?: Record<string, number>;
+    };
+    consentManagement?: {
+        gdpr?: {
+            cmpApi: 'iab' | 'static' | 'iabnonsupport' | 'none';
+            timeout?: number;
+            allowAuctionWithoutConsent?: boolean;
+            defaultGdprScope?: boolean;
+        };
+        usp?: {
+            cmpApi: 'iab' | 'static' | 'none';
+            timeout?: number;
+        };
+    };
+    userSync?: {
+        userIds?: UserIdConfig[];
+        syncEnabled?: boolean;
+        filterSettings?: {
+            all?: {
+                bidders?: string[];
+                filter?: 'include' | 'exclude';
+            };
+            iframe?: {
+                bidders?: string[];
+                filter?: 'include' | 'exclude';
+            };
+            image?: {
+                bidders?: string[];
+                filter?: 'include' | 'exclude';
+            };
+        };
+        syncsPerBidder?: number;
+        syncDelay?: number;
+        auctionDelay?: number;
+        enableOverride?: boolean;
+    };
+    cache?: {
+        url?: string;
+        vasturl?: string;
+        ignoreBidderCacheKey?: boolean;
+    };
+    targetingControls?: {
+        alwaysIncludeDeals?: boolean;
+        appendBidderNames?: boolean;
+        includeWinners?: boolean;
+        includeBidderKeys?: boolean;
+    };
+    s2sConfig?: {
+        accountId: string;
+        bidders: string[];
+        timeout?: number;
+        adapter?: string;
+        endpoint?: string;
+        syncEndpoint?: string;
+        cookieSet?: boolean;
+        cookieSetUrl?: string;
+        defaultVendor?: string;
+        sendTopBidOnly?: boolean;
+        allowUnknownBidderCodes?: boolean;
+    } | Array<{
+        name: string;
+        accountId: string;
+        bidders: string[];
+        timeout?: number;
+        adapter?: string;
+        endpoint?: string;
+        syncEndpoint?: string;
+        cookieSet?: boolean;
+        cookieSetUrl?: string;
+        defaultVendor?: string;
+        sendTopBidOnly?: boolean;
+        allowUnknownBidderCodes?: boolean;
+    }>;
+    ortb2?: {
+        site?: {
+            page?: string;
+            domain?: string;
+            ref?: string;
+            keywords?: string;
+            cat?: string[];
+            sectioncat?: string[];
+            pagecat?: string[];
+            content?: {
+                id?: string;
+                episode?: number;
+                title?: string;
+                series?: string;
+                season?: string;
+                artist?: string;
+                genre?: string;
+                album?: string;
+                isrc?: string;
+                producer?: {
+                    id?: string;
+                    name?: string;
+                };
+                url?: string;
+                cat?: string[];
+                prodq?: number;
+                context?: number;
+                contentrating?: string;
+                userrating?: string;
+                qagmediarating?: number;
+                keywords?: string;
+                livestream?: boolean;
+                sourcerelationship?: number;
+                len?: number;
+                language?: string;
+                embeddable?: boolean;
+                data?: Array<{
+                    id?: string;
+                    name?: string;
+                    segment?: Array<{
+                        id?: string;
+                        name?: string;
+                        value?: string;
+                    }>;
+                }>;
+            };
+            publisher?: {
+                id?: string;
+                name?: string;
+                cat?: string[];
+                domain?: string;
+            };
+            ext?: Record<string, any>;
+        };
+        user?: {
+            id?: string;
+            buyeruid?: string;
+            yob?: number;
+            gender?: string;
+            keywords?: string;
+            customdata?: string;
+            geo?: {
+                lat?: number;
+                lon?: number;
+                type?: number;
+                accuracy?: number;
+                lastfix?: number;
+                ipservice?: number;
+                country?: string;
+                region?: string;
+                regionfips104?: string;
+                metro?: string;
+                city?: string;
+                zip?: string;
+                utcoffset?: number;
+            };
+            data?: Array<{
+                id?: string;
+                name?: string;
+                segment?: Array<{
+                    id?: string;
+                    name?: string;
+                    value?: string;
+                }>;
+            }>;
+            ext?: Record<string, any>;
+        };
+        device?: {
+            ua?: string;
+            geo?: {
+                lat?: number;
+                lon?: number;
+                type?: number;
+                accuracy?: number;
+                lastfix?: number;
+                ipservice?: number;
+                country?: string;
+                region?: string;
+                regionfips104?: string;
+                metro?: string;
+                city?: string;
+                zip?: string;
+                utcoffset?: number;
+            };
+            dnt?: number;
+            lmt?: number;
+            ip?: string;
+            ipv6?: string;
+            devicetype?: number;
+            make?: string;
+            model?: string;
+            os?: string;
+            osv?: string;
+            hwv?: string;
+            h?: number;
+            w?: number;
+            ppi?: number;
+            pxratio?: number;
+            js?: number;
+            geofetch?: number;
+            flashver?: string;
+            language?: string;
+            carrier?: string;
+            mccmnc?: string;
+            connectiontype?: number;
+            ifa?: string;
+            didsha1?: string;
+            didmd5?: string;
+            dpidsha1?: string;
+            dpidmd5?: string;
+            macsha1?: string;
+            macmd5?: string;
+        };
+        regs?: {
+            coppa?: number;
+            gdpr?: number;
+            us_privacy?: string;
+            ext?: Record<string, any>;
+        };
+        ext?: Record<string, any>;
+    };
+    labels?: string[];
+    maxNestedIframes?: number;
+    disableAjaxTimeout?: boolean;
+    enableTIDs?: boolean;
+    gptPreAuction?: GptPreAuctionConfig;
+    allowActivities?: {
+        [activity: string]: {
+            rules: Array<{
+                priority: number;
+                condition: (params: any) => boolean;
+                allow: boolean;
+            }>;
+        };
+    };
+    analytics?: Array<{
+        provider: string;
+        options: Record<string, any>;
+        includeEvents?: string[];
+        excludeEvents?: string[];
+    }>;
+    bidderSettings?: Record<string, SingleBidderSetting>;
+    [key: string]: any;
+}
+export interface GptPreAuctionConfig {
+    enabled: boolean;
+    timeout?: number;
+    setTargeting?: boolean;
+    suppressInitialLoad?: boolean;
+    auctionDelay?: number;
+    requestBidsHook?: () => void;
+}
+export type SingleBidderSetting = {
+    bidCpmAdjustment?: (bidCpm: number) => number;
+    alwaysUseBid?: boolean;
+    sendStandardTargeting?: boolean;
+    adserverTargeting?: Array<{
+        key: string;
+        val: (bidResponse: any) => string;
+    }>;
+};
+export type PriceGranularityValue = Array<{
+    min: number;
+    max: number;
+    increment: number;
+    precision: number;
+}>;
+export type CustomPriceGranularity = {
+    buckets: PriceGranularityValue;
+};
+export interface PrebidJsGlobal {
+    que: Array<() => void>;
+    adUnits: AdUnit[];
+    addAdUnits(adUnits: AdUnit | AdUnit[]): void;
+    removeAdUnit(code: string): void;
+    requestBids(options?: {
+        timeout?: number;
+        adUnits?: AdUnit[];
+        adUnitCodes?: string[];
+        bidsBackHandler?: (bids: Record<string, BidResponse[]>, timedOut: boolean, auctionId: string) => void;
+        labels?: string[];
+        auctionId?: string;
+        ortb2?: object;
+        ttlBuffer?: number;
+    }): void;
+    getBidResponses(): Record<string, {
+        bids: BidResponse[];
+    }>;
+    getBidResponsesForAdUnitCode(adUnitCode: string): {
+        bids: BidResponse[];
+    };
+    getAdserverTargeting(): Record<string, Record<string, string>>;
+    getAdserverTargetingForAdUnitCode(code: string): Record<string, string>;
+    setTargetingForGPTAsync(adUnitCodes?: string[]): void;
+    setConfig(config: PrebidConfig): void;
+    getConfig(key?: string): any;
+    getAllWinningBids(): BidResponse[];
+    getAllPrebidWinningBids(): BidResponse[];
+    renderAd(document: Document, adId: string): void;
+    getUserIds(): Record<string, any>;
+    getUserIdsAsEids(): EID[];
+    getUserIdsAsync(): void;
+    setBidderConfig(config: object): void;
+    aliasBidder(adapterName: string, aliasedName: string, options?: {
+        gvlid?: number;
+        useBaseGvlid?: boolean;
+    }): void;
+    getEvents(): Array<{
+        eventType: string;
+        args: any;
+        id?: string;
+        elapsedTime: number;
+    }>;
+    clearAllAuctions(): void;
+    getNoBids(): BidResponse[];
+    getNoBidsForAdUnitCode(adUnitCode: string): BidResponse[];
+    getHighestCpmBids(adUnitCode?: string): BidResponse[];
+    getHighestUnusedBidResponseForAdUnitCode(adUnitCode: string): BidResponse | null;
+    version: string;
+    installedModules: string[];
+    bidderSettings: Record<string, any>;
+    aliasRegistry: Record<string, string>;
+    adServers: {
+        dfp: {
+            buildAdpodVideoUrl(options: object): string;
+            buildVideoUrl(options: object): string;
+        };
+        freewheel: {
+            getTargeting(options: object): Record<string, string>;
+        };
+        targetVideo: {
+            buildVideoUrl(options: object): string;
+        };
+    };
+    onEvent<K extends PrebidEvent>(event: K, handler: (data: PrebidEventDataMap[K]) => void): void;
+    offEvent<K extends PrebidEvent>(event: K, handler: (data: PrebidEventDataMap[K]) => void): void;
+}