Interface NitroAdOptions

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

Deprecated

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

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

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

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

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.

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

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.

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

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

Used to filter demand by content safety.

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.

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

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

Settings for floating format.

Placement format. Default is display.

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

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.

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.

Optional internal identifier. This is currently only used to group ad placements within the reporting of our protection layer.

Options for interstitial placements.

Example

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

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'.

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

Outstream video support. Default is 'auto'.

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

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

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

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

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.

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.

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

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.

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

Used with rail format to change the format to 2x 300x250 stacked. If true, the sizes option will be ignored. Default is false

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

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

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

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

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

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

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.

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

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

If true, the auction will not include any Prebid demand

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

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.

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.

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

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)

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, or an array of either strings or numbers.

Example

targeting: {
    location: 'top',
    categories: ['games', 'sports'],
},
Copy

Override default title attribute of placement iframe.

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