Interface NitroAdOptions

Placement options

interface NitroAdOptions {
    acceptable?: boolean;
    anchor?: AnchorPositionOptions;
    anchorBgColor?: string;
    anchorClose?: boolean;
    anchorCloseBg?: string;
    anchorCloseColor?: string;
    anchorPersistClose?: boolean;
    anchorStickyOffset?: number;
    articleOffsetTop?: number;
    bidders?: string[];
    className?: string;
    contentRating: string;
    delayLoading?: boolean;
    demo?: boolean;
    demoDelay?: number;
    floating?: FloatingOptions;
    format: FormatOptions;
    frequencyCap?: number;
    geoAllow?: string[];
    geoDeny?: string[];
    interstitial?: InterstitialOptions;
    keywords?: string;
    mediaQuery?: string;
    onNavigateMin?: number;
    outstream?: OutstreamOptions;
    pageInterval?: number;
    placeholderColor?: string;
    rail?: string;
    railCloseColor?: string;
    railCollisionWhitelist?: string[];
    railDistance?: number;
    railOffsetBottom?: number;
    railOffsetTop?: number;
    railSpacing?: number;
    railStack?: boolean;
    railStickyTop?: number;
    railVerticalAlign?: RailVerticalAlignOptions;
    refreshDisabled?: string[];
    refreshLimit?: number;
    refreshTime?: number;
    refreshVisibleOnly?: boolean;
    renderVisibleOnly?: boolean;
    sizes: [number, number][];
    skipBidders?: string[];
    skipPrebid?: boolean;
    smartFlexStickyTop?: number;
    stickyStackLimit?: number;
    stickyStackOffset?: number;
    stickyStackResizable?: boolean;
    stickyStackSpace?: number;
    targeting: PlacementTargeting;
    title?: string;
    visibleMargin?: number;
}

Properties

acceptable? anchor? anchorBgColor? anchorClose? anchorCloseBg? anchorCloseColor? anchorPersistClose? anchorStickyOffset? articleOffsetTop? bidders? className? contentRating delayLoading? demo? demoDelay? floating? format frequencyCap? geoAllow? geoDeny? interstitial? keywords? mediaQuery? onNavigateMin? outstream? pageInterval? placeholderColor? rail? railCloseColor? railCollisionWhitelist? railDistance? railOffsetBottom? railOffsetTop? railSpacing? railStack? railStickyTop? railVerticalAlign? refreshDisabled? refreshLimit? refreshTime? refreshVisibleOnly? renderVisibleOnly? sizes skipBidders? skipPrebid? smartFlexStickyTop? stickyStackLimit? stickyStackOffset? stickyStackResizable? stickyStackSpace? targeting title? visibleMargin?

Properties

Optionalacceptable

acceptable?: boolean

Set this to create an acceptable ads placement. Default is false.

Deprecated

No longer used. Any ad placements with this defined will be ignored.

Optionalanchor

anchor?: AnchorPositionOptions

Used with anchor format to specify if anchor should be at the top or bottom of screen. Defaults is bottom.

OptionalanchorBgColor

anchorBgColor?: string

Used with anchor format to define the background color. Default is rgb(0 0 0 / 80%)

OptionalanchorClose

anchorClose?: boolean

Used with anchor format to toggle whether or not an anchor can be closed. Default is false, meaning close button will not be present

OptionalanchorCloseBg

anchorCloseBg?: string

Used with anchor format to define the background color of the close button. Default is rgba(255, 255, 255, 0.2)

OptionalanchorCloseColor

anchorCloseColor?: string

Used with anchor format to define the close button color. Default is #fff

OptionalanchorPersistClose

anchorPersistClose?: boolean

Used with anchor to specify that the close action should be persistent for the entire browser session. Default is false, meaning clicking on close will only close the anchor for the current page.

OptionalanchorStickyOffset

anchorStickyOffset?: number

Used with anchor format to specify the amount of space (in pixels) between the ad and the edge of the screen.

OptionalarticleOffsetTop

articleOffsetTop?: number

Used with article format to specify the amount of space (in pixels) between the ad and the top of the screen when it's sticky.

Optionalbidders

bidders?: string[]

Mutually exclusive with skipBidders (skipBidders has priority). List of bidders to include in auction.

OptionalclassName

className?: string

Used with formats that generate ad placements on the page without static holders to provide css selectors.

contentRating

contentRating: string

Used to filter demand by content safety.

OptionaldelayLoading

delayLoading?: boolean

Delay loading until DOMContentLoaded. Recommended only for responsive placements when external stylesheets must be loaded first to determine size. This delays the start of ad auction, which may slightly reduce ad performance. Default is false.

Optionaldemo

demo?: boolean

Display a static placeholder instead of making ad calls, for testing.

OptionaldemoDelay

demoDelay?: number

Time to wait (in milliseconds) before rendering demo placement.

Optionalfloating

floating?: FloatingOptions

Settings for floating format.

format

format: FormatOptions

Placement format. Default is display.

OptionalfrequencyCap

frequencyCap?: number

Duration in seconds for per-user frequency cap. If set, this placement will only be shown to the user every frequencyCap seconds.

OptionalgeoAllow

geoAllow?: string[]

Array of 2-letter country/region codes. If set, this placement will only be shown to users in these regions. In addition to ISO 3166-1 alpha-2 codes, 'XX' is unknown, and 'T1' is tor users.

OptionalgeoDeny

geoDeny?: string[]

Array of 2-letter country/region codes. If set, this placement will not be shown to users in these regions. In addition to ISO 3166-1 alpha-2 codes, 'XX' is unknown, and 'T1' is tor users.

Optionalinterstitial

interstitial?: InterstitialOptions

Options for interstitial placements.

Example

interstitial: {
    triggers: {
        unhideWindow: true,
    },
},

Optionalkeywords

keywords?: string

Comma separated list of keywords describing the page. Use this to override the site keywords setting for placements on specific parts of site. Example: 'video games, fps, doom'.

OptionalmediaQuery

mediaQuery?: string

Specifies an optional media query that must be matched for an ad placement to display.

OptionalonNavigateMin

onNavigateMin?: number

The minimum amount of milliseconds to wait since initialization or the last refresh until NitroAd.onNavigate() is allowed to trigger a refresh

Optionaloutstream

outstream?: OutstreamOptions

Outstream video support. Default is 'auto'.

OptionalpageInterval

pageInterval?: number

Optional parameter used with article format to specify how many pages of content should appear between ad placements. Defaults to 1.

OptionalplaceholderColor

placeholderColor?: string

Used with smart-flex format to specify the color of the pre-ad loader and the blank placeholder.

Optionalrail

rail?: string

Used with rail format to specify if the rail should be placed on the left or right side of the screen. Default is left.

OptionalrailCloseColor

railCloseColor?: string

Used with rail format to specify the color of the rail close button. Default is rgb(102 102 102)

OptionalrailCollisionWhitelist

railCollisionWhitelist?: string[]

Used with rail format to specify any elements that should be ignored when detecting collisions for the rail. These can be class names (.className) or ids (#id). The wildcard * can be used to ignore all collisions.

OptionalrailDistance

railDistance?: number

Used with rail format to specify the amount of total amount of pixels the side rail will scroll with the user, set 0 for as far as possible.

OptionalrailOffsetBottom

railOffsetBottom?: number

Used with rail format to specify the amount of pixels between the bottom of the page and where the ad stops scrolling.

OptionalrailOffsetTop

railOffsetTop?: number

Used with rail format to specify the amount of pixels between the top of the page and where the ad is initially positioned. The ad becomes sticky after scrolling for the given distance.

OptionalrailSpacing

railSpacing?: number

Used with rail format to specify the amount of pixels between the ad and the left/right edge of the screen. Default is 10.

OptionalrailStack

railStack?: boolean

Used with rail format to stack two ads in the rail. If true, the sizes option will be filtered to only include sizes 300x250, 320x50 and/or 320x100. Default is false.

OptionalrailStickyTop

railStickyTop?: number

Used with rail format to specify the amount of pixels between the top of the screen and where the ad becomes sticky.

OptionalrailVerticalAlign

railVerticalAlign?: RailVerticalAlignOptions

Used with rail format to specify the vertical alignment of the rail ad. Can be center (default) or top

OptionalrefreshDisabled

refreshDisabled?: string[]

List of bidders for whom refreshing should be disabled. If specified, refreshing will be stopped when one of these is filled.

OptionalrefreshLimit

refreshLimit?: number

The maximum number of times an ad placement can be refreshed per page view.

OptionalrefreshTime

refreshTime?: number

The amount of time in seconds that must pass before another auction is run and the placement renders a new ad.

OptionalrefreshVisibleOnly

refreshVisibleOnly?: boolean

Only refresh when placement is in view. Default is true.

OptionalrenderVisibleOnly

renderVisibleOnly?: boolean

Delay initial ad rendering until the placement's dom element is about to enter view. visibleMargin can be used to adjust how much buffer margin is used.

sizes

sizes: [number, number][]

List of valid sizes for placement. Sizes should be specified as [x, z].

OptionalskipBidders

skipBidders?: string[]

Mutually exclusive with bidders (skipBidders has priority). List of bidders to be excluded from auction.

OptionalskipPrebid

skipPrebid?: boolean

If true, the auction will not include any Prebid demand

OptionalsmartFlexStickyTop

smartFlexStickyTop?: number

Used with smart-flex format to specify the amount of pixels between the top of the screen and where the ad becomes sticky.

OptionalstickyStackLimit

stickyStackLimit?: number

Used with sticky-stack format to specify the maximum amount of ads that will be rendered in the column. If the maximum is reached, the final ad will scroll with the user until the end of page without creating any additional units.

OptionalstickyStackOffset

stickyStackOffset?: number

Used with sticky-stack format to specify the amount of space (in pixels) between the ad and the top of the screen when it's sticky, and also the space in between ads that are swapping.

OptionalstickyStackResizable

stickyStackResizable?: boolean

Used with sticky-stack format to specify if the stack should add more placements if more space becomes available. Default is false.

OptionalstickyStackSpace

stickyStackSpace?: number

Used with sticky-stack format to specify the amount of space between ad units as a multiple of the total viewport height (minimum 1.25)

targeting

targeting: PlacementTargeting

Optional placement targeting information. This can be used to specify tags such as content category or other values which can be used for ad unit targeting. The key must be a string, and the value can be a single string or number. Support for arrays is deprecated and not reportable.

Example

targeting: {
    key: 'value',
    location: 'top',
},

Optionaltitle

title?: string

Override default title attribute of placement iframe.

OptionalvisibleMargin

visibleMargin?: number

The off-screen margin in pixels, used to determine when a placement is about to enter view. Default is 200.

Settings

Member Visibility

On This Page

Properties