TossAds.destroyAll

현재 페이지에 삽입된 모든 배너 광고 슬롯을 DOM에서 제거하고 리소스를 해제합니다. 페이지 전환 또는 컴포넌트 언마운트 시 일괄 정리에 사용합니다.

시그니처

destroyAll은 TossAds 네임스페이스 객체의 멤버로 노출됩니다.

import { TossAds } from '@apps-in-toss/web-framework';

declare const TossAds: {
  destroyAll: (() => void) & {
    isSupported: () => boolean;
  };
};

파라미터

없음.

반환값

• void — 반환값 없음.

권한

권한이 필요하지 않습니다 — TossAds.destroyAll는 별도의 PermissionName에 바인딩되지 않습니다. 권한이 필요한 다른 네임스페이스의 일반적인 처리 흐름은 Guides — 권한 처리 패턴을 참고하세요.

예제

최소 예제

import { TossAds } from '@apps-in-toss/web-framework';

TossAds.destroyAll();

실전 예제 — 페이지 언마운트 시 광고 일괄 정리

import { TossAds } from '@apps-in-toss/web-framework';
import { useEffect, useRef } from 'react';

const AD_GROUP_ID = 'ad-group-id-here';

function AdsPage() {
  const bannerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    if (!bannerRef.current) return;
    if (!TossAds.initialize.isSupported()) return;

    TossAds.initialize({});
    TossAds.attachBanner(AD_GROUP_ID, bannerRef.current);

    // 페이지 언마운트 시 모든 슬롯을 한 번에 정리합니다.
    return () => {
      TossAds.destroyAll();
    };
  }, []);

  return <div ref={bannerRef} />;
}

직접 실행해 보기

sdk-example의 Ads 페이지에서 TossAds.destroyAll 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• TossAds.destroy — 특정 슬롯 ID를 지정해 하나의 광고만 파괴합니다.
• TossAds.attachBanner — 배너 광고를 DOM에 연결합니다.
• TossAds.initialize — TossAds SDK 초기화 함수.

관련 가이드

• Guides — 광고 통합 패턴 — 라이프사이클·클린업·환경 가드를 한 곳에 정리한 가이드.

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.