Set this to create an acceptable ads placement. Default is false.
anchor format to specify if anchor should be at the top or
bottom of screen. Defaults is
anchor format to define the background color. Default is
rgb(255 255 255 / 80%)
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 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.
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
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.
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.
rail format to specify if the rail should be placed on the left or
right side of the screen. Default is
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.
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.
rail format to specify the amount of pixels between the bottom of
the page and where the ad stops scrolling.
rail format to specify the amount of pixels between the top of the
page and where the ad becomes sticky.
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
rail format to change the format to 2x 300x250 stacked. If
the sizes option will be ignored. Default is
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 false.
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].
List of bidders to be excluded from auction.
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.
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.
sticky-stack format to specify if the stack should add more
placements if more space becomes available. Default is false.
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.
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.
Generated using TypeDoc