loadFullScreenAd

Feature description

Preload an integrated full-screen ad. Toss Ad is shown first, and in environments where it can't be used, it automatically switches to AdMob so you can serve ads reliably. You must call this before displaying the ad.

It behaves differently depending on the Toss app version:

Toss app version	Supported features
5.239.0 and above	Toss Ad + AdMob integration (Toss Ad first, automatically switches to AdMob if not possible)
5.227.0 and above ~ 5.239.0 below	Show only AdMob ads
5.227.0 below	Not supported

Before calling loadFullScreenAd.isSupported()You can check whether it is supported with

Type

loadFullScreenAd(params: LoadFullScreenAdParams): () => void;

Params

type LoadFullScreenAdParams = {
  options: LoadFullScreenAdOptions;
  onEvent: (event: LoadFullScreenAdEvent) => void;
  onError: (error: unknown) => void;
};

type LoadFullScreenAdOptions = {
  /** This is the ad group ID. Please enter the value issued from the Apps in Toss console. */
  adGroupId: string;
};

type LoadFullScreenAdEvent = {
  type: "loaded";
};

Response

Function to unregister the AppBridge callback (() => void).

Error

If ad loading fails, onError An error is delivered via the callback. If you call it on an unsupported version, onErroran error is delivered, so before calling isSupported()check with

Example code

import { Ads } from "@apps-in-toss/web-framework";

let isAdLoaded = false;

function prepareAd() {
  if (!loadFullScreenAd.isSupported()) {
    console.warn("Full-screen ads are not available in the current environment.");
    return;
  }

  const cleanup = loadFullScreenAd({
    options: { adGroupId: "AD_GROUP_ID" },
    onEvent: (event) => {
      if (event.type === "loaded") {
        console.log("Ad load complete");
        isAdLoaded = true;
        cleanup();
      }
    },
    onError: (error) => {
      console.error("Ad load failed:", error);
      cleanup();
    },
  });
}