@apps-in-toss/framework 0.0.0-dev.1743135526084 → 0.0.0-dev.1747216176095
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +918 -155
- package/dist/index.d.cts +1035 -343
- package/dist/index.d.ts +1035 -343
- package/dist/index.js +892 -138
- package/package.json +22 -11
- package/src/async-bridges.ts +10 -9
- package/src/constant-bridges.ts +3 -1
- package/src/event-bridges.ts +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,12 +1,23 @@
|
|
|
1
|
+
import * as react from 'react';
|
|
1
2
|
import { ComponentType, PropsWithChildren } from 'react';
|
|
2
|
-
import { InitialProps, BedrockProps } from 'react-native-bedrock';
|
|
3
|
-
import { EmitterSubscription } from 'react-native';
|
|
4
3
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
+
import * as _apps_in_toss_analytics from '@apps-in-toss/analytics';
|
|
5
|
+
export * from '@apps-in-toss/analytics';
|
|
6
|
+
import { InitialProps, BedrockProps, BedrockEventDefinition, BedrockEvent } from 'react-native-bedrock';
|
|
7
|
+
import { EmitterSubscription } from 'react-native';
|
|
5
8
|
import { PartnerWebViewScreenProps, ExternalWebViewScreenProps } from '@toss-design-system/react-native';
|
|
6
9
|
import { WebViewProps as WebViewProps$1 } from '@react-native-bedrock/native/react-native-webview';
|
|
7
10
|
|
|
8
|
-
|
|
9
|
-
|
|
11
|
+
interface AppsInTossProps {
|
|
12
|
+
context: BedrockProps['context'];
|
|
13
|
+
analytics?: {
|
|
14
|
+
/**
|
|
15
|
+
* 분석 로그 출력 여부를 설정해요. 기본값은 `__DEV__` 예요.
|
|
16
|
+
*/
|
|
17
|
+
debug?: boolean;
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
declare function registerApp(container: ComponentType<PropsWithChildren<InitialProps>>, { context, analytics }: AppsInTossProps): (initialProps: InitialProps) => JSX.Element;
|
|
10
21
|
|
|
11
22
|
declare const AppsInToss: {
|
|
12
23
|
registerApp: typeof registerApp;
|
|
@@ -70,7 +81,7 @@ interface Location {
|
|
|
70
81
|
*/
|
|
71
82
|
timestamp: number;
|
|
72
83
|
/**
|
|
73
|
-
* @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/reference/framework/Types/LocationCoords.html)을 참고해주세요.
|
|
84
|
+
* @description 위치 정보를 나타내는 객체예요. 자세한 내용은 [LocationCoords](/react-native/reference/framework/Types/LocationCoords.html)을 참고해주세요.
|
|
74
85
|
*/
|
|
75
86
|
coords: LocationCoords;
|
|
76
87
|
}
|
|
@@ -116,7 +127,7 @@ interface ImageResponse {
|
|
|
116
127
|
dataUri: string;
|
|
117
128
|
}
|
|
118
129
|
|
|
119
|
-
interface StartUpdateLocationOptions {
|
|
130
|
+
interface StartUpdateLocationOptions$1 {
|
|
120
131
|
/**
|
|
121
132
|
* 위치 정확도를 설정해요.
|
|
122
133
|
*/
|
|
@@ -138,10 +149,8 @@ interface StartUpdateLocationSubscription extends EmitterSubscription {
|
|
|
138
149
|
* @kind typedef
|
|
139
150
|
* @description
|
|
140
151
|
* 디바이스의 위치 정보 변경을 감지해요
|
|
141
|
-
* @extends {EventEmitterSchema<'updateLocation', [Location]>}
|
|
142
152
|
*/
|
|
143
|
-
|
|
144
|
-
}
|
|
153
|
+
type UpdateLocationEventEmitter = EventEmitterSchema<'updateLocation', [Location]>;
|
|
145
154
|
/**
|
|
146
155
|
* @public
|
|
147
156
|
* @category 위치 정보
|
|
@@ -154,7 +163,7 @@ interface UpdateLocationEventEmitter extends EventEmitterSchema<'updateLocation'
|
|
|
154
163
|
* @param {number} [options.accuracy] 위치 정확도를 설정해요.
|
|
155
164
|
* @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
|
|
156
165
|
* @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
|
|
157
|
-
* @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
|
|
166
|
+
* @param {(location: Location) => void} [options.callback] 위치 정보가 변경될 때 호출되는 콜백 함수예요. 자세한 내용은 [Location](/react-native/reference/framework/Types/Location.html)을 참고해주세요.
|
|
158
167
|
*
|
|
159
168
|
* @example
|
|
160
169
|
* ### 위치 정보 변경 감지하기
|
|
@@ -204,397 +213,751 @@ interface UpdateLocationEventEmitter extends EventEmitterSchema<'updateLocation'
|
|
|
204
213
|
declare function startUpdateLocation(eventParams: {
|
|
205
214
|
onEvent: (response: Location) => void;
|
|
206
215
|
onError: (error: unknown) => void;
|
|
207
|
-
options: StartUpdateLocationOptions;
|
|
216
|
+
options: StartUpdateLocationOptions$1;
|
|
208
217
|
}): () => void;
|
|
209
218
|
|
|
210
219
|
/**
|
|
211
220
|
* @public
|
|
212
|
-
* @category
|
|
213
|
-
* @name
|
|
214
|
-
* @description
|
|
215
|
-
* @
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
221
|
+
* @category 광고
|
|
222
|
+
* @name AdMobFullScreenEvent
|
|
223
|
+
* @description 앱 화면을 덮는 광고(예: 전면 광고, 보상형 광고)를 사용하는 경우에 발생하는 이벤트 타입이에요.
|
|
224
|
+
* @example
|
|
225
|
+
* ### 광고 이벤트 처리하기
|
|
226
|
+
* ```ts
|
|
227
|
+
* function handleEvent(event: AdMobFullScreenEvent) {
|
|
228
|
+
* switch (event.type) {
|
|
229
|
+
* case 'clicked':
|
|
230
|
+
* console.log('광고가 클릭됐어요.');
|
|
231
|
+
* break;
|
|
232
|
+
*
|
|
233
|
+
* case 'dismissed':
|
|
234
|
+
* console.log('광고가 닫혔어요.');
|
|
235
|
+
* break;
|
|
236
|
+
*
|
|
237
|
+
* case 'failedToShow':
|
|
238
|
+
* console.log('광고가 보여지지 않았어요.');
|
|
239
|
+
* break;
|
|
240
|
+
*
|
|
241
|
+
* case 'impression':
|
|
242
|
+
* console.log('광고가 노출됐어요.');
|
|
243
|
+
* break;
|
|
244
|
+
*
|
|
245
|
+
* case 'show':
|
|
246
|
+
* console.log('광고가 보여졌어요.');
|
|
247
|
+
* break;
|
|
248
|
+
* }
|
|
249
|
+
* }
|
|
250
|
+
* ```
|
|
226
251
|
*/
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
252
|
+
type AdMobFullScreenEvent = AdClicked | AdDismissed | AdFailedToShow | AdImpression | AdShow;
|
|
253
|
+
type AdClicked = {
|
|
254
|
+
type: 'clicked';
|
|
255
|
+
};
|
|
256
|
+
type AdDismissed = {
|
|
257
|
+
type: 'dismissed';
|
|
258
|
+
};
|
|
259
|
+
type AdFailedToShow = {
|
|
260
|
+
type: 'failedToShow';
|
|
261
|
+
};
|
|
262
|
+
type AdImpression = {
|
|
263
|
+
type: 'impression';
|
|
264
|
+
};
|
|
265
|
+
type AdShow = {
|
|
266
|
+
type: 'show';
|
|
267
|
+
};
|
|
268
|
+
interface AdMobHandlerParams<Options = void, Event = AdMobFullScreenEvent> {
|
|
269
|
+
options: Options;
|
|
270
|
+
onEvent: (event: Event) => void;
|
|
271
|
+
onError: (error: unknown) => void;
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* @public
|
|
275
|
+
* @category 광고
|
|
276
|
+
* @name ResponseInfo
|
|
277
|
+
* @description 광고 로드 응답 정보를 담고 있는 객체예요.
|
|
278
|
+
* @property {Array<AdNetworkResponseInfo>} adNetworkInfoArray 광고 네트워크 응답 정보 배열예요.
|
|
279
|
+
* @property {AdNetworkResponseInfo | null} loadedAdNetworkInfo 로드된 광고 네트워크 응답 정보예요.
|
|
280
|
+
* @property {string | null} responseId 광고 응답 ID예요.
|
|
281
|
+
*/
|
|
282
|
+
interface ResponseInfo {
|
|
283
|
+
adNetworkInfoArray: Array<AdNetworkResponseInfo>;
|
|
284
|
+
loadedAdNetworkInfo: AdNetworkResponseInfo | null;
|
|
285
|
+
responseId: string | null;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
* @category 광고
|
|
290
|
+
* @name AdNetworkResponseInfo
|
|
291
|
+
* @description 광고 네트워크 응답 정보를 담고 있는 객체예요.
|
|
292
|
+
* @property {string} adSourceId 광고 소스 ID예요.
|
|
293
|
+
* @property {string} adSourceName 광고 소스 이름이예요.
|
|
294
|
+
* @property {string} adSourceInstanceId 광고 소스 인스턴스 ID예요.
|
|
295
|
+
* @property {string} adSourceInstanceName 광고 소스 인스턴스 이름이예요.
|
|
296
|
+
* @property {string | null} adNetworkClassName 광고 네트워크 클래스 이름이예요.
|
|
297
|
+
*/
|
|
298
|
+
interface AdNetworkResponseInfo {
|
|
299
|
+
adSourceId: string;
|
|
300
|
+
adSourceName: string;
|
|
301
|
+
adSourceInstanceId: string;
|
|
302
|
+
adSourceInstanceName: string;
|
|
303
|
+
adNetworkClassName: string | null;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
* @category 광고
|
|
308
|
+
* @name InterstitialAd
|
|
309
|
+
* @description 전면 광고의 ID와 응답 정보를 담고 있는 객체예요. 광고를 로드한 뒤, 관련 정보를 확인할 때 유용해요.
|
|
310
|
+
* @property {string} adUnitId 광고 ID예요.
|
|
311
|
+
* @property {ResponseInfo} responseInfo 광고 로드 응답 정보예요. 자세한 내용은 [ResponseInfo](/react-native/reference/framework/광고/ResponseInfo.html)를 참고하세요.
|
|
312
|
+
*/
|
|
313
|
+
interface InterstitialAd {
|
|
314
|
+
adUnitId: string;
|
|
315
|
+
responseInfo: ResponseInfo;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
* @category 광고
|
|
320
|
+
* @name RewardedAd
|
|
321
|
+
* @description 보상형 광고의 ID와 응답 정보를 담고 있는 객체예요. 광고를 로드한 뒤, 관련 정보를 확인할 때 유용해요.
|
|
322
|
+
* @property {string} adUnitId 광고 ID예요.
|
|
323
|
+
* @property {ResponseInfo} responseInfo 광고 로드 응답 정보예요. 자세한 내용은 [ResponseInfo](/react-native/reference/framework/광고/ResponseInfo.html)를 참고하세요.
|
|
324
|
+
*/
|
|
325
|
+
interface RewardedAd {
|
|
326
|
+
adUnitId: string;
|
|
327
|
+
responseInfo: ResponseInfo;
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
interface LoadAdMobInterstitialAdOptions {
|
|
264
331
|
/**
|
|
265
|
-
*
|
|
332
|
+
* 광고 단위 ID
|
|
266
333
|
*/
|
|
267
|
-
|
|
334
|
+
adUnitId: string;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* @category 광고
|
|
339
|
+
* @name LoadAdMobInterstitialAdEvent
|
|
340
|
+
* @description 전면 광고를 불러오는 함수에서 발생하는 이벤트 타입이에요. `loaded` 이벤트가 발생하면 광고를 성공적으로 불러온 거예요. 이때 [InterstitialAd](/react-native/reference/framework/광고/InterstitialAd.html) 객체가 함께 반환돼요.
|
|
341
|
+
*/
|
|
342
|
+
type LoadAdMobInterstitialAdEvent = AdMobFullScreenEvent | {
|
|
343
|
+
type: 'loaded';
|
|
344
|
+
data: InterstitialAd;
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
* @category 광고
|
|
349
|
+
* @name LoadAdMobInterstitialAdParams
|
|
350
|
+
* @description 전면 광고를 불러오는 함수에 필요한 옵션 객체예요.
|
|
351
|
+
*/
|
|
352
|
+
type LoadAdMobInterstitialAdParams = AdMobHandlerParams<LoadAdMobInterstitialAdOptions, LoadAdMobInterstitialAdEvent>;
|
|
353
|
+
/**
|
|
354
|
+
* @public
|
|
355
|
+
* @category 광고
|
|
356
|
+
* @name loadAdMobInterstitialAd
|
|
357
|
+
* @description 앱 화면 전체를 덮는 전면 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
|
|
358
|
+
* @param {LoadAdMobInterstitialAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
|
|
359
|
+
* @param {LoadAdMobInterstitialAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
|
|
360
|
+
* @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 전면 광고용 ID를 입력해요.
|
|
361
|
+
* @param {(event: LoadAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobInterstitialAdEvent](/react-native/reference/framework/광고/LoadAdMobInterstitialAdEvent.html)를 참고하세요.
|
|
362
|
+
* @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
|
|
363
|
+
* @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
|
|
364
|
+
*
|
|
365
|
+
* @example
|
|
366
|
+
* ### 버튼 눌러 불러온 전면 광고 보여주기
|
|
367
|
+
* ```tsx
|
|
368
|
+
* import { GoogleAdMob } from '@apps-in-toss/framework';
|
|
369
|
+
* import { useFocusEffect } from '@react-native-bedrock/native/@react-navigation/native';
|
|
370
|
+
* import { useCallback, useState } from 'react';
|
|
371
|
+
* import { Button, Text, View } from 'react-native';
|
|
372
|
+
* import { useNavigation } from 'react-native-bedrock';
|
|
373
|
+
*
|
|
374
|
+
* const AD_UNIT_ID = '<AD_UNIT_ID>';
|
|
375
|
+
*
|
|
376
|
+
* export function GoogleAdmobInterstitialAdExample() {
|
|
377
|
+
* const [adLoadStatus, setAdLoadStatus] = useState<'not_loaded' | 'loaded' | 'failed'>('not_loaded');
|
|
378
|
+
* const navigation = useNavigation();
|
|
379
|
+
*
|
|
380
|
+
* const loadAd = useCallback(() => {
|
|
381
|
+
* if (GoogleAdMob.loadAdMobInterstitialAd.isSupported() !== true) {
|
|
382
|
+
* return;
|
|
383
|
+
* }
|
|
384
|
+
|
|
385
|
+
* const cleanup = GoogleAdMob.loadAdMobInterstitialAd({
|
|
386
|
+
* options: {
|
|
387
|
+
* adUnitId: AD_UNIT_ID,
|
|
388
|
+
* },
|
|
389
|
+
* onEvent: (event) => {
|
|
390
|
+
* switch (event.type) {
|
|
391
|
+
* case 'loaded':
|
|
392
|
+
* console.log('광고 로드 성공', event.data);
|
|
393
|
+
* setAdLoadStatus('loaded');
|
|
394
|
+
* break;
|
|
395
|
+
*
|
|
396
|
+
* case 'clicked':
|
|
397
|
+
* console.log('광고 클릭');
|
|
398
|
+
* break;
|
|
399
|
+
*
|
|
400
|
+
* case 'dismissed':
|
|
401
|
+
* console.log('광고 닫힘');
|
|
402
|
+
* navigation.navigate('/examples/google-admob-interstitial-ad-landing');
|
|
403
|
+
* break;
|
|
404
|
+
*
|
|
405
|
+
* case 'failedToShow':
|
|
406
|
+
* console.log('광고 보여주기 실패');
|
|
407
|
+
* break;
|
|
408
|
+
*
|
|
409
|
+
* case 'impression':
|
|
410
|
+
* console.log('광고 노출');
|
|
411
|
+
* break;
|
|
412
|
+
*
|
|
413
|
+
* case 'show':
|
|
414
|
+
* console.log('광고 컨텐츠 보여졌음');
|
|
415
|
+
* break;
|
|
416
|
+
* }
|
|
417
|
+
* },
|
|
418
|
+
* onError: (error) => {
|
|
419
|
+
* console.error('광고 불러오기 실패', error);
|
|
420
|
+
* },
|
|
421
|
+
* });
|
|
422
|
+
*
|
|
423
|
+
* return cleanup;
|
|
424
|
+
* }, [navigation]);
|
|
425
|
+
*
|
|
426
|
+
* const showAd = useCallback(() => {
|
|
427
|
+
* if (GoogleAdMob.showAdMobInterstitialAd.isSupported() !== true) {
|
|
428
|
+
* return;
|
|
429
|
+
* }
|
|
430
|
+
*
|
|
431
|
+
* GoogleAdMob.showAdMobInterstitialAd({
|
|
432
|
+
* options: {
|
|
433
|
+
* adUnitId: AD_UNIT_ID,
|
|
434
|
+
* },
|
|
435
|
+
* onEvent: (event) => {
|
|
436
|
+
* switch (event.type) {
|
|
437
|
+
* case 'requested':
|
|
438
|
+
* console.log('광고 보여주기 요청 완료');
|
|
439
|
+
* break;
|
|
440
|
+
* }
|
|
441
|
+
* },
|
|
442
|
+
* onError: (error) => {
|
|
443
|
+
* console.error('광고 보여주기 실패', error);
|
|
444
|
+
* },
|
|
445
|
+
* });
|
|
446
|
+
* }, []);
|
|
447
|
+
*
|
|
448
|
+
* useFocusEffect(loadAd);
|
|
449
|
+
*
|
|
450
|
+
* return (
|
|
451
|
+
* <View>
|
|
452
|
+
* <Text>
|
|
453
|
+
* {adLoadStatus === 'not_loaded' && '광고 로드 하지 않음 '}
|
|
454
|
+
* {adLoadStatus === 'loaded' && '광고 로드 완료'}
|
|
455
|
+
* {adLoadStatus === 'failed' && '광고 로드 실패'}
|
|
456
|
+
* </Text>
|
|
457
|
+
*
|
|
458
|
+
* <Button title="Show Ad" onPress={showAd} disabled={adLoadStatus !== 'loaded'} />
|
|
459
|
+
* </View>
|
|
460
|
+
* );
|
|
461
|
+
* }
|
|
462
|
+
* ```
|
|
463
|
+
*/
|
|
464
|
+
declare function loadAdMobInterstitialAd(params: LoadAdMobInterstitialAdParams): () => void;
|
|
465
|
+
declare namespace loadAdMobInterstitialAd {
|
|
466
|
+
var isSupported: () => boolean;
|
|
467
|
+
}
|
|
468
|
+
interface ShowAdMobInterstitialAdOptions {
|
|
268
469
|
/**
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
* - 'CULTURE': 문화비
|
|
272
|
-
* - 'GENERAL': 일반(기본값)
|
|
273
|
-
* - 'PUBLIC_TP': 교통비
|
|
470
|
+
* 광고 단위 ID
|
|
274
471
|
*/
|
|
275
|
-
|
|
472
|
+
adUnitId: string;
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
* @public
|
|
476
|
+
* @category 광고
|
|
477
|
+
* @name ShowAdMobInterstitialAdEvent
|
|
478
|
+
* @description 전면 광고를 보여주는 함수에서 발생하는 이벤트 타입이에요. `requested` 이벤트가 발생하면 광고 노출 요청이 Google AdMob에 성공적으로 전달된 거예요.
|
|
479
|
+
*/
|
|
480
|
+
type ShowAdMobInterstitialAdEvent = {
|
|
481
|
+
type: 'requested';
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* @public
|
|
485
|
+
* @category 광고
|
|
486
|
+
* @name ShowAdMobInterstitialAdParams
|
|
487
|
+
* @description 불러온 전면 광고를 보여주는 함수에 필요한 옵션 객체예요.
|
|
488
|
+
*/
|
|
489
|
+
type ShowAdMobInterstitialAdParams = AdMobHandlerParams<ShowAdMobInterstitialAdOptions, ShowAdMobInterstitialAdEvent>;
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
* @category 광고
|
|
493
|
+
* @name showAdMobInterstitialAd
|
|
494
|
+
* @description 앱 화면 전체를 덮는 전면 광고를 사용자에게 노출해요. 이 함수는 `loadAdMobInterstitialAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
|
|
495
|
+
* @param {ShowAdMobInterstitialAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와과 광고의 동작에 대한 콜백을 설정할 수 있어요.
|
|
496
|
+
* @param {ShowAdMobInterstitialAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
|
|
497
|
+
* @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobInterstitialAd` 로 불러온 전면 광고용 ID를 입력해요.
|
|
498
|
+
* @param {(event: ShowAdMobInterstitialAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobInterstitialAdEvent](/react-native/reference/framework/광고/ShowAdMobInterstitialAdEvent.html)를 참고하세요.
|
|
499
|
+
* @param {(reason: unknown) => void} [params.onError] 광고를 노출하지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
|
|
500
|
+
* @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
|
|
501
|
+
*
|
|
502
|
+
* @example
|
|
503
|
+
* ### 버튼 눌러 불러온 전면 광고 보여주기
|
|
504
|
+
* ```tsx
|
|
505
|
+
* import { GoogleAdMob } from '@apps-in-toss/framework';
|
|
506
|
+
* import { useFocusEffect } from '@react-native-bedrock/native/@react-navigation/native';
|
|
507
|
+
* import { useCallback, useState } from 'react';
|
|
508
|
+
* import { Button, Text, View } from 'react-native';
|
|
509
|
+
* import { useNavigation } from 'react-native-bedrock';
|
|
510
|
+
*
|
|
511
|
+
* const AD_UNIT_ID = '<AD_UNIT_ID>';
|
|
512
|
+
*
|
|
513
|
+
* export function GoogleAdmobInterstitialAdExample() {
|
|
514
|
+
* const [adLoadStatus, setAdLoadStatus] = useState<'not_loaded' | 'loaded' | 'failed'>('not_loaded');
|
|
515
|
+
* const navigation = useNavigation();
|
|
516
|
+
*
|
|
517
|
+
* const loadAd = useCallback(() => {
|
|
518
|
+
* if (GoogleAdMob.loadAdMobInterstitialAd.isSupported() !== true) {
|
|
519
|
+
* return;
|
|
520
|
+
* }
|
|
521
|
+
|
|
522
|
+
* const cleanup = GoogleAdMob.loadAdMobInterstitialAd({
|
|
523
|
+
* options: {
|
|
524
|
+
* adUnitId: AD_UNIT_ID,
|
|
525
|
+
* },
|
|
526
|
+
* onEvent: (event) => {
|
|
527
|
+
* switch (event.type) {
|
|
528
|
+
* case 'loaded':
|
|
529
|
+
* console.log('광고 로드 성공', event.data);
|
|
530
|
+
* setAdLoadStatus('loaded');
|
|
531
|
+
* break;
|
|
532
|
+
*
|
|
533
|
+
* case 'clicked':
|
|
534
|
+
* console.log('광고 클릭');
|
|
535
|
+
* break;
|
|
536
|
+
*
|
|
537
|
+
* case 'dismissed':
|
|
538
|
+
* console.log('광고 닫힘');
|
|
539
|
+
* navigation.navigate('/examples/google-admob-interstitial-ad-landing');
|
|
540
|
+
* break;
|
|
541
|
+
*
|
|
542
|
+
* case 'failedToShow':
|
|
543
|
+
* console.log('광고 보여주기 실패');
|
|
544
|
+
* break;
|
|
545
|
+
*
|
|
546
|
+
* case 'impression':
|
|
547
|
+
* console.log('광고 노출');
|
|
548
|
+
* break;
|
|
549
|
+
*
|
|
550
|
+
* case 'show':
|
|
551
|
+
* console.log('광고 컨텐츠 보여졌음');
|
|
552
|
+
* break;
|
|
553
|
+
* }
|
|
554
|
+
* },
|
|
555
|
+
* onError: (error) => {
|
|
556
|
+
* console.error('광고 불러오기 실패', error);
|
|
557
|
+
* },
|
|
558
|
+
* });
|
|
559
|
+
*
|
|
560
|
+
* return cleanup;
|
|
561
|
+
* }, [navigation]);
|
|
562
|
+
*
|
|
563
|
+
* const showAd = useCallback(() => {
|
|
564
|
+
* if (GoogleAdMob.showAdMobInterstitialAd.isSupported() !== true) {
|
|
565
|
+
* return;
|
|
566
|
+
* }
|
|
567
|
+
*
|
|
568
|
+
* GoogleAdMob.showAdMobInterstitialAd({
|
|
569
|
+
* options: {
|
|
570
|
+
* adUnitId: AD_UNIT_ID,
|
|
571
|
+
* },
|
|
572
|
+
* onEvent: (event) => {
|
|
573
|
+
* switch (event.type) {
|
|
574
|
+
* case 'requested':
|
|
575
|
+
* console.log('광고 보여주기 요청 완료');
|
|
576
|
+
* break;
|
|
577
|
+
* }
|
|
578
|
+
* },
|
|
579
|
+
* onError: (error) => {
|
|
580
|
+
* console.error('광고 보여주기 실패', error);
|
|
581
|
+
* },
|
|
582
|
+
* });
|
|
583
|
+
* }, []);
|
|
584
|
+
*
|
|
585
|
+
* useFocusEffect(loadAd);
|
|
586
|
+
*
|
|
587
|
+
* return (
|
|
588
|
+
* <View>
|
|
589
|
+
* <Text>
|
|
590
|
+
* {adLoadStatus === 'not_loaded' && '광고 로드 하지 않음 '}
|
|
591
|
+
* {adLoadStatus === 'loaded' && '광고 로드 완료'}
|
|
592
|
+
* {adLoadStatus === 'failed' && '광고 로드 실패'}
|
|
593
|
+
* </Text>
|
|
594
|
+
*
|
|
595
|
+
* <Button title="Show Ad" onPress={showAd} disabled={adLoadStatus !== 'loaded'} />
|
|
596
|
+
* </View>
|
|
597
|
+
* );
|
|
598
|
+
* }
|
|
599
|
+
* ```
|
|
600
|
+
*/
|
|
601
|
+
declare function showAdMobInterstitialAd(params: ShowAdMobInterstitialAdParams): () => void;
|
|
602
|
+
declare namespace showAdMobInterstitialAd {
|
|
603
|
+
var isSupported: () => boolean;
|
|
604
|
+
}
|
|
605
|
+
interface LoadAdMobRewardedAdOptions {
|
|
276
606
|
/**
|
|
277
|
-
*
|
|
278
|
-
*
|
|
279
|
-
* - 'USE': 사용(기본값)
|
|
280
|
-
* - 'NO_USE': 할부 미사용
|
|
607
|
+
* 광고 단위 ID
|
|
281
608
|
*/
|
|
282
|
-
|
|
609
|
+
adUnitId: string;
|
|
283
610
|
}
|
|
284
611
|
/**
|
|
285
612
|
* @public
|
|
286
|
-
* @category
|
|
287
|
-
* @name
|
|
288
|
-
* @description
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
* @
|
|
298
|
-
* @
|
|
299
|
-
* @
|
|
300
|
-
* @
|
|
301
|
-
|
|
302
|
-
|
|
613
|
+
* @category 광고
|
|
614
|
+
* @name LoadAdMobInterstitialAdEvent
|
|
615
|
+
* @description 보상형 광고를 불러오는 함수에서 발생하는 이벤트 타입이에요. `loaded` 이벤트가 발생하면 광고를 성공적으로 불러온 거예요. 이때 [RewardedAd](/react-native/reference/framework/광고/RewardedAd.html) 객체가 함께 반환돼요. `userEarnedReward` 이벤트는 사용자가 광고를 끝까지 시청해, 보상 조건을 충족했을 때 발생해요.
|
|
616
|
+
*/
|
|
617
|
+
type LoadAdMobRewardedAdEvent = AdMobFullScreenEvent | {
|
|
618
|
+
type: 'loaded';
|
|
619
|
+
data: RewardedAd;
|
|
620
|
+
} | {
|
|
621
|
+
type: 'userEarnedReward';
|
|
622
|
+
};
|
|
623
|
+
/**
|
|
624
|
+
* @public
|
|
625
|
+
* @category 광고
|
|
626
|
+
* @name LoadAdMobRewardedAdParams
|
|
627
|
+
* @description 보상형 광고를 불러오는 함수에 필요한 옵션 객체예요.
|
|
628
|
+
*/
|
|
629
|
+
type LoadAdMobRewardedAdParams = AdMobHandlerParams<LoadAdMobRewardedAdOptions, LoadAdMobRewardedAdEvent>;
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
* @category 광고
|
|
633
|
+
* @name loadAdMobRewardedAd
|
|
634
|
+
* @description 사용자가 광고를 끝까지 시청하면 리워드를 제공할 수 있는 보상형 광고를 미리 불러와서, 광고가 필요한 시점에 바로 보여줄 수 있도록 준비하는 함수예요.
|
|
635
|
+
* @param {LoadAdMobRewardedAdParams} params 광고를 불러올 때 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
|
|
636
|
+
* @param {LoadAdMobRewardedAdOptions} params.options 광고를 불러올 때 전달할 옵션 객체예요.
|
|
637
|
+
* @param {string} params.options.adUnitId 광고 단위 ID예요. 발급받은 보상형 광고용 ID를 입력해요.
|
|
638
|
+
* @param {(event: LoadAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고가 닫히거나 클릭됐을 때). 자세한 이벤트 타입은 [LoadAdMobRewardedAdEvent](/react-native/reference/framework/광고/LoadAdMobRewardedAdEvent.html)를 참고하세요.
|
|
639
|
+
* @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
|
|
640
|
+
* @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
|
|
303
641
|
*
|
|
304
642
|
* @example
|
|
305
|
-
*
|
|
643
|
+
*
|
|
644
|
+
* ### 버튼 눌러 불러온 보상형 광고 보여주기
|
|
306
645
|
*
|
|
307
646
|
* ```tsx
|
|
308
|
-
* import {
|
|
647
|
+
* import { GoogleAdMob } from '@apps-in-toss/framework';
|
|
648
|
+
* import { useCallback, useState } from 'react';
|
|
649
|
+
* import { Button, Text, View } from 'react-native';
|
|
309
650
|
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
651
|
+
* const AD_UNIT_ID = '<AD_UNIT_ID>';
|
|
652
|
+
*
|
|
653
|
+
* export function GoogleAdmobRewardedAdExample() {
|
|
654
|
+
* const [adLoadStatus, setAdLoadStatus] = useState<'not_loaded' | 'loaded' | 'failed'>('not_loaded');
|
|
655
|
+
*
|
|
656
|
+
* const loadAd = useCallback(() => {
|
|
657
|
+
* if (GoogleAdMob.loadAdMobRewardedAd.isSupported() !== true) {
|
|
658
|
+
* return;
|
|
659
|
+
* }
|
|
660
|
+
*
|
|
661
|
+
* const cleanup = GoogleAdMob.loadAdMobRewardedAd({
|
|
662
|
+
* options: {
|
|
663
|
+
* adUnitId: AD_UNIT_ID,
|
|
664
|
+
* },
|
|
665
|
+
* onEvent: (event) => {
|
|
666
|
+
* console.log(event.type);
|
|
667
|
+
* switch (event.type) {
|
|
668
|
+
* case 'loaded':
|
|
669
|
+
* console.log('광고 로드 성공', event.data);
|
|
670
|
+
* setAdLoadStatus('loaded');
|
|
671
|
+
* break;
|
|
672
|
+
*
|
|
673
|
+
* case 'clicked':
|
|
674
|
+
* console.log('광고 클릭');
|
|
675
|
+
* break;
|
|
676
|
+
*
|
|
677
|
+
* case 'dismissed':
|
|
678
|
+
* console.log('광고 닫힘');
|
|
679
|
+
* break;
|
|
680
|
+
*
|
|
681
|
+
* case 'failedToShow':
|
|
682
|
+
* console.log('광고 보여주기 실패');
|
|
683
|
+
* break;
|
|
684
|
+
*
|
|
685
|
+
* case 'impression':
|
|
686
|
+
* console.log('광고 노출');
|
|
687
|
+
* break;
|
|
688
|
+
*
|
|
689
|
+
* case 'show':
|
|
690
|
+
* console.log('광고 컨텐츠 보여졌음');
|
|
691
|
+
* break;
|
|
692
|
+
*
|
|
693
|
+
* case 'userEarnedReward':
|
|
694
|
+
* console.log('사용자가 광고 시청을 완료했음');
|
|
695
|
+
* break;
|
|
696
|
+
* }
|
|
697
|
+
* },
|
|
698
|
+
* onError: (error) => {
|
|
699
|
+
* console.error('광고 불러오기 실패', error);
|
|
700
|
+
* },
|
|
321
701
|
* });
|
|
322
702
|
*
|
|
323
|
-
*
|
|
324
|
-
* }
|
|
325
|
-
*
|
|
326
|
-
*
|
|
703
|
+
* return cleanup;
|
|
704
|
+
* }, []);
|
|
705
|
+
*
|
|
706
|
+
* const showAd = useCallback(() => {
|
|
707
|
+
* if (GoogleAdMob.showAdMobRewardedAd.isSupported() !== true) {
|
|
708
|
+
* return;
|
|
709
|
+
* }
|
|
710
|
+
*
|
|
711
|
+
* GoogleAdMob.showAdMobRewardedAd({
|
|
712
|
+
* options: {
|
|
713
|
+
* adUnitId: AD_UNIT_ID,
|
|
714
|
+
* },
|
|
715
|
+
* onEvent: (event) => {
|
|
716
|
+
* switch (event.type) {
|
|
717
|
+
* case 'requested':
|
|
718
|
+
* console.log('광고 보여주기 요청 완료');
|
|
719
|
+
* setAdLoadStatus('not_loaded');
|
|
720
|
+
* break;
|
|
721
|
+
* }
|
|
722
|
+
* },
|
|
723
|
+
* onError: (error) => {
|
|
724
|
+
* console.error('광고 보여주기 실패', error);
|
|
725
|
+
* },
|
|
726
|
+
* });
|
|
727
|
+
* }, []);
|
|
728
|
+
*
|
|
729
|
+
* return (
|
|
730
|
+
* <View>
|
|
731
|
+
* <Text>
|
|
732
|
+
* {adLoadStatus === 'not_loaded' && '광고 로드 하지 않음 '}
|
|
733
|
+
* {adLoadStatus === 'loaded' && '광고 로드 완료'}
|
|
734
|
+
* {adLoadStatus === 'failed' && '광고 로드 실패'}
|
|
735
|
+
* </Text>
|
|
736
|
+
*
|
|
737
|
+
* <Button title="Load Ad" onPress={loadAd} />
|
|
738
|
+
* <Button title="Show Ad" onPress={showAd} disabled={adLoadStatus !== 'loaded'} />
|
|
739
|
+
* </View>
|
|
740
|
+
* );
|
|
327
741
|
* }
|
|
328
742
|
* ```
|
|
329
743
|
*/
|
|
330
|
-
declare function
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
744
|
+
declare function loadAdMobRewardedAd(params: LoadAdMobRewardedAdParams): () => void;
|
|
745
|
+
declare namespace loadAdMobRewardedAd {
|
|
746
|
+
var isSupported: () => boolean;
|
|
747
|
+
}
|
|
748
|
+
interface ShowAdMobRewardedAdOptions {
|
|
749
|
+
/**
|
|
750
|
+
* 광고 단위 ID
|
|
751
|
+
*/
|
|
752
|
+
adUnitId: string;
|
|
753
|
+
}
|
|
334
754
|
/**
|
|
335
755
|
* @public
|
|
336
|
-
* @category
|
|
337
|
-
* @name
|
|
338
|
-
* @description
|
|
339
|
-
* @property {string} orderNo 결제를 생성할 때 사용한 주문번호예요.
|
|
340
|
-
* @property {string} payToken 결제 인증 과정에서 전달받은 결제 토큰이에요. 결제를 실행할 때 사용해요.
|
|
756
|
+
* @category 광고
|
|
757
|
+
* @name ShowAdMobRewardedAdEvent
|
|
758
|
+
* @description 보상형 광고를 보여주는 함수에서 발생하는 이벤트 타입이에요. `requested` 이벤트가 발생하면 광고 노출 요청이 Google AdMob에 성공적으로 전달된 거예요.
|
|
341
759
|
*/
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
760
|
+
type ShowAdMobRewardedAdEvent = {
|
|
761
|
+
type: 'requested';
|
|
762
|
+
};
|
|
763
|
+
/**
|
|
764
|
+
* @public
|
|
765
|
+
* @category 광고
|
|
766
|
+
* @name ShowAdMobRewardedAdParams
|
|
767
|
+
* @description 불러온 보상형 광고를 보여주는 함수에 필요한 옵션 객체예요.
|
|
768
|
+
*/
|
|
769
|
+
type ShowAdMobRewardedAdParams = AdMobHandlerParams<ShowAdMobRewardedAdOptions, ShowAdMobRewardedAdEvent>;
|
|
770
|
+
/**
|
|
771
|
+
* @public
|
|
772
|
+
* @category 광고
|
|
773
|
+
* @name showAdMobRewardedAd
|
|
774
|
+
* @description 사용자가 광고를 끝까지 보면 리워드를 받을 수 있도록, 보상형 광고를 화면에 보여줘요. 이 함수는 `loadAdMobRewardedAd` 로 미리 불러온 광고를 실제로 사용자에게 노출해요.
|
|
775
|
+
* @param {ShowAdMobRewardedAdParams} params 광고를 보여주기 위해 사용할 설정 값이에요. 광고 ID와 광고의 동작에 대한 콜백을 설정할 수 있어요.
|
|
776
|
+
* @param {ShowAdMobRewardedAdOptions} params.options 광고를 보여줄 때 전달할 옵션 객체예요.
|
|
777
|
+
* @param {string} params.options.adUnitId 광고 단위 ID예요. `loadAdMobRewardedAd` 로 불러온 보상형 광고용 ID를 입력해요.
|
|
778
|
+
* @param {(event: ShowAdMobRewardedAdEvent) => void} [params.onEvent] 광고 관련 이벤트가 발생했을 때 호출돼요. (예시: 광고 노출을 요청했을 때). 자세한 이벤트 타입은 [ShowAdMobRewardedAdEvent](/react-native/reference/framework/광고/ShowAdMobRewardedAdEvent.html)를 참고하세요.
|
|
779
|
+
* @param {(reason: unknown) => void} [params.onError] 광고를 불러오지 못했을 때 호출돼요. (예시: 네트워크 오류나 지원하지 않는 환경일 때)
|
|
780
|
+
* @property {() => boolean} [isSupported] 현재 실행 중인 앱(예: 토스 앱, 개발용 샌드박스 앱 등)에서 Google AdMob 광고 기능을 지원하는지 확인하는 함수예요. 기능을 사용하기 전에 지원 여부를 확인해야 해요.
|
|
781
|
+
*
|
|
782
|
+
* @example
|
|
783
|
+
* ### 버튼 눌러 불러온 보상형 광고 보여주기
|
|
784
|
+
*
|
|
785
|
+
* ```tsx
|
|
786
|
+
* import { GoogleAdMob } from '@apps-in-toss/framework';
|
|
787
|
+
* import { useCallback, useState } from 'react';
|
|
788
|
+
* import { Button, Text, View } from 'react-native';
|
|
789
|
+
*
|
|
790
|
+
* const AD_UNIT_ID = '<AD_UNIT_ID>';
|
|
791
|
+
*
|
|
792
|
+
* export function GoogleAdmobRewardedAdExample() {
|
|
793
|
+
* const [adLoadStatus, setAdLoadStatus] = useState<'not_loaded' | 'loaded' | 'failed'>('not_loaded');
|
|
794
|
+
*
|
|
795
|
+
* const loadAd = useCallback(() => {
|
|
796
|
+
* if (GoogleAdMob.loadAdMobRewardedAd.isSupported() !== true) {
|
|
797
|
+
* return;
|
|
798
|
+
* }
|
|
799
|
+
*
|
|
800
|
+
* const cleanup = GoogleAdMob.loadAdMobRewardedAd({
|
|
801
|
+
* options: {
|
|
802
|
+
* adUnitId: AD_UNIT_ID,
|
|
803
|
+
* },
|
|
804
|
+
* onEvent: (event) => {
|
|
805
|
+
* console.log(event.type);
|
|
806
|
+
* switch (event.type) {
|
|
807
|
+
* case 'loaded':
|
|
808
|
+
* console.log('광고 로드 성공', event.data);
|
|
809
|
+
* setAdLoadStatus('loaded');
|
|
810
|
+
* break;
|
|
811
|
+
*
|
|
812
|
+
* case 'clicked':
|
|
813
|
+
* console.log('광고 클릭');
|
|
814
|
+
* break;
|
|
815
|
+
*
|
|
816
|
+
* case 'dismissed':
|
|
817
|
+
* console.log('광고 닫힘');
|
|
818
|
+
* break;
|
|
819
|
+
*
|
|
820
|
+
* case 'failedToShow':
|
|
821
|
+
* console.log('광고 보여주기 실패');
|
|
822
|
+
* break;
|
|
823
|
+
*
|
|
824
|
+
* case 'impression':
|
|
825
|
+
* console.log('광고 노출');
|
|
826
|
+
* break;
|
|
827
|
+
*
|
|
828
|
+
* case 'show':
|
|
829
|
+
* console.log('광고 컨텐츠 보여졌음');
|
|
830
|
+
* break;
|
|
831
|
+
*
|
|
832
|
+
* case 'userEarnedReward':
|
|
833
|
+
* console.log('사용자가 광고 시청을 완료했음');
|
|
834
|
+
* break;
|
|
835
|
+
* }
|
|
836
|
+
* },
|
|
837
|
+
* onError: (error) => {
|
|
838
|
+
* console.error('광고 불러오기 실패', error);
|
|
839
|
+
* },
|
|
840
|
+
* });
|
|
841
|
+
*
|
|
842
|
+
* return cleanup;
|
|
843
|
+
* }, []);
|
|
844
|
+
*
|
|
845
|
+
* const showAd = useCallback(() => {
|
|
846
|
+
* if (GoogleAdMob.showAdMobRewardedAd.isSupported() !== true) {
|
|
847
|
+
* return;
|
|
848
|
+
* }
|
|
849
|
+
*
|
|
850
|
+
* GoogleAdMob.showAdMobRewardedAd({
|
|
851
|
+
* options: {
|
|
852
|
+
* adUnitId: AD_UNIT_ID,
|
|
853
|
+
* },
|
|
854
|
+
* onEvent: (event) => {
|
|
855
|
+
* switch (event.type) {
|
|
856
|
+
* case 'requested':
|
|
857
|
+
* console.log('광고 보여주기 요청 완료');
|
|
858
|
+
* setAdLoadStatus('not_loaded');
|
|
859
|
+
* break;
|
|
860
|
+
* }
|
|
861
|
+
* },
|
|
862
|
+
* onError: (error) => {
|
|
863
|
+
* console.error('광고 보여주기 실패', error);
|
|
864
|
+
* },
|
|
865
|
+
* });
|
|
866
|
+
* }, []);
|
|
867
|
+
*
|
|
868
|
+
* return (
|
|
869
|
+
* <View>
|
|
870
|
+
* <Text>
|
|
871
|
+
* {adLoadStatus === 'not_loaded' && '광고 로드 하지 않음 '}
|
|
872
|
+
* {adLoadStatus === 'loaded' && '광고 로드 완료'}
|
|
873
|
+
* {adLoadStatus === 'failed' && '광고 로드 실패'}
|
|
874
|
+
* </Text>
|
|
875
|
+
*
|
|
876
|
+
* <Button title="Load Ad" onPress={loadAd} />
|
|
877
|
+
* <Button title="Show Ad" onPress={showAd} disabled={adLoadStatus !== 'loaded'} />
|
|
878
|
+
* </View>
|
|
879
|
+
* );
|
|
880
|
+
* }
|
|
881
|
+
* ```
|
|
882
|
+
*/
|
|
883
|
+
declare function showAdMobRewardedAd(params: ShowAdMobRewardedAdParams): () => void;
|
|
884
|
+
declare namespace showAdMobRewardedAd {
|
|
885
|
+
var isSupported: () => boolean;
|
|
351
886
|
}
|
|
887
|
+
|
|
352
888
|
/**
|
|
353
889
|
* @public
|
|
354
890
|
* @category 토스페이
|
|
355
|
-
* @name
|
|
356
|
-
* @description
|
|
357
|
-
* @property {
|
|
358
|
-
* @property {number} code 결제 요청의 결과 코드예요.
|
|
359
|
-
* @property {'LIVE' | 'TEST'} mode 현재 결제 환경이에요.
|
|
360
|
-
* @property {string} orderNo 주문번호예요.
|
|
361
|
-
* @property {number} amount 총 결제 금액이에요.
|
|
362
|
-
* @property {string} approvalTime 결제가 승인된 시간이에요. (ISO 8601 형식)
|
|
363
|
-
* @property {string} stateMsg 결제 상태 메시지예요.
|
|
364
|
-
* @property {number} discountedAmount 적용된 할인 금액이에요.
|
|
365
|
-
* @property {number} paidAmount 실제 결제된 금액이에요.
|
|
366
|
-
* @property {string} payToken 결제 요청 시 사용한 Pay 토큰이에요.
|
|
367
|
-
* @property {string} transactionId 거래 ID예요.
|
|
368
|
-
* @property {number} cardCompanyCode 카드사 코드예요.
|
|
369
|
-
* @property {string} cardCompanyName 카드사 이름이에요.
|
|
370
|
-
* @property {string} cardAuthorizationNo 카드사 승인 번호예요. (라이브 결제 환경에서만 확인 가능해요)
|
|
371
|
-
* @property {number} spreadOut 할부 개월 수예요. (5만원 미만 금액 및 일시불 결제의 경우에는 `0`)
|
|
372
|
-
* @property {boolean} noInterest 무이자 할부 여부예요.
|
|
373
|
-
* @property {string} salesCheckLinkUrl 결제 내역을 확인할 수 있는 매출전표 URL이에요.
|
|
374
|
-
* @property {'CREDIT' | 'CHECK' | 'PREPAYMENT'} cardMethodType 카드 유형이에요.
|
|
375
|
-
* @property {string} cardNumber 마스킹된 카드 번호예요. (`****-****-****-1234` 형식)
|
|
376
|
-
* @property {string} cardNum4Print 카드 번호의 마지막 4자리예요.
|
|
377
|
-
* @property {string} cardBinNumber 카드 BIN 번호예요.
|
|
891
|
+
* @name CheckoutPaymentOptions
|
|
892
|
+
* @description 토스페이 결제창을 띄울 때 필요한 옵션이에요.
|
|
893
|
+
* @property {string} payToken 결제 토큰이에요.
|
|
378
894
|
*/
|
|
379
|
-
interface
|
|
380
|
-
/**
|
|
381
|
-
* 결제 수단이에요.
|
|
382
|
-
*/
|
|
383
|
-
payMethod: 'CARD';
|
|
384
|
-
/**
|
|
385
|
-
* 결제 요청의 결과 코드예요.
|
|
386
|
-
*/
|
|
387
|
-
code: number;
|
|
388
|
-
/**
|
|
389
|
-
* 현재 결제 환경이에요.
|
|
390
|
-
*
|
|
391
|
-
* - `LIVE`: 실제 환경
|
|
392
|
-
* - `TEST`: 테스트 환경
|
|
393
|
-
*/
|
|
394
|
-
mode: 'LIVE' | 'TEST';
|
|
395
|
-
/**
|
|
396
|
-
* 주문번호예요.
|
|
397
|
-
*/
|
|
398
|
-
orderNo: string;
|
|
399
|
-
/**
|
|
400
|
-
* 총 결제 금액이에요.
|
|
401
|
-
*/
|
|
402
|
-
amount: number;
|
|
403
|
-
/**
|
|
404
|
-
* 결제가 승인된 시간이에요. (ISO 8601 형식)
|
|
405
|
-
*/
|
|
406
|
-
approvalTime: string;
|
|
407
|
-
/**
|
|
408
|
-
* 결제 상태 메시지예요.
|
|
409
|
-
*/
|
|
410
|
-
stateMsg: string;
|
|
411
|
-
/**
|
|
412
|
-
* 적용된 할인 금액이에요.
|
|
413
|
-
*/
|
|
414
|
-
discountedAmount: number;
|
|
415
|
-
/**
|
|
416
|
-
* 실제 결제된 금액이에요.
|
|
417
|
-
*/
|
|
418
|
-
paidAmount: number;
|
|
895
|
+
interface CheckoutPaymentOptions {
|
|
419
896
|
/**
|
|
420
|
-
* 결제
|
|
897
|
+
* 결제 토큰이에요.
|
|
421
898
|
*/
|
|
422
899
|
payToken: string;
|
|
423
|
-
/**
|
|
424
|
-
* 거래 ID예요.
|
|
425
|
-
*/
|
|
426
|
-
transactionId: string;
|
|
427
|
-
/**
|
|
428
|
-
* 카드사 코드예요.
|
|
429
|
-
*/
|
|
430
|
-
cardCompanyCode: number;
|
|
431
|
-
/**
|
|
432
|
-
* 카드사 이름이에요.
|
|
433
|
-
*/
|
|
434
|
-
cardCompanyName: string;
|
|
435
|
-
/**
|
|
436
|
-
* 카드사 승인 번호예요. (라이브 결제 환경에서만 확인 가능해요)
|
|
437
|
-
*/
|
|
438
|
-
cardAuthorizationNo: string;
|
|
439
|
-
/**
|
|
440
|
-
* 할부 개월 수예요. (5만원 미만 금액 및 일시불 결제의 경우에는 `0`)
|
|
441
|
-
*/
|
|
442
|
-
spreadOut: number;
|
|
443
|
-
/**
|
|
444
|
-
* 무이자 할부 여부예요.
|
|
445
|
-
*/
|
|
446
|
-
noInterest: boolean;
|
|
447
|
-
/**
|
|
448
|
-
* 결제 내역을 확인할 수 있는 매출전표 URL이에요.
|
|
449
|
-
*/
|
|
450
|
-
salesCheckLinkUrl: string;
|
|
451
|
-
/**
|
|
452
|
-
* 카드 유형이에요.
|
|
453
|
-
*
|
|
454
|
-
* - 'CREDIT': 신용카드
|
|
455
|
-
* - 'CHECK': 체크카드
|
|
456
|
-
* - 'PREPAYMENT': 선불카드
|
|
457
|
-
*/
|
|
458
|
-
cardMethodType: 'CREDIT' | 'CHECK' | 'PREPAYMENT';
|
|
459
|
-
/**
|
|
460
|
-
* 마스킹된 카드 번호예요. (`****-****-****-1234` 형식)
|
|
461
|
-
*/
|
|
462
|
-
cardNumber: string;
|
|
463
|
-
/**
|
|
464
|
-
* 카드 사용자 구분을 나타내는 값이에요.
|
|
465
|
-
*
|
|
466
|
-
* - 'PERSONAL': 개인 카드
|
|
467
|
-
* - 'PERSONAL_FAMILY': 가족 카드
|
|
468
|
-
* - 'CORP_PERSONAL': 법인지정 결제계좌 (임직원)
|
|
469
|
-
* - 'CORP_PRIVATE': 법인 공용
|
|
470
|
-
* - 'CORP_COMPANY': 법인지정 결제계좌 회사 (하나카드 Only)
|
|
471
|
-
*/
|
|
472
|
-
cardUserType: 'PERSONAL' | 'PERSONAL_FAMILY' | 'CORP_PERSONAL' | 'CORP_PRIVATE' | 'CORP_COMPANY';
|
|
473
|
-
/**
|
|
474
|
-
* 카드 번호의 마지막 4자리예요.
|
|
475
|
-
*/
|
|
476
|
-
cardNum4Print: string;
|
|
477
|
-
/**
|
|
478
|
-
* 카드 BIN 번호예요.
|
|
479
|
-
*/
|
|
480
|
-
cardBinNumber: string;
|
|
481
900
|
}
|
|
482
901
|
/**
|
|
483
902
|
* @public
|
|
484
903
|
* @category 토스페이
|
|
485
|
-
* @name
|
|
486
|
-
* @description
|
|
487
|
-
* @property {
|
|
488
|
-
* @property {
|
|
489
|
-
* @property {'LIVE' | 'TEST'} mode 현재 결제 환경이에요.
|
|
490
|
-
* @property {string} orderNo 주문번호예요.
|
|
491
|
-
* @property {number} amount 총 결제 금액이에요.
|
|
492
|
-
* @property {string} approvalTime 결제가 승인된 시간이에요. (ISO 8601 형식)
|
|
493
|
-
* @property {string} stateMsg 결제 상태 메시지예요.
|
|
494
|
-
* @property {number} discountedAmount 적용된 할인 금액이에요.
|
|
495
|
-
* @property {number} paidAmount 실제 결제된 금액이에요.
|
|
496
|
-
* @property {string} payToken 결제 요청 시 사용한 Pay 토큰이에요.
|
|
497
|
-
* @property {string} transactionId 거래 ID예요.
|
|
498
|
-
* @property {string} cashReceiptMgtKey 현금영수증 관리번호 식별값이에요.
|
|
499
|
-
* @property {string} accountBankName 결제된 은행의 코드예요.
|
|
500
|
-
* @property {string} accountNumber 결제된 계좌번호예요.
|
|
904
|
+
* @name CheckoutPaymentResult
|
|
905
|
+
* @description 토스페이 결제창에서 사용자가 인증에 성공했는지 여부예요.
|
|
906
|
+
* @property {boolean} success 인증이 성공했는지 여부예요.
|
|
907
|
+
* @property {string} [reason] 인증이 실패했을 경우의 이유예요.
|
|
501
908
|
*/
|
|
502
|
-
interface
|
|
503
|
-
/**
|
|
504
|
-
* 결제에 사용된 결제 수단이에요.
|
|
505
|
-
*/
|
|
506
|
-
payMethod: 'TOSS_MONEY';
|
|
507
|
-
/**
|
|
508
|
-
* 결제 요청의 결과 코드예요.
|
|
509
|
-
*/
|
|
510
|
-
code: number;
|
|
909
|
+
interface CheckoutPaymentResult {
|
|
511
910
|
/**
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
* - `LIVE`: 실제 환경
|
|
515
|
-
* - `TEST`: 테스트 환경
|
|
911
|
+
* 인증이 성공했는지 여부예요.
|
|
516
912
|
*/
|
|
517
|
-
|
|
913
|
+
success: boolean;
|
|
518
914
|
/**
|
|
519
|
-
*
|
|
915
|
+
* 인증이 실패했을 경우의 이유예요.
|
|
520
916
|
*/
|
|
521
|
-
|
|
522
|
-
/**
|
|
523
|
-
* 결제 승인된 상품의 총 결제 금액이에요.
|
|
524
|
-
*/
|
|
525
|
-
amount: number;
|
|
526
|
-
/**
|
|
527
|
-
* 결제가 승인된 시간이에요. (ISO 8601 형식)
|
|
528
|
-
*/
|
|
529
|
-
approvalTime: string;
|
|
530
|
-
/**
|
|
531
|
-
* 결제 상태 메시지예요.
|
|
532
|
-
*/
|
|
533
|
-
stateMsg: string;
|
|
534
|
-
/**
|
|
535
|
-
* 적용된 할인 금액이에요.
|
|
536
|
-
*/
|
|
537
|
-
discountedAmount: number;
|
|
538
|
-
/**
|
|
539
|
-
* 실제 결제 승인된 금액이에요.
|
|
540
|
-
*/
|
|
541
|
-
paidAmount: number;
|
|
542
|
-
/**
|
|
543
|
-
* 결제 요청 시 사용한 Pay 토큰이에요.
|
|
544
|
-
*/
|
|
545
|
-
payToken: string;
|
|
546
|
-
/**
|
|
547
|
-
* 거래 ID예요.
|
|
548
|
-
*/
|
|
549
|
-
transactionId: string;
|
|
550
|
-
/**
|
|
551
|
-
* 현금영수증 관리번호 식별값이에요.
|
|
552
|
-
*/
|
|
553
|
-
cashReceiptMgtKey: string;
|
|
554
|
-
/**
|
|
555
|
-
* 결제된 은행의 코드예요.
|
|
556
|
-
*/
|
|
557
|
-
accountBankName: string;
|
|
558
|
-
/**
|
|
559
|
-
* 결제된 계좌번호예요.
|
|
560
|
-
*/
|
|
561
|
-
accountNumber: string;
|
|
917
|
+
reason?: string;
|
|
562
918
|
}
|
|
563
919
|
/**
|
|
564
920
|
* @public
|
|
565
921
|
* @category 토스페이
|
|
566
|
-
* @name
|
|
567
|
-
* @description
|
|
922
|
+
* @name checkoutPayment
|
|
923
|
+
* @description 토스페이 결제창을 띄우고, 사용자 인증을 수행해요. 인증이 완료되면 성공 여부를 반환해요.
|
|
568
924
|
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
* @param {
|
|
572
|
-
* @returns {Promise<
|
|
925
|
+
* 이 함수는 결제창을 통해 사용자 인증만 해요. 실제 결제 처리는 인증 성공 후 서버에서 별도로 해야 해요.
|
|
926
|
+
*
|
|
927
|
+
* @param {CheckoutPaymentOptions} options 결제창을 띄울 때 필요한 옵션이에요.
|
|
928
|
+
* @returns {Promise<CheckoutPaymentResult>} 인증 성공 여부를 포함한 결과를 반환해요.
|
|
573
929
|
*
|
|
574
930
|
* @example
|
|
575
931
|
*
|
|
576
|
-
* ###
|
|
932
|
+
* ### 토스페이 결제창 띄우고 인증 처리하기
|
|
577
933
|
*
|
|
578
934
|
* ```tsx
|
|
579
935
|
* import { TossPay } from '@apps-in-toss/framework';
|
|
580
936
|
*
|
|
581
937
|
* async function handlePayment() {
|
|
582
938
|
* try {
|
|
583
|
-
*
|
|
939
|
+
* // 실제 구현 시 결제 생성 역할을 하는 API 엔드포인트로 대체해주세요.
|
|
940
|
+
* const { payToken } = await fetch('/my-api/payment/create').then(res => res.json());
|
|
584
941
|
*
|
|
585
|
-
* const
|
|
586
|
-
* orderNo: 'ORDER_12345',
|
|
587
|
-
* payToken,
|
|
588
|
-
* });
|
|
942
|
+
* const { success, reason } = await TossPay.checkoutPayment({ payToken });
|
|
589
943
|
*
|
|
590
|
-
*
|
|
944
|
+
* if (success) {
|
|
945
|
+
* // 실제 구현 시 결제를 실행하는 API 엔드포인트로 대체해주세요.
|
|
946
|
+
* await fetch('/my-api/payment/execute', {
|
|
947
|
+
* method: 'POST',
|
|
948
|
+
* body: JSON.stringify({ payToken }),
|
|
949
|
+
* headers: { 'Content-Type': 'application/json' },
|
|
950
|
+
* });
|
|
951
|
+
* } else {
|
|
952
|
+
* console.log('인증 실패:', reason);
|
|
953
|
+
* }
|
|
591
954
|
* } catch (error) {
|
|
592
|
-
* console.error('
|
|
955
|
+
* console.error('결제 인증 중 오류가 발생했어요:', error);
|
|
593
956
|
* }
|
|
594
957
|
* }
|
|
595
958
|
* ```
|
|
596
959
|
*/
|
|
597
|
-
declare function
|
|
960
|
+
declare function checkoutPayment(options: CheckoutPaymentOptions): Promise<CheckoutPaymentResult>;
|
|
598
961
|
|
|
599
962
|
/**
|
|
600
963
|
* @public
|
|
@@ -858,7 +1221,7 @@ interface GetCurrentLocationOptions {
|
|
|
858
1221
|
*
|
|
859
1222
|
* @param {GetCurrentLocationOptions} options 위치 정보를 가져올 때 사용하는 옵션 객체예요.
|
|
860
1223
|
* @param {Accuracy} [options.accuracy] 위치 정보의 정확도 수준이에요. 정확도는 `Accuracy` 타입으로 설정돼요.
|
|
861
|
-
* @returns {Promise<Location>} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
|
|
1224
|
+
* @returns {Promise<Location>} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/react-native/reference/framework/Types/Location.html)을 참고해주세요.
|
|
862
1225
|
*
|
|
863
1226
|
* @example
|
|
864
1227
|
* ### 디바이스의 현재 위치 정보 가져오기
|
|
@@ -1027,17 +1390,293 @@ declare function appLogin(): Promise<{
|
|
|
1027
1390
|
*/
|
|
1028
1391
|
declare function getOperationalEnvironment(): 'toss' | 'sandbox';
|
|
1029
1392
|
|
|
1393
|
+
/**
|
|
1394
|
+
* @public
|
|
1395
|
+
* @category 환경 확인
|
|
1396
|
+
* @name getTossAppVersion
|
|
1397
|
+
* @description 토스 앱 버전을 가져옵니다. 예를 들어, `5.206.0`과 같은 형태로 반환돼요. 토스 앱 버전을 로그로 남기거나, 특정 기능이 특정 버전 이상에서만 실행될 때 사용돼요.
|
|
1398
|
+
* @signature
|
|
1399
|
+
* ```typescript
|
|
1400
|
+
* function getTossAppVersion(): string
|
|
1401
|
+
* ```
|
|
1402
|
+
*
|
|
1403
|
+
* @returns {string} 토스 앱 버전
|
|
1404
|
+
*
|
|
1405
|
+
* @example
|
|
1406
|
+
*
|
|
1407
|
+
*
|
|
1408
|
+
* ### 토스 앱 버전 확인하기
|
|
1409
|
+
*
|
|
1410
|
+
* ```tsx
|
|
1411
|
+
* import { getTossAppVersion } from '@apps-in-toss/framework';
|
|
1412
|
+
* import { Text } from 'react-native';
|
|
1413
|
+
*
|
|
1414
|
+
* export function TossAppVersionPage() {
|
|
1415
|
+
* return (
|
|
1416
|
+
* <Text>{getTossAppVersion()}</Text>
|
|
1417
|
+
* )
|
|
1418
|
+
* }
|
|
1419
|
+
* ```
|
|
1420
|
+
*/
|
|
1421
|
+
declare function getTossAppVersion(): string;
|
|
1422
|
+
|
|
1423
|
+
/**
|
|
1424
|
+
* @public
|
|
1425
|
+
* @category 환경 확인
|
|
1426
|
+
* @kind function
|
|
1427
|
+
* @name getDeviceId
|
|
1428
|
+
* @description
|
|
1429
|
+
* 사용 중인 기기의 고유 식별자를 문자열로 반환해요.
|
|
1430
|
+
*
|
|
1431
|
+
* 이 함수는 현재 사용 중인 기기의 고유 식별자를 문자열로 반환해요. 기기별로 설정이나 데이터를 저장하거나 사용자의 기기를 식별해서 로그를 기록하고 분석하는 데 사용할 수 있어요. 같은 사용자의 여러 기기를 구분하는 데도 유용해요.
|
|
1432
|
+
*
|
|
1433
|
+
* @returns {string} 기기의 고유 식별자를 나타내는 문자열이에요.
|
|
1434
|
+
*
|
|
1435
|
+
* @example
|
|
1436
|
+
* ### 기기 고유 식별자 가져오기
|
|
1437
|
+
*
|
|
1438
|
+
* ```tsx
|
|
1439
|
+
* import { getDeviceId } from '@apps-in-toss/framework';
|
|
1440
|
+
* import { Text } from 'react-native';
|
|
1441
|
+
*
|
|
1442
|
+
* function MyPage() {
|
|
1443
|
+
* const id = getDeviceId();
|
|
1444
|
+
*
|
|
1445
|
+
* return (
|
|
1446
|
+
* <Text>사용자의 기기 고유 식별자: {id}</Text>
|
|
1447
|
+
* );
|
|
1448
|
+
* }
|
|
1449
|
+
* ```
|
|
1450
|
+
*/
|
|
1451
|
+
declare function getDeviceId(): string;
|
|
1452
|
+
|
|
1453
|
+
/**
|
|
1454
|
+
* @public
|
|
1455
|
+
* @category 저장소
|
|
1456
|
+
* @name getItem
|
|
1457
|
+
* @description 모바일 앱의 로컬 저장소에서 문자열 데이터를 가져와요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
|
|
1458
|
+
* @param {string} key - 가져올 아이템의 키를 입력해요.
|
|
1459
|
+
* @returns {Promise<string | null>} 지정한 키에 저장된 문자열 값을 반환해요. 값이 없으면 `null`을 반환해요.
|
|
1460
|
+
* @example
|
|
1461
|
+
*
|
|
1462
|
+
* ### `my-key`에 저장된 아이템 가져오기
|
|
1463
|
+
* ```ts
|
|
1464
|
+
* const value = await Storage.getItem('my-key');
|
|
1465
|
+
* console.log(value); // 'value'
|
|
1466
|
+
* ```
|
|
1467
|
+
*/
|
|
1468
|
+
declare function getItem(key: string): Promise<string | null>;
|
|
1469
|
+
/**
|
|
1470
|
+
* @public
|
|
1471
|
+
* @category 저장소
|
|
1472
|
+
* @name setItem
|
|
1473
|
+
* @description 모바일 앱의 로컬 저장소에 문자열 데이터를 저장해요. 주로 앱이 종료되었다가 다시 시작해도 데이터가 유지되어야 하는 경우에 사용해요.
|
|
1474
|
+
* @param {string} key - 저장할 아이템의 키를 입력해요.
|
|
1475
|
+
* @param {string} value - 저장할 아이템의 값을 입력해요.
|
|
1476
|
+
* @returns {Promise<void>} 아이템을 성공적으로 저장하면 아무 값도 반환하지 않아요.
|
|
1477
|
+
* @example
|
|
1478
|
+
*
|
|
1479
|
+
* ### `my-key`에 아이템 저장하기
|
|
1480
|
+
* ```ts
|
|
1481
|
+
* import { Storage } from '@apps-in-toss/framework';
|
|
1482
|
+
*
|
|
1483
|
+
* await Storage.setItem('my-key', 'value');
|
|
1484
|
+
* ```
|
|
1485
|
+
*/
|
|
1486
|
+
declare function setItem(key: string, value: string): Promise<void>;
|
|
1487
|
+
/**
|
|
1488
|
+
* @public
|
|
1489
|
+
* @category 저장소
|
|
1490
|
+
* @name removeItem
|
|
1491
|
+
* @description 모바일 앱의 로컬 저장소에서 특정 키에 해당하는 아이템을 삭제해요.
|
|
1492
|
+
* @param {string} key - 삭제할 아이템의 키를 입력해요.
|
|
1493
|
+
* @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않아요.
|
|
1494
|
+
* @example
|
|
1495
|
+
*
|
|
1496
|
+
* ### `my-key`에 저장된 아이템 삭제하기
|
|
1497
|
+
* ```ts
|
|
1498
|
+
* import { Storage } from '@apps-in-toss/framework';
|
|
1499
|
+
*
|
|
1500
|
+
* await Storage.removeItem('my-key');
|
|
1501
|
+
* ```
|
|
1502
|
+
*/
|
|
1503
|
+
declare function removeItem(key: string): Promise<void>;
|
|
1504
|
+
/**
|
|
1505
|
+
* @public
|
|
1506
|
+
* @category 저장소
|
|
1507
|
+
* @name clearItems
|
|
1508
|
+
* @description 모바일 앱의 로컬 저장소의 모든 아이템을 삭제해요.
|
|
1509
|
+
* @returns {Promise<void>} 아이템을 삭제하면 아무 값도 반환하지 않고 저장소가 초기화돼요.
|
|
1510
|
+
* @example
|
|
1511
|
+
*
|
|
1512
|
+
* ### 저장소 초기화하기
|
|
1513
|
+
* ```ts
|
|
1514
|
+
* import { Storage } from '@apps-in-toss/framework';
|
|
1515
|
+
*
|
|
1516
|
+
* await Storage.clearItems();
|
|
1517
|
+
* ```
|
|
1518
|
+
*/
|
|
1519
|
+
declare function clearItems(): Promise<void>;
|
|
1520
|
+
/**
|
|
1521
|
+
* @public
|
|
1522
|
+
* @category 저장소
|
|
1523
|
+
* @name Storage
|
|
1524
|
+
* @description 네이티브의 저장소를 사용해요.
|
|
1525
|
+
* @property {typeof getItem} [getItem] 모바일 앱의 로컬 저장소에서 아이템을 가져오는 함수예요. 자세한 내용은 [getItem](/react-native/reference/framework/저장소/getItem.html)을 참고하세요.
|
|
1526
|
+
* @property {typeof setItem} [setItem] 모바일 앱의 로컬 저장소에 아이템을 저장하는 함수예요. 자세한 내용은 [setItem](/react-native/reference/framework/저장소/setItem.html)을 참고하셰요.
|
|
1527
|
+
* @property {typeof removeItem} [removeItem] 모바일 앱의 로컬 저장소에서 아이템을 삭제하는 함수예요. 자세한 내용은 [removeItem](/react-native/reference/framework/저장소/removeItem.html)을 참고하세요.
|
|
1528
|
+
* @property {typeof clearItems} [clearItems] 모바일 앱의 로컬 저장소를 초기화하는 함수예요. 자세한 내용은 [clearItems](/react-native/reference/framework/저장소/clearItems.html)을 참고하세요.
|
|
1529
|
+
*/
|
|
1530
|
+
declare const Storage: {
|
|
1531
|
+
getItem: typeof getItem;
|
|
1532
|
+
setItem: typeof setItem;
|
|
1533
|
+
removeItem: typeof removeItem;
|
|
1534
|
+
clearItems: typeof clearItems;
|
|
1535
|
+
};
|
|
1536
|
+
|
|
1537
|
+
/**
|
|
1538
|
+
* @public
|
|
1539
|
+
* @category 환경 확인
|
|
1540
|
+
* @kind function
|
|
1541
|
+
* @name isMinVersionSupported
|
|
1542
|
+
* @description
|
|
1543
|
+
* 현재 토스 앱 버전이 지정한 최소 버전 이상인지 확인해요.
|
|
1544
|
+
*
|
|
1545
|
+
* 이 함수는 현재 실행 중인 토스 앱의 버전이 파라미터로 전달된 최소 버전 요구사항을 충족하는지 확인해요. 특정 기능이 최신 버전에서만 동작할 때, 사용자에게 앱 업데이트를 안내할 수 있어요.
|
|
1546
|
+
*
|
|
1547
|
+
* @param {Object} minVersions 플랫폼별 최소 버전 요구사항을 지정하는 객체예요.
|
|
1548
|
+
* @param {(`${number}.${number}.${number}` | 'always' | 'never')} minVersions.android 안드로이드 플랫폼의 최소 버전 요구사항이에요.
|
|
1549
|
+
* @param {(`${number}.${number}.${number}` | 'always' | 'never')} minVersions.ios iOS 플랫폼의 최소 버전 요구사항이에요.
|
|
1550
|
+
* @returns {boolean} 현재 앱 버전이 최소 버전 이상이면 true, 그렇지 않으면 false를 반환해요.
|
|
1551
|
+
*
|
|
1552
|
+
* @example
|
|
1553
|
+
* ### 앱 버전 확인하기
|
|
1554
|
+
*
|
|
1555
|
+
* ```tsx
|
|
1556
|
+
* import { isMinVersionSupported } from '@apps-in-toss/framework';
|
|
1557
|
+
* import { Text, View } from 'react-native';
|
|
1558
|
+
*
|
|
1559
|
+
* function VersionCheck() {
|
|
1560
|
+
* const isSupported = isMinVersionSupported({
|
|
1561
|
+
* android: '1.2.0',
|
|
1562
|
+
* ios: '1.3.0'
|
|
1563
|
+
* });
|
|
1564
|
+
*
|
|
1565
|
+
* return (
|
|
1566
|
+
* <View>
|
|
1567
|
+
* {!isSupported && (
|
|
1568
|
+
* <Text>최신 버전으로 업데이트가 필요해요.</Text>
|
|
1569
|
+
* )}
|
|
1570
|
+
* </View>
|
|
1571
|
+
* );
|
|
1572
|
+
* }
|
|
1573
|
+
* ```
|
|
1574
|
+
*/
|
|
1575
|
+
declare function isMinVersionSupported(minVersions: {
|
|
1576
|
+
android: `${number}.${number}.${number}` | 'always' | 'never';
|
|
1577
|
+
ios: `${number}.${number}.${number}` | 'always' | 'never';
|
|
1578
|
+
}): boolean;
|
|
1579
|
+
|
|
1580
|
+
type Primitive = string | number | boolean | null | undefined | symbol;
|
|
1581
|
+
|
|
1582
|
+
interface EventLogParams {
|
|
1583
|
+
log_name: string;
|
|
1584
|
+
log_type: 'debug' | 'info' | 'warn' | 'error' | 'screen' | 'impression' | 'click';
|
|
1585
|
+
params: Record<string, Primitive>;
|
|
1586
|
+
}
|
|
1587
|
+
/**
|
|
1588
|
+
* @category 로깅
|
|
1589
|
+
* @kind function
|
|
1590
|
+
* @name eventLog
|
|
1591
|
+
* @description
|
|
1592
|
+
* 이벤트 로그를 기록하는 함수예요.
|
|
1593
|
+
*
|
|
1594
|
+
* 이 함수는 앱 내에서 발생하는 다양한 이벤트를 로깅하는 데 사용돼요. 디버깅, 정보 제공, 경고, 오류 등 다양한 유형의 로그를 기록할 수 있어요. 샌드박스 환경에서는 콘솔에 로그가 출력되고, 실제 환경에서는 로그 시스템에 기록돼요.
|
|
1595
|
+
*
|
|
1596
|
+
* @param {Object} params 로그 기록에 필요한 매개변수 객체예요.
|
|
1597
|
+
* @param {string} params.log_name 로그의 이름이에요.
|
|
1598
|
+
* @param {'debug' | 'info' | 'warn' | 'error' | 'screen' | 'impression' | 'click'} params.log_type 로그의 유형이에요.
|
|
1599
|
+
* @param {Record<string, Primitive>} params.params 로그에 포함할 추가 매개변수 객체예요.
|
|
1600
|
+
*
|
|
1601
|
+
* @returns {Promise<void>} 로그 기록이 완료되면 해결되는 Promise예요.
|
|
1602
|
+
*
|
|
1603
|
+
* @example
|
|
1604
|
+
* ### 이벤트 로그 기록하기
|
|
1605
|
+
*
|
|
1606
|
+
* ```tsx
|
|
1607
|
+
* import { eventLog } from '@apps-in-toss/framework';
|
|
1608
|
+
*
|
|
1609
|
+
* function logUserAction() {
|
|
1610
|
+
* eventLog({
|
|
1611
|
+
* log_name: 'user_action',
|
|
1612
|
+
* log_type: 'info',
|
|
1613
|
+
* params: {
|
|
1614
|
+
* action: 'button_click',
|
|
1615
|
+
* screen: 'main',
|
|
1616
|
+
* userId: 12345
|
|
1617
|
+
* }
|
|
1618
|
+
* });
|
|
1619
|
+
* }
|
|
1620
|
+
* ```
|
|
1621
|
+
*/
|
|
1622
|
+
declare function eventLog(params: EventLogParams): Promise<void>;
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* @public
|
|
1626
|
+
* @category 공유
|
|
1627
|
+
* @kind function
|
|
1628
|
+
* @name getTossShareLink
|
|
1629
|
+
* @description
|
|
1630
|
+
* `getTossShareLink` 함수는 사용자가 지정한 경로를 토스 앱에서 열 수 있는 공유 링크를 반환해요.
|
|
1631
|
+
* 이 링크를 다른 사람과 공유하면 토스 앱이 실행되면서 지정한 경로로 진입해요. 토스앱이 없는 사람은 iOS 일 때는 앱스토어로 이동하고, Android 일 때는 플레이스토어로 이동해요.
|
|
1632
|
+
*
|
|
1633
|
+
* 경로는 토스 앱 내부 특정 화면을 나타내는 딥링크(deep link) 형식이어야 해요.
|
|
1634
|
+
* 예를 들어 `intoss://<앱 이름>`이나 `intoss://<앱 이름>/about?name=test`처럼 작성해요.
|
|
1635
|
+
*
|
|
1636
|
+
* 이 함수를 사용하면 `deep_link_value`를 포함한 완성된 공유 링크를 만들 수 있어요.
|
|
1637
|
+
*
|
|
1638
|
+
* @param path - 딥링크로 열고 싶은 경로예요. `intoss://`로 시작하는 문자열이어야 해요.
|
|
1639
|
+
* @returns {Promise<string>} `deep_link_value`가 포함된 토스 공유 링크를 반환해요.
|
|
1640
|
+
*
|
|
1641
|
+
* @example
|
|
1642
|
+
* ```tsx
|
|
1643
|
+
* import { share } from 'react-native-bedrock';
|
|
1644
|
+
* import { getTossShareLink } from '@apps-in-toss/framework';
|
|
1645
|
+
*
|
|
1646
|
+
* // '/' 경로를 딥링크로 포함한 토스 공유 링크를 생성해요.
|
|
1647
|
+
* const tossLink = await getTossShareLink('intoss://my-app');
|
|
1648
|
+
*
|
|
1649
|
+
* // 생성한 링크를 메시지로 공유해요.
|
|
1650
|
+
* await share({ message: tossLink });
|
|
1651
|
+
* ```
|
|
1652
|
+
*/
|
|
1653
|
+
declare function getTossShareLink(path: string): Promise<string>;
|
|
1654
|
+
|
|
1030
1655
|
/**
|
|
1031
1656
|
* @public
|
|
1032
1657
|
* @category 토스페이
|
|
1033
1658
|
* @name TossPay
|
|
1034
1659
|
* @description 토스페이 결제 관련 함수를 모아둔 객체예요.
|
|
1035
|
-
* @property {typeof checkoutPayment} [checkoutPayment] 토스페이 결제를
|
|
1036
|
-
* @property {typeof executePayment} [executePayment] 토스페이 결제를 실행하는 함수예요. 자세한 내용은 [executePayment](reference/framework/토스페이/executePayment)를 참고하세요.
|
|
1660
|
+
* @property {typeof checkoutPayment} [checkoutPayment] 토스페이 결제를 인증하는 함수예요. 자세한 내용은 [checkoutPayment](/react-native/reference/framework/토스페이/checkoutPayment)를 참고하세요.
|
|
1037
1661
|
*/
|
|
1038
1662
|
declare const TossPay: {
|
|
1039
1663
|
checkoutPayment: typeof checkoutPayment;
|
|
1040
|
-
|
|
1664
|
+
};
|
|
1665
|
+
/**
|
|
1666
|
+
* @public
|
|
1667
|
+
* @category 광고
|
|
1668
|
+
* @name GoogleAdMob
|
|
1669
|
+
* @description Google AdMob 광고 관련 함수를 모아둔 객체예요.
|
|
1670
|
+
* @property {typeof loadAdMobInterstitialAd} [loadAdMobInterstitialAd] 전면 광고를 로드하는 함수예요. 자세한 내용은 [loadAdMobInterstitialAd](/react-native/reference/framework/광고/loadAdMobInterstitialAd.html)를 참고하세요.
|
|
1671
|
+
* @property {typeof showAdMobInterstitialAd} [showAdMobInterstitialAd] 로드한 전면 광고를 보여주는 함수예요. 자세한 내용은 [showAdMobInterstitialAd](/react-native/reference/framework/광고/showAdMobInterstitialAd.html)를 참고하세요.
|
|
1672
|
+
* @property {typeof loadAdMobRewardedAd} [loadAdMobRewardedAd] 보상형 광고를 로드하는 함수예요. 자세한 내용은 [loadAdMobRewardedAd](/react-native/reference/framework/광고/loadAdMobRewardedAd.html)를 참고하세요.
|
|
1673
|
+
* @property {typeof showAdMobRewardedAd} [showAdMobRewardedAd] 로드한 보상형 광고를 보여주는 함수예요. 자세한 내용은 [showAdMobRewardedAd](/react-native/reference/framework/광고/showAdMobRewardedAd.html)를 참고하세요.
|
|
1674
|
+
*/
|
|
1675
|
+
declare const GoogleAdMob: {
|
|
1676
|
+
loadAdMobInterstitialAd: typeof loadAdMobInterstitialAd;
|
|
1677
|
+
showAdMobInterstitialAd: typeof showAdMobInterstitialAd;
|
|
1678
|
+
loadAdMobRewardedAd: typeof loadAdMobRewardedAd;
|
|
1679
|
+
showAdMobRewardedAd: typeof showAdMobRewardedAd;
|
|
1041
1680
|
};
|
|
1042
1681
|
|
|
1043
1682
|
type GameWebViewProps$1 = WebViewProps$1;
|
|
@@ -1062,7 +1701,7 @@ interface LocalNetwork {
|
|
|
1062
1701
|
type InternalProps = 'source' | 'cacheEnabled' | 'sharedCookiesEnabled' | 'thirdPartyCookiesEnabled' | 'injectedJavaScriptBeforeContentLoaded';
|
|
1063
1702
|
declare function WebView({ type, local, onMessage, ...props }: WebViewProps): react_jsx_runtime.JSX.Element;
|
|
1064
1703
|
|
|
1065
|
-
type UseGeolocationOptions = Omit<StartUpdateLocationOptions, 'callback'>;
|
|
1704
|
+
type UseGeolocationOptions = Omit<StartUpdateLocationOptions$1, 'callback'>;
|
|
1066
1705
|
/**
|
|
1067
1706
|
* @public
|
|
1068
1707
|
* @category 위치 정보
|
|
@@ -1076,7 +1715,7 @@ type UseGeolocationOptions = Omit<StartUpdateLocationOptions, 'callback'>;
|
|
|
1076
1715
|
* @param {Accuracy} [options.accuracy] 위치 정확도를 설정해요. `Accuracy.Lowest`: 오차범위 3KM 이내, `Accuracy.Low`: 오차범위 1KM 이내, `Accuracy.Balanced`: 오차범위 몇 백미터 이내, `Accuracy.High`: 오차범위 10M 이내, `Accuracy.Highest`: 가장 높은 정확도, `Accuracy.BestForNavigation`: 네비게이션을 위한 최고 정확도
|
|
1077
1716
|
* @param {number} [options.timeInterval] 위치 정보를 업데이트하는 최소 주기로, 단위는 밀리초(ms)예요. 이 값은 위치 업데이트가 발생하는 가장 짧은 간격을 설정하지만, 시스템이나 환경의 영향을 받아 지정한 주기보다 더 긴 간격으로 업데이트될 수 있어요.
|
|
1078
1717
|
* @param {number} [options.distanceInterval] 위치 변경 거리를 미터(m) 단위로 설정해요.
|
|
1079
|
-
* @returns {Location | null} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/reference/framework/Types/Location.html)을 참고해주세요.
|
|
1718
|
+
* @returns {Location | null} 디바이스의 위치 정보가 담긴 객체를 반환해요. 자세한 내용은 [Location](/react-native/reference/framework/Types/Location.html)을 참고해주세요.
|
|
1080
1719
|
*
|
|
1081
1720
|
* @example
|
|
1082
1721
|
* ### 위치 정보 변경 감지하기
|
|
@@ -1112,4 +1751,57 @@ declare const env: {
|
|
|
1112
1751
|
getDeploymentId: () => string | undefined;
|
|
1113
1752
|
};
|
|
1114
1753
|
|
|
1115
|
-
|
|
1754
|
+
declare class EntryMessageExitedEvent extends BedrockEventDefinition<undefined, undefined> {
|
|
1755
|
+
name: "entryMessageExited";
|
|
1756
|
+
remove(): void;
|
|
1757
|
+
listener(_: undefined): void;
|
|
1758
|
+
}
|
|
1759
|
+
|
|
1760
|
+
interface StartUpdateLocationOptions {
|
|
1761
|
+
/**
|
|
1762
|
+
* 위치 정확도를 설정해요.
|
|
1763
|
+
*/
|
|
1764
|
+
accuracy: Accuracy;
|
|
1765
|
+
/**
|
|
1766
|
+
* 위치 업데이트 주기를 밀리초(ms) 단위로 설정해요.
|
|
1767
|
+
*/
|
|
1768
|
+
timeInterval: number;
|
|
1769
|
+
/**
|
|
1770
|
+
* 위치 변경 거리를 미터(m) 단위로 설정해요.
|
|
1771
|
+
*/
|
|
1772
|
+
distanceInterval: number;
|
|
1773
|
+
}
|
|
1774
|
+
declare class UpdateLocationEvent extends BedrockEventDefinition<StartUpdateLocationOptions, Location> {
|
|
1775
|
+
name: "updateLocationEvent";
|
|
1776
|
+
subscriptionCount: number;
|
|
1777
|
+
ref: {
|
|
1778
|
+
remove: () => void;
|
|
1779
|
+
};
|
|
1780
|
+
remove(): void;
|
|
1781
|
+
listener(options: StartUpdateLocationOptions, onEvent: (response: Location) => void, onError: (error: unknown) => void): void;
|
|
1782
|
+
}
|
|
1783
|
+
|
|
1784
|
+
interface AppBridgeCallbackResult {
|
|
1785
|
+
name: string;
|
|
1786
|
+
params?: any;
|
|
1787
|
+
}
|
|
1788
|
+
declare class AppBridgeCallbackEvent extends BedrockEventDefinition<void, AppBridgeCallbackResult> {
|
|
1789
|
+
private static INTERNAL__appBridgeSubscription?;
|
|
1790
|
+
name: "appBridgeCallbackEvent";
|
|
1791
|
+
constructor();
|
|
1792
|
+
remove(): void;
|
|
1793
|
+
listener(): void;
|
|
1794
|
+
private registerAppBridgeCallbackEventListener;
|
|
1795
|
+
private ensureInvokeAppBridgeCallback;
|
|
1796
|
+
}
|
|
1797
|
+
|
|
1798
|
+
declare const appsInTossEvent: BedrockEvent<EntryMessageExitedEvent | AppBridgeCallbackEvent | UpdateLocationEvent>;
|
|
1799
|
+
|
|
1800
|
+
declare const Analytics: {
|
|
1801
|
+
init: (options: _apps_in_toss_analytics.AnalyticsConfig) => void;
|
|
1802
|
+
Impression: ({ enabled, impression: impressionType, ...props }: _apps_in_toss_analytics.LoggingImpressionProps) => react_jsx_runtime.JSX.Element;
|
|
1803
|
+
Press: react.ForwardRefExoticComponent<_apps_in_toss_analytics.LoggingPressProps & react.RefAttributes<unknown>>;
|
|
1804
|
+
Area: ({ children, params: _params, ...props }: _apps_in_toss_analytics.LoggingAreaProps) => react_jsx_runtime.JSX.Element;
|
|
1805
|
+
};
|
|
1806
|
+
|
|
1807
|
+
export { Accuracy, Analytics, AppsInToss, type ContactEntity, type EventLogParams, type ExternalWebViewProps, type FetchAlbumPhotosOptions, type GameWebViewProps, type GetCurrentLocationOptions, GoogleAdMob, type ImageResponse, type LoadAdMobInterstitialAdEvent, type LoadAdMobInterstitialAdOptions, type LoadAdMobRewardedAdEvent, type LoadAdMobRewardedAdOptions, type Location, type LocationCoords, type OpenCameraOptions, type PartnerWebViewProps, type ShowAdMobInterstitialAdEvent, type ShowAdMobInterstitialAdOptions, type ShowAdMobRewardedAdEvent, type ShowAdMobRewardedAdOptions, type StartUpdateLocationOptions$1 as StartUpdateLocationOptions, type StartUpdateLocationSubscription, Storage, TossPay, type UpdateLocationEventEmitter, type UseGeolocationOptions, WebView, type WebViewProps, appLogin, appsInTossEvent, env, eventLog, fetchAlbumPhotos, fetchContacts, getClipboardText, getCurrentLocation, getDeviceId, getOperationalEnvironment, getTossAppVersion, getTossShareLink, isMinVersionSupported, openCamera, setClipboardText, startUpdateLocation, useGeolocation };
|