Interface AdInfo

AdInfo describes the metadata and bid details for an ad placement.

interface AdInfo {
    acceptable: boolean;
    adUnitCode: string;
    auf?: string;
    bidder: string;
    c: string;
    cpm: number;
    creativeId: string;
    duration: number;
    f?: string;
    hashedEmail: boolean;
    height: number;
    href: string;
    mediaType?: string;
    meta?: string;
    r: string;
    refresh: boolean;
    requestId: string;
    targeting?: PlacementTargeting;
    timeToRespond?: number;
    trackerMeta?: Record<string, string>;
    type: AdInfoType;
    v?: string;
    width: number;
}

Properties

acceptable adUnitCode auf? bidder c cpm creativeId duration f? hashedEmail height href mediaType? meta? r refresh requestId targeting? timeToRespond? trackerMeta? type v? width

Properties

acceptable

acceptable: boolean

True for acceptable ads placements

adUnitCode

adUnitCode: string

Placement id

Optionalauf

auf?: string

Ad Unit Format

bidder

bidder: string

Bidder id

c

c: string

2-letter country code

cpm

cpm: number

CPM

creativeId

creativeId: string

Creative id

duration

duration: number

duration for video ads

Optionalf

f?: string

Fingerprint information.

hashedEmail

hashedEmail: boolean

Hashed User Email

height

height: number

Height in pixels

href

href: string

Current page URL

OptionalmediaType

mediaType?: string

Unit media type: video, banner, native, audio

Optionalmeta

meta?: string

Any extended bid data returned with the bid

r

r: string

region code

refresh

refresh: boolean

If ad slot has been refreshed

requestId

requestId: string

Ad request UUID

Optionaltargeting

targeting?: PlacementTargeting

Targeting information for custom dimensions reporting.

OptionaltimeToRespond

timeToRespond?: number

Bid response time in milliseconds

OptionaltrackerMeta

trackerMeta?: Record<string, string>

Additional metadata passed to the tracker to decorate data.

type

type: AdInfoType

ad type

Optionalv

v?: string

Script version

width

width: number

Width in pixels

Settings

Member Visibility

On This Page

Properties