showFullScreenAd

功能说明

loadFullScreenAd将预先加载的集成全屏广告展示给用户。 loadFullScreenAd与在……中使用的相同 adGroupId需要传递……。已显示过的广告不能再次显示，因此广告关闭后需要重新加载。

Toss App 5.227.0 可在……及以上使用（5.239.0 ……及以上为 Toss Ad + AdMob 集成，低于此为仅 AdMob）。 showFullScreenAd.isSupported()可通过它确认是否支持。

类型

showFullScreenAd(params: ShowFullScreenAdParams): () => void;

Params

type ShowFullScreenAdParams = {
  options: ShowFullScreenAdOptions;
  onEvent: (event: ShowFullScreenAdEvent) => void;
  onError: (error: unknown) => void;
};

type ShowFullScreenAdOptions = {
  /** 与 loadFullScreenAd 中使用的广告组 ID 相同。 */
  adGroupId: string;
};

type ShowFullScreenAdEvent =
  | { type: "requested" }
  | { type: "show" }
  | { type: "impression" }
  | { type: "clicked" }
  | { type: "dismissed" }
  | { type: "failedToShow" }
  | {
      type: "userEarnedReward";
      data: { unitType: string; unitAmount: number };
    };

事件 类型 值：

类型	说明
requested	请求展示广告成功了
show	广告已显示在屏幕上
impression	已记录广告曝光（产生收益的时点）
clicked	用户点击了广告
dismissed	用户关闭了广告
failedToShow	广告展示失败了
userEarnedReward	用户获得了奖励（仅限奖励广告）

Response

用于解除 AppBridge 回调的函数(() => void）作为返回值。

错误

如果广告展示失败 failedToShow 会通过事件或 onError 回调传递。奖励广告 userEarnedReward 只有在该事件发生时才应发放奖励。

示例代码

import {
  loadFullScreenAd,
  showFullScreenAd,
} from "@apps-in-toss/web-framework";

const AD_GROUP_ID = "AD_GROUP_ID";
const button = document.querySelector("#show-full-screen-ad");

button.addEventListener("click", () => {
  const cleanup = showFullScreenAd({
    options: { adGroupId: AD_GROUP_ID },
    onEvent: (event) => {
      switch (event.type) {
        case "impression":
          console.log("广告展示已记录（产生收益）");
          break;
        case "userEarnedReward":
          console.log(
            "获得奖励：",
            event.data.unitType,
            event.data.unitAmount,
          );
          break;
        case "dismissed":
          console.log("广告已关闭。请重新加载下一则广告。");
          cleanup();
          break;
        case "failedToShow":
          console.error("广告展示失败了。");
          cleanup();
          break;
      }
    },
    onError: (error) => {
      console.error(error);
      cleanup();
    },
  });
});