Stay organized with collections
Save and categorize content based on your preferences.
Display a web interstitial ad
This example demonstrates how to display a web interstitial ad using the Google
Publisher Tag (GPT) library. Web interstitials are GPT-managed, full-page ads
that appear in response to user actions. For more information about web
interstitials, see Traffic web interstitials.
The following user actions are eligible to trigger a web interstitial ad:
Clicking on the browser navigation bar. (Desktop only)
navBar
Disabled
Yes
Hiding and then returning to the page (for example, by switching tabs).
unhideWindow
Disabled
Yes
Support for additional user actions may be added in the future. Follow the
GPT release notes for updates.
Usage notes
To ensure an optimal user experience, GPT only requests web interstitial
ads on pages that properly support the format. Web interstitials are only
supported when GPT is running in the top window. On pages that don't support
web interstitials, defineOutOfPageSlot() may return null. Be sure to check
for this to avoid errors.
Only request web interstitial ads on pages or environments where you want
an interstitial to appear. Web interstitial ads are eligible to serve to
desktop, tablet, and mobile devices.
Web interstitial ads generate their own ad slot. Unlike other ad types,
you don't need to define a <div> for web interstitial ads. These ads
automatically create and insert their own container into the page when an ad
fills.
Web interstitial ads have a configurable
frequency cap. This prevents the same user from
being shown an interstitial more than once per the specified window of time,
per subdomain. The default frequency cap is 1 impression per 10 minutes, and
the minimum allowed cap is 1 impression per 1 minute.
Web interstitial ads require access to local storage. For publishers
integrated with the
IAB Transparency and Consent Framework v2.0, this means
that consent for Purpose 1 is required for web
interstitial ads to function.
Some links on a page might be ineligible to show web interstitial ads.
Interstitial ads won't show when a user clicks an ineligible link, for
example, links to URLs without HTTP/HTTPS, and links that open in a new
window.
If using single-request architecture (SRA) on a page with multiple slots,
don't call display() until static ad slots divs are created. As
explained in Ad Best Practices, the first call to display()
requests every ad slot defined prior to that point. Although web
interstitial slots don't require a predefined <div>, static ad slots do.
Calling display() before these elements are present on the page can result
in lower quality signals, reducing monetization. Because of this, we
recommend delaying the initial call until after the static slots are
defined.
[null,null,[],[],[],null,["# Display a web interstitial ad\n=============================\n\nThis example demonstrates how to display a web interstitial ad using the Google\nPublisher Tag (GPT) library. Web interstitials are GPT-managed, full-page ads\nthat appear in response to user actions. For more information about web\ninterstitials, see [Traffic web interstitials](//support.google.com/admanager/answer/9840201).\n\nThe following user actions are eligible to trigger a web interstitial ad:\n\n| User action | [API name](//developers.google.com/publisher-tag/reference#googletag.config.interstitialconfig) | Default | Configurable |\n|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|----------|--------------|\n| Clicking on an anchor element. | N/A | Enabled | No |\n| Clicking on the browser navigation bar. (Desktop only) | `navBar` | Disabled | Yes |\n| Hiding and then returning to the page (for example, by switching tabs). | `unhideWindow` | Disabled | Yes |\n\n| **Important:** Default trigger states are [configurable in Google Ad Manager](//support.google.com/admanager/answer/9840201). If these values have been modified for your Ad Manager account, they may not match the preceding table.\n\nSupport for additional user actions may be added in the future. Follow the\n[GPT release notes](//developers.google.com/publisher-tag/release-notes) for updates.\n\nUsage notes\n-----------\n\n- **To ensure an optimal user experience, GPT only requests web interstitial\n ads on pages that properly support the format.** Web interstitials are only\n supported when GPT is running in the top window. On pages that don't support\n web interstitials, `defineOutOfPageSlot()` may return null. Be sure to check\n for this to avoid errors.\n\n- **Only request web interstitial ads on pages or environments where you want\n an interstitial to appear.** Web interstitial ads are eligible to serve to\n desktop, tablet, and mobile devices.\n\n | **Tip:** For best results, use `\u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /\u003e` on mobile pages, or avoid setting fixed widths and heights on your document, as that can result in poorly scaled interstitial ads.\n- **Web interstitial ads generate their own ad slot.** Unlike other ad types,\n you don't need to define a `\u003cdiv\u003e` for web interstitial ads. These ads\n automatically create and insert their own container into the page when an ad\n fills.\n\n- **Web interstitial ads have a configurable\n [frequency cap](//support.google.com/admanager/answer/9840201#frequency).** This prevents the same user from\n being shown an interstitial more than once per the specified window of time,\n per subdomain. The default frequency cap is 1 impression per 10 minutes, and\n the minimum allowed cap is 1 impression per 1 minute.\n\n- **Web interstitial ads require access to local storage.** For publishers\n integrated with the\n [IAB Transparency and Consent Framework v2.0](//support.google.com/admanager/answer/9805023), this means\n that consent for [Purpose 1](//support.google.com/admanager/answer/9461778#purposes) is required for web\n interstitial ads to function.\n\n- **Some links on a page might be ineligible to show web interstitial ads.**\n Interstitial ads won't show when a user clicks an ineligible link, for\n example, links to URLs without HTTP/HTTPS, and links that open in a new\n window.\n\n | **Note:** You can prevent specific links from triggering GPT-managed web interstitials by adding a `data-google-interstitial=\"false\"` attribute to the anchor element or any ancestor of the anchor element.\n- **If using single-request architecture (SRA) on a page with multiple slots,\n don't call `display()` until static ad slots divs are created.** As\n explained in [Ad Best Practices](//developers.google.com/publisher-tag/guides/ad-best-practices#use_single_request_architecture_correctly), the first call to `display()`\n requests every ad slot defined prior to that point. Although web\n interstitial slots don't require a predefined `\u003cdiv\u003e`, static ad slots do.\n Calling `display()` before these elements are present on the page can result\n in lower quality signals, reducing monetization. Because of this, we\n recommend delaying the initial call until after the static slots are\n defined.\n\nSample implementation\n---------------------\n\n[View demo](https://googleads.github.io/google-publisher-tag-samples/display-web-interstitial-ad/js/demo.html) This sample makes use of library features that are not fully supported when running in an iframe. To view a demo of this sample in a new window, click the **View demo** button above. \n\n### JavaScript\n\nLoading...\n----------\n\nLoading...\n----------\n\n[Improve this sample](https://github.com/googleads/google-publisher-tag-samples/tree/main/dist/display-web-interstitial-ad/js) [Report an issue](https://github.com/googleads/google-publisher-tag-samples/issues/new?labels=documentation&template=sample-feedback.md&title=Sample+feedback%3A+display-web-interstitial-ad/js)\n\n### TypeScript\n\nLoading...\n----------\n\nLoading...\n----------\n\n[Improve this sample](https://github.com/googleads/google-publisher-tag-samples/tree/main/dist/display-web-interstitial-ad/ts) [Report an issue](https://github.com/googleads/google-publisher-tag-samples/issues/new?labels=documentation&template=sample-feedback.md&title=Sample+feedback%3A+display-web-interstitial-ad/ts)"]]