@apps-in-toss/web-bridge 1.0.0 → 1.0.2

package/built/index.d.ts

@@ -1,6 +1,6 @@
 export * from './bridge';
 export * from '@apps-in-toss/bridge-core';
-import { LoadAdMobInterstitialAdEvent, LoadAdMobInterstitialAdOptions, ShowAdMobInterstitialAdEvent, ShowAdMobInterstitialAdOptions, LoadAdMobRewardedAdEvent, LoadAdMobRewardedAdOptions, ShowAdMobRewardedAdEvent, ShowAdMobRewardedAdOptions } from '@apps-in-toss/framework';
+import { LoadAdMobInterstitialAdEvent, LoadAdMobInterstitialAdOptions, ShowAdMobInterstitialAdEvent, ShowAdMobInterstitialAdOptions, LoadAdMobRewardedAdEvent, LoadAdMobRewardedAdOptions, ShowAdMobRewardedAdEvent, ShowAdMobRewardedAdOptions, LoadAdMobEvent, LoadAdMobOptions, ShowAdMobEvent, ShowAdMobOptions } from '@apps-in-toss/framework';
 
 /**
  * @public
@@ -177,58 +177,32 @@ declare const GoogleAdMob: {
      * @public
      * @category 광고
      * @name loadAdMobInterstitialAd
-     * @description 앱 화면 전체를 덮는 전면 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
-     * @param {LoadAdMobInterstitialAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
-     * @param {LoadAdMobInterstitialAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
-     * @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 전면 광고용 ID를 입력해요.
-     * @param {(event: LoadAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobInterstitialAdEvent](/react-native/reference/framework/광고/LoadAdMobInterstitialAdEvent.html)를 참고하세요.
-     * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
-     * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
+     * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link GoogleAdMob.loadAppsInTossAdMob}를 사용해주세요.
      *
      * @example
-     * ### 뷰 진입 시 전면광고 불러오기
+     * ### 뷰 진입 시 광고 불러오기 (loadAppsInTossAdMob로 변경 예제)
      * ```tsx
      * import { GoogleAdMob } from '@apps-in-toss/framework';
      * import { useEffect } from 'react';
      * import { View, Text } from 'react-native';
      *
-     * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
      *
      * function Page() {
      *   useEffect(() => {
-     *     if (GoogleAdMob.loadAdMobInterstitialAd.isSupported() !== true) {
+     *     if (GoogleAdMob.loadAppsInTossAdMob.isSupported() !== true) {
      *       return;
      *     }
      *
-     *     const cleanup = GoogleAdMob.loadAdMobInterstitialAd({
+     *     const cleanup = GoogleAdMob.loadAppsInTossAdMob({
      *       options: {
-     *         adUnitId: AD_UNIT_ID,
+     *         adGroupId: AD_GROUP_ID,
      *       },
      *       onEvent: (event) => {
      *         switch (event.type) {
      *           case 'loaded':
      *             console.log('광고 로드 성공', event.data);
      *             break;
-     *
-     *           case 'clicked':
-     *             console.log('광고 클릭');
-     *             break;
-     *
-     *           case 'dismissed':
-     *             console.log('광고 닫힘');
-     *             break;
-     *
-     *           case 'failedToShow':
-     *             console.log('광고 보여주기 실패');
-     *             break;
-     *
-     *           case 'impression':
-     *             console.log('광고 노출');
-     *             break;
-     *
-     *           case 'show':
-     *             console.log('광고 컨텐츠 보여졌음');
-     *             break;
      *         }
      *       },
      *       onError: (error) => {
@@ -258,37 +232,57 @@ declare const GoogleAdMob: {
      * @public
      * @category 광고
      * @name showAdMobInterstitialAd
-     * @description 앱 화면 전체를 덮는 전면 광고를 사용자에게 노출해요. 이 함수는 `loadAdMobInterstitialAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
-     * @param {ShowAdMobInterstitialAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와과 광고의 동작에 대한 콜백을 설정할 수 있어요.
-     * @param {ShowAdMobInterstitialAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
-     * @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobInterstitialAd` 로 불러온 전면 광고용 ID를 입력해요.
-     * @param {(event: ShowAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobInterstitialAdEvent](/react-native/reference/framework/광고/ShowAdMobInterstitialAdEvent.html)를 참고하세요.
-     * @param {(reason: unknown) => void} [params.onError] 광고를 노출하지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
-     * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
+     * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link GoogleAdMob.showAppsInTossAdMob}를 사용해주세요.
      *
      * @example
-     * ### 버튼 눌러 불러온 전면 광고 보여주기
+     * ### 버튼 눌러 불러온 광고 보여주기 (showAppsInTossAdMob로 대체 사용)
      * ```tsx
      * import { GoogleAdMob } from '@apps-in-toss/framework';
      * import { View, Text, Button } from 'react-native';
      *
-     * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
      *
      * function Page() {
      *   const handlePress = () => {
-     *     if (GoogleAdMob.showAdMobInterstitialAd.isSupported() !== true) {
+     *     if (GoogleAdMob.showAppsInTossAdMob.isSupported() !== true) {
      *       return;
      *     }
      *
-     *     GoogleAdMob.showAdMobInterstitialAd({
+     *     GoogleAdMob.showAppsInTossAdMob({
      *       options: {
-     *         adUnitId: AD_UNIT_ID,
+     *         adGroupId: AD_GROUP_ID,
      *       },
      *       onEvent: (event) => {
      *         switch (event.type) {
      *           case 'requested':
      *             console.log('광고 보여주기 요청 완료');
      *             break;
+     *
+     *           case 'clicked':
+     *             console.log('광고 클릭');
+     *             break;
+     *
+     *           case 'dismissed':
+     *             console.log('광고 닫힘');
+     *             navigation.navigate('/examples/google-admob-interstitial-ad-landing');
+     *             break;
+     *
+     *           case 'failedToShow':
+     *             console.log('광고 보여주기 실패');
+     *             break;
+     *
+     *           case 'impression':
+     *             console.log('광고 노출');
+     *             break;
+     *
+     *           case 'userEarnedReward':
+     *             console.log('광고 보상 획득 unitType:', event.data.unitType);
+     *             console.log('광고 보상 획득 unitAmount:', event.data.unitAmount);
+     *             break;
+     *
+     *           case 'show':
+     *             console.log('광고 컨텐츠 보여졌음');
+     *             break;
      *         }
      *       },
      *       onError: (error) => {
@@ -314,38 +308,86 @@ declare const GoogleAdMob: {
      * @public
      * @category 광고
      * @name loadAdMobRewardedAd
-     * @description 사용자가 광고를 끝까지 시청하면 리워드를 제공할 수 있는 보상형 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
-     * @param {LoadAdMobRewardedAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
-     * @param {LoadAdMobRewardedAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
-     * @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 보상형 광고용 ID를 입력해요.
-     * @param {(event: LoadAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobRewardedAdEvent](/react-native/reference/framework/광고/LoadAdMobRewardedAdEvent.html)를 참고하세요.
-     * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
-     * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
+     * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link GoogleAdMob.loadAppsInTossAdMob}를 사용해주세요.
      *
      * @example
-     * ### 뷰 진입 시 보상형 광고 불러오기
+     * ### 뷰 진입 시 광고 불러오기 (loadAppsInTossAdMob로 변경 예제)
      * ```tsx
      * import { GoogleAdMob } from '@apps-in-toss/framework';
      * import { useEffect } from 'react';
      * import { View, Text } from 'react-native';
      *
-     * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
      *
      * function Page() {
      *   useEffect(() => {
-     *     if (GoogleAdMob.loadAdMobRewardedAd.isSupported() !== true) {
+     *     if (GoogleAdMob.loadAppsInTossAdMob.isSupported() !== true) {
      *       return;
      *     }
      *
-     *     const cleanup = GoogleAdMob.loadAdMobRewardedAd({
+     *     const cleanup = GoogleAdMob.loadAppsInTossAdMob({
      *       options: {
-     *         adUnitId: AD_UNIT_ID,
+     *         adGroupId: AD_GROUP_ID,
      *       },
      *       onEvent: (event) => {
      *         switch (event.type) {
      *           case 'loaded':
      *             console.log('광고 로드 성공', event.data);
      *             break;
+     *         }
+     *       },
+     *       onError: (error) => {
+     *         console.error('광고 불러오기 실패', error);
+     *       },
+     *     });
+     *
+     *     return cleanup;
+     *   }, []);
+     *
+     *   return (
+     *     <View>
+     *       <Text>Page</Text>
+     *     </View>
+     *   );
+     * }
+     * ```
+     */
+    loadAdMobRewardedAd: ((args: {
+        onEvent: (data: LoadAdMobRewardedAdEvent) => void;
+        onError: (error: Error) => void;
+        options?: LoadAdMobRewardedAdOptions | undefined;
+    }) => () => void) & {
+        isSupported: () => boolean;
+    };
+    /**
+     * @public
+     * @category 광고
+     * @name showAdMobRewardedAd
+     * @deprecated 이 함수는 더 이상 사용되지 않습니다. 대신 {@link GoogleAdMob.showAppsInTossAdMob}를 사용해주세요.
+     *
+     * @example
+     * ### 버튼 눌러 불러온 광고 보여주기 (showAppsInTossAdMob로 대체 사용)
+     * ```tsx
+     * import { GoogleAdMob } from '@apps-in-toss/framework';
+     * import { View, Text, Button } from 'react-native';
+     *
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
+     *
+     * function Page() {
+     *   const handlePress = () => {
+     *     if (GoogleAdMob.showAppsInTossAdMob.isSupported() !== true) {
+     *       return;
+     *     }
+     *
+     *     GoogleAdMob.showAppsInTossAdMob({
+     *       options: {
+     *         adGroupId: AD_GROUP_ID,
+     *       },
+     *       onEvent: (event) => {
+     *         switch (event.type) {
+     *           case 'requested':
+     *             console.log('광고 보여주기 요청 완료');
+     *             break;
      *
      *           case 'clicked':
      *             console.log('광고 클릭');
@@ -353,6 +395,7 @@ declare const GoogleAdMob: {
      *
      *           case 'dismissed':
      *             console.log('광고 닫힘');
+     *             navigation.navigate('/examples/google-admob-interstitial-ad-landing');
      *             break;
      *
      *           case 'failedToShow':
@@ -363,12 +406,70 @@ declare const GoogleAdMob: {
      *             console.log('광고 노출');
      *             break;
      *
+     *           case 'userEarnedReward':
+     *             console.log('광고 보상 획득 unitType:', event.data.unitType);
+     *             console.log('광고 보상 획득 unitAmount:', event.data.unitAmount);
+     *             break;
+     *
      *           case 'show':
      *             console.log('광고 컨텐츠 보여졌음');
      *             break;
+     *         }
+     *       },
+     *       onError: (error) => {
+     *         console.error('광고 보여주기 실패', error);
+     *       },
+     *     });
+     *   }
      *
-     *           case 'userEarnedReward':
-     *             console.log('사용자가 광고 시청을 완료했음');
+     *   return (
+     *     <Button onPress={handlePress} title="광고 보기" />
+     *   );
+     * }
+     * ```
+     */
+    showAdMobRewardedAd: ((args: {
+        onEvent: (data: ShowAdMobRewardedAdEvent) => void;
+        onError: (error: Error) => void;
+        options?: ShowAdMobRewardedAdOptions | undefined;
+    }) => () => void) & {
+        isSupported: () => boolean;
+    };
+    /**
+     * @public
+     * @category 광고
+     * @name loadAppsInTossAdMob
+     * @description 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
+     * @param {LoadAdMobParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 그룹 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
+     * @param {LoadAdMobOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
+     * @param {string} params.options.adGroupId 광고 그룹 단위 ID예요. 콘솔에서 발급받은 ID를 입력해요.
+     * @param {(event: LoadAdMobEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobEvent](/react-native/reference/framework/광고/LoadAdMobEvent.html)를 참고하세요.
+     * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
+     * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
+     *
+     * @example
+     * ### 뷰 진입 시 광고 불러오기
+     * ```tsx
+     * import { GoogleAdMob } from '@apps-in-toss/framework';
+     * import { useEffect } from 'react';
+     * import { View, Text } from 'react-native';
+     *
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
+     *
+     * function Page() {
+     *   useEffect(() => {
+     *     if (GoogleAdMob.loadAppsInTossAdMob.isSupported() !== true) {
+     *       return;
+     *     }
+     *
+     *     const cleanup = GoogleAdMob.loadAppsInTossAdMob({
+     *       options: {
+     *         adGroupId: AD_GROUP_ID,
+     *       },
+     *       onEvent: (event) => {
+     *         switch (event.type) {
+     *           case 'loaded':
+     *             console.log('광고 로드 성공', event.data);
      *             break;
      *         }
      *       },
@@ -388,48 +489,74 @@ declare const GoogleAdMob: {
      * }
      * ```
      */
-    loadAdMobRewardedAd: ((args: {
-        onEvent: (data: LoadAdMobRewardedAdEvent) => void;
+    loadAppsInTossAdMob: ((args: {
+        onEvent: (data: LoadAdMobEvent) => void;
         onError: (error: Error) => void;
-        options?: LoadAdMobRewardedAdOptions | undefined;
+        options?: LoadAdMobOptions | undefined;
     }) => () => void) & {
         isSupported: () => boolean;
     };
     /**
      * @public
      * @category 광고
-     * @name showAdMobRewardedAd
-     * @description 사용자가 광고를 끝까지 보면 리워드를 받을 수 있도록, 보상형 광고를 화면에 보여줘요. 이 함수는 `loadAdMobRewardedAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
-     * @param {ShowAdMobRewardedAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
-     * @param {ShowAdMobRewardedAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
-     * @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobRewardedAd` 로 불러온 보상형 광고용 ID를 입력해요.
-     * @param {(event: ShowAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobRewardedAdEvent](/react-native/reference/framework/광고/ShowAdMobRewardedAdEvent.html)를 참고하세요.
-     * @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
+     * @name showAppsInTossAdMob
+     * @description 광고를 사용자에게 노출해요. 이 함수는 `loadAppsInTossAdMob` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
+     * @param {ShowAdMobParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 그룹 ID와과 광고의 동작에 대한 콜백을 설정할 수 있어요.
+     * @param {ShowAdMobOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
+     * @param {string} params.options.adUnitId 광고 그룹 단위 ID예요. `loadAppsInTossAdMob` 로 불러온 광고용 그룹 ID를 입력해요.
+     * @param {(event: ShowAdMobEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobEvent](/react-native/reference/framework/광고/ShowAdMobEvent.html)를 참고하세요.
+     * @param {(reason: unknown) => void} [params.onError] 광고를 노출하지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
      * @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
      *
      * @example
-     * ### 버튼 눌러 불러온 보상형 광고 보여주기
+     * ### 버튼 눌러 불러온 광고 보여주기
      * ```tsx
      * import { GoogleAdMob } from '@apps-in-toss/framework';
      * import { View, Text, Button } from 'react-native';
      *
-     * const AD_UNIT_ID = '<YOUR_AD_UNIT_ID>';
+     * const AD_GROUP_ID = '<AD_GROUP_ID>';
      *
      * function Page() {
      *   const handlePress = () => {
-     *     if (GoogleAdMob.showAdMobRewardedAd.isSupported() !== true) {
+     *     if (GoogleAdMob.showAppsInTossAdMob.isSupported() !== true) {
      *       return;
      *     }
      *
-     *     GoogleAdMob.showAdMobRewardedAd({
+     *     GoogleAdMob.showAppsInTossAdMob({
      *       options: {
-     *         adUnitId: AD_UNIT_ID,
+     *         adGroupId: AD_GROUP_ID,
      *       },
      *       onEvent: (event) => {
      *         switch (event.type) {
      *           case 'requested':
      *             console.log('광고 보여주기 요청 완료');
      *             break;
+     *
+     *           case 'clicked':
+     *             console.log('광고 클릭');
+     *             break;
+     *
+     *           case 'dismissed':
+     *             console.log('광고 닫힘');
+     *             navigation.navigate('/examples/google-admob-interstitial-ad-landing');
+     *             break;
+     *
+     *           case 'failedToShow':
+     *             console.log('광고 보여주기 실패');
+     *             break;
+     *
+     *           case 'impression':
+     *             console.log('광고 노출');
+     *             break;
+     *
+     *           case 'userEarnedReward':
+     *             console.log('광고 보상 획득 unitType:', event.data.unitType);
+     *             console.log('광고 보상 획득 unitAmount:', event.data.unitAmount);
+     *             break;
+     *
+     *           case 'show':
+     *             console.log('광고 컨텐츠 보여졌음');
+     *             break;
      *         }
      *       },
      *       onError: (error) => {
@@ -444,10 +571,10 @@ declare const GoogleAdMob: {
      * }
      * ```
      */
-    showAdMobRewardedAd: ((args: {
-        onEvent: (data: ShowAdMobRewardedAdEvent) => void;
+    showAppsInTossAdMob: ((args: {
+        onEvent: (data: ShowAdMobEvent) => void;
         onError: (error: Error) => void;
-        options?: ShowAdMobRewardedAdOptions | undefined;
+        options?: ShowAdMobOptions | undefined;
     }) => () => void) & {
         isSupported: () => boolean;
     };