@google/mobile-ads 모듈은 Google 모바일 광고를 React Native 애플리케이션에 통합하기 위한 핵심 TypeScript 인터페이스, 클래스, 최상위 함수를 제공합니다.
개요
-
SDK 수명 주기 및 초기화:
initialize와InitializationConfig를 사용하여 SDK를 초기화하고getInitializationStatus및InitializationStatus로 어댑터 초기화 상태를 검사합니다. -
사용자 메시지 플랫폼 (UMP):
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsForm로 사용자 동의를 관리하고getConsentStatus,canRequestAds로 동의 상태를 검사합니다. -
요청 구성:
setRequestConfiguration및RequestConfiguration로 전역 타겟팅 및 정책 설정을 정의하여AgeRestrictedTreatment,MaxAdContentRating,PublisherPrivacyPersonalizationState과 같은 옵션을 구성합니다. -
광고 형식:
AppOpenAd,InterstitialAd,RewardedAd,RewardedInterstitialAd과 같은 형식 클래스를 사용하여 광고를 로드하고 표시합니다. -
개발자 도구:
openAdInspector또는openDebugMenu를 사용하여 광고 게재, 어댑터 상태, SDK 구성을 실시간으로 검사합니다.
| 유형 별칭 | |
|---|---|
Adapter
|
미디에이션 어댑터의 가능한 초기화 상태를 나타냅니다.
|
Ad
|
광고 뷰의 AdChoices 아이콘 위치입니다. |
Ad
|
요청되는 광고의 형식입니다. |
Ad
|
광고 검사기가 실패한 이유에 관한 오류 정보입니다.
|
Ad
|
광고 검사기의 열기 또는 작동에 영향을 미치는 오류
|
Ad
|
인라인 적응형 및 대형 앵커 적응형 배너 광고의 방향 옵션입니다.
|
Ad
|
광고의 크기를 나타냅니다. |
Age
|
광고 요청의 연령 제한 취급 옵션을 정의합니다.
|
Consent
|
동의 상태 값입니다. |
Debug
|
지역 테스트를 위한 디버그 값입니다. |
Form
|
사용자 메시지 플랫폼 (UMP) 양식 작업 실패의 오류 코드를 나타냅니다.
|
Full
|
|
Load
|
광고 로드 작업 실패의 오류 코드를 나타냅니다.
|
Max
|
앱의 광고 콘텐츠 등급 한도를 정의하여 표시할 수 있는 광고 유형을 분류합니다.
|
Native
|
표준 네이티브 광고 애셋을 식별하는 데 사용되는 이름입니다.
|
Native
|
로드된 네이티브 광고의 형식을 식별합니다. |
Native
|
반환된 네이티브 광고 미디어의 가로세로 비율 환경설정입니다.
|
On
|
광고 검사기 UI가 닫힐 때 호출되는 콜백의 인터페이스 정의입니다.
|
Precision
|
보고된 광고 값의 정밀도입니다. |
Privacy
|
개인 정보 보호 옵션 요구사항 상태입니다. |
Publisher
|
게시자 개인 정보 보호 처리 개인 최적화 상태를 나타냅니다.
|
Resize
|
NativeAdMediaView에서 이미지 콘텐츠의 크기 조절 모드를 맞춤설정하는 옵션입니다.
|
Resolved
|
광고가 로드된 후 광고 크기의 최종 해결된 상태를 나타냅니다.
|
Swipe
|
맞춤 클릭 스와이프 동작의 방향 |
| 변수 | |
|---|---|
Ad
|
적응형 및 맞춤 크기를 만들기 위한 사전 정의된 광고 크기 및 도우미 메서드입니다.
|
| 함수 | |
|---|---|
can
|
현재 동의 상태가 광고를 요청할 수 있는지 확인합니다.
|
get
|
사용자의 현재 동의 상태를 가져옵니다. |
get
|
SDK 초기화 상태를 가져옵니다. |
get
|
앱에 개인 정보 보호 옵션 진입점이 필요한지 확인합니다.
|
get
|
전역 요청 구성을 가져옵니다. |
initialize
|
Google 모바일 광고 SDK를 초기화합니다. |
is
|
동의 양식을 사용할 수 있는지 확인합니다. |
load
|
현재 동의 상태에 필요한 경우 (예: 상태가 REQUIRED인 경우) 동의 양식을 로드하여 사용자에게 표시합니다.
|
open
|
Google 모바일 광고 SDK 광고 검사기 오버레이를 엽니다.
|
open
|
디버그 메뉴를 엽니다. |
parse
|
광고 로드 중에 발생한 네이티브 오류를 파싱하고 LoadAdError로 래핑합니다.
|
request
|
동의 정보 업데이트를 요청합니다. |
reset
|
영구 스토리지에서 모든 동의 상태를 지웁니다.
|
set
|
게시자 퍼스트 파티 ID가 사용 설정되어 있는지 여부를 제어합니다.
|
set
|
규정 준수 및 타겟팅을 위한 전역 요청 구성을 설정합니다.
|
set
|
사용자가 제어하는 애플리케이션의 오디오 볼륨을 설정합니다.
|
set
|
애플리케이션이 음소거되었는지 여부를 설정합니다. |
show
|
개인 정보 보호 옵션 양식을 표시합니다. |
유형 별칭
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
| 속성 | |
|---|---|
NOT_
|
미디에이션 어댑터가 아직 초기화되지 않았거나 초기화에 실패했음을 나타냅니다.
|
READY
|
연쇄 광고 호출 어댑터가 성공적으로 초기화되었으며 광고를 게재할 준비가 되었음을 나타냅니다.
|
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
| 속성 | |
|---|---|
BOTTOM_
|
광고의 왼쪽 하단 모서리입니다. |
BOTTOM_
|
광고의 오른쪽 하단입니다. |
TOP_
|
광고의 왼쪽 상단입니다. |
TOP_
|
광고의 오른쪽 상단 |
AdFormat
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
| 속성 | |
|---|---|
ALREADY_
|
이미 열려 있으므로 광고 검사기를 열 수 없습니다.
|
FAILED_
|
광고 검사기를 로드할 수 없습니다. |
INTERNAL_
|
광고 검사기에 내부 오류가 발생했습니다. |
NOT_
|
기기가 테스트 모드가 아니므로 광고 검사기를 열 수 없습니다.
|
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| 속성 | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
AgeRestrictedTreatment
AgeRestrictedTreatment:
typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
| 속성 | |
|---|---|
CHILD
|
광고 요청이 아동 연령 취급을 받아야 함을 나타냅니다.
|
TEEN
|
광고 요청이 청소년 연령 취급을 받아야 함을 나타냅니다.
|
UNSPECIFIED
|
광고 요청에 적용되는 특정 연령 제한 처리 신호가 없음을 나타냅니다.
|
ConsentStatus
ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
| 속성 | |
|---|---|
NOT_
|
동의가 필요하지 않습니다. |
OBTAINED
|
사용자 동의를 얻었으며 개인 맞춤과 개인 맞춤이 아닌 광고가 정의되지 않았습니다.
|
REQUIRED
|
사용자 동의가 필요하지만 아직 얻지 못했습니다.
|
UNKNOWN
|
알 수 없는 동의 상태입니다. |
DebugGeography
DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
| 속성 | |
|---|---|
DISABLED
|
디버그 기기에 대해 디버그 지역이 사용 중지되었습니다.
|
EEA
|
디버그 기기에 대해 지역이 EEA로 표시됩니다.
|
OTHER
|
디버그 기기에 대해 규제가 적용되지 않는 리전으로 표시됩니다.
|
REGULATED_
|
디버그 기기에 대해 지역이 규제가 적용되는 미국 주로 표시됩니다.
|
FormErrorCode
FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
FullScreenContentErrorCode
FullScreenContentErrorCode:
typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
| 속성 | |
|---|---|
AD_
|
광고가 이미 표시되었습니다. |
AD_
|
광고를 게재할 준비가 되지 않았습니다. |
AD_
|
광고가 장면보다 너무 큽니다 (iOS만 해당). |
APP_
|
앱이 포그라운드에 없습니다. |
INTERNAL_
|
내부적으로 문제가 발생했습니다. 예를 들어 광고 콘텐츠를 표시할 준비를 하는 중에 예외가 발생했습니다.
|
MEDIATION_
|
미디에이션 어댑터가 광고를 표시하지 못했습니다. 기본 원인은 FullScreenContentError.mediationAdError를 참고하세요.
|
UNKNOWN
|
오류 코드를 알려진 오류 코드에 매핑할 수 없습니다.
|
LoadAdErrorCode
LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
MaxAdContentRating
MaxAdContentRating:
typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
| 속성 | |
|---|---|
G
|
가족 및 아동 등 모든 연령대에 적합한 콘텐츠입니다.
|
MA
|
성인 잠재고객에게만 적합한 콘텐츠입니다.
|
PG
|
보호자 동반하에 대부분의 잠재고객에게 적합한 콘텐츠입니다.
|
T
|
청소년 이상의 시청자에게 적합한 콘텐츠
|
UNSPECIFIED
|
지정된 콘텐츠 등급이 없습니다. |
NativeAdAssetNames
NativeAdAssetNames:
typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
NativeAdType
NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
| 속성 | |
|---|---|
BANNER
|
배너 광고 |
CUSTOM_
|
맞춤 네이티브 형식 광고입니다. |
NATIVE
|
네이티브 광고 |
NativeMediaAspectRatio
NativeMediaAspectRatio:
typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
OnAdInspectorClosedListener
OnAdInspectorClosedListener:
((error?) => void)
PrecisionType
PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
| 속성 | |
|---|---|
ESTIMATED
|
합산 데이터에서 예상되는 광고 값입니다.
|
PRECISE
|
광고에 지불된 정확한 값입니다. |
PUBLISHER_
|
미디에이션 그룹의 수동 CPM처럼 게시자가 제공한 광고의 가치입니다.
|
UNKNOWN
|
정밀도를 알 수 없는 광고 값입니다. |
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus:
typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
| 속성 | |
|---|---|
NOT_
|
개인 정보 보호 옵션 진입점은 필요하지 않습니다.
|
REQUIRED
|
개인 정보 보호 옵션 진입점이 필요합니다. |
UNKNOWN
|
개인 정보 보호 옵션 요구사항 상태를 알 수 없습니다.
|
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
| 속성 | |
|---|---|
DEFAULT
|
광고 요청이 기본 게시자 개인 정보 보호 처리를 받아야 함을 나타냅니다.
|
DISABLED
|
광고 요청이 개인 맞춤이 아닌 게시자 개인 정보 보호 처리를 받아야 함을 나타냅니다.
|
ENABLED
|
광고 요청이 개인 맞춤 게시자 개인 정보 보호 처리를 받아야 함을 나타냅니다.
|
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
대부분의 광고의 경우 정확한
width 및 height 크기를 갖는 FixedAdSize로 해결됩니다.
동적으로 크기가 조정되는 배너 광고의 경우 뷰 계층 구조에서 크기를 관리하는 FluidAdSize로 확인됩니다.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| 속성 | |
|---|---|
DOWN
|
아래로 스와이프합니다. |
LEFT
|
왼쪽으로 스와이프합니다. |
RIGHT
|
오른쪽으로 스와이프합니다. |
UP
|
위로 스와이프합니다. |
변수
AdSize
AdSize: {
BANNER: FixedAdSize;
custom: ((width,
height) => FixedAdSize);
FLUID: FluidAdSize;
FULL_BANNER: FixedAdSize;
getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getInlineAdaptiveBannerAdSize: ((width,
maxHeight) => InlineAdaptiveAdSize);
getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
LARGE_BANNER: FixedAdSize;
LEADERBOARD: FixedAdSize;
MEDIUM_RECTANGLE: FixedAdSize;
}
함수
canRequestAds
canRequestAds(): boolean
현재 동의 상태가 광고를 요청할 수 있는지 확인합니다.
| 반환 값 | |
|---|---|
boolean
|
광고를 요청할 수 있는 경우 true, 그렇지 않은 경우 false
|
getConsentStatus
getConsentStatus(): ConsentStatus
사용자의 현재 동의 상태를 가져옵니다.
| 반환 값 | |
|---|---|
ConsentStatus
|
현재 동의 상태입니다. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
SDK 초기화 상태를 가져옵니다.
이 메서드를 사용하여 SDK 초기화가 완료되었는지 확인하고 개별 미디에이션 어댑터의 상태를 검사합니다.
이 메서드를 사용하여 SDK 초기화가 완료되었는지 확인하고 개별 미디에이션 어댑터의 상태를 검사합니다.
| 반환 값 | |
|---|---|
InitializationStatus
|
현재 초기화 상태입니다. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
앱에 개인 정보 보호 옵션 진입점이 필요한지 확인합니다.
진입점이 필요한 경우 showPrivacyOptionsForm을 호출하여 개인 정보 보호 옵션 양식을 표시하는 표시되고 상호작용 가능한 UI 요소를 앱에 추가합니다. 진입점이 필요하지 않은 경우 UI 요소가 표시되지 않고 상호작용할 수 없도록 구성합니다.
진입점이 필요한 경우 showPrivacyOptionsForm을 호출하여 개인 정보 보호 옵션 양식을 표시하는 표시되고 상호작용 가능한 UI 요소를 앱에 추가합니다. 진입점이 필요하지 않은 경우 UI 요소가 표시되지 않고 상호작용할 수 없도록 구성합니다.
| 반환 값 | |
|---|---|
PrivacyOptionsRequirementStatus
|
개인 정보 보호 옵션 요구사항 상태입니다. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
initialize
initialize(config,
onInitializationComplete?): void
Google 모바일 광고 SDK를 초기화합니다.
광고를 로드하기 전과 나머지 Google 모바일 광고 SDK와 상호작용하기 전에 이 메서드를 호출하세요.
광고를 로드하기 전과 나머지 Google 모바일 광고 SDK와 상호작용하기 전에 이 메서드를 호출하세요.
| 매개변수 | |
|---|---|
config:
InitializationConfig
|
SDK 초기화를 제어하는 옵션입니다. |
|
SDK 초기화가 완료될 때 실행할 콜백 함수입니다. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
동의 양식을 사용할 수 있는지 확인합니다.
| 반환 값 | |
|---|---|
boolean
|
동의 양식을 사용할 수 있는 경우 true, 그렇지 않은 경우 false
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
현재 동의 상태에 따라 동의 양식을 로드하고 사용자에게 표시합니다 (예: 상태가 REQUIRED인 경우).
| 매개변수 | |
|---|---|
|
양식이 닫히거나 양식이 필요하지 않은 경우 호출되는 콜백 함수입니다. 프레젠테이션이 실패한 경우 선택적 FormError가 있습니다. |
openAdInspector
openAdInspector(_listener): void
Google 모바일 광고 SDK 광고 검사기 오버레이를 엽니다.
이 메서드를 사용하여 미디에이션 설정과 광고 소스를 디버그합니다.
이 메서드를 사용하여 미디에이션 설정과 광고 소스를 디버그합니다.
| 매개변수 | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
디버그 메뉴를 엽니다.
이 메서드를 사용하여 특정 광고 단위의 디버그 메뉴를 열어 광고 구성 테스트 및 문제 해결을 지원합니다.
이 메서드를 사용하여 특정 광고 단위의 디버그 메뉴를 열어 광고 구성 테스트 및 문제 해결을 지원합니다.
| 매개변수 | |
|---|---|
adUnitId: string
|
디버그 메뉴를 열 광고 단위 ID입니다. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
광고 로드 중에 발생한 네이티브 오류를 파싱하고 LoadAdError로 래핑합니다.
| 매개변수 | |
|---|---|
error: unknown
|
네이티브 모듈에서 발생한 오류 객체입니다. |
| 반환 값 | |
|---|---|
LoadAdError
|
파싱된 LoadAdError 객체입니다. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
동의 정보 업데이트를 요청합니다.
이 API는 getConsentStatus를 호출하기 전에 각 앱 세션에서 호출해야 합니다.
이 API가 호출되면 getConsentStatus 반환 값이 이전 앱 세션의 동의 상태를 보유하도록 동기적으로 업데이트됩니다(있는 경우).
이 API는 getConsentStatus를 호출하기 전에 각 앱 세션에서 호출해야 합니다.
이 API가 호출되면 getConsentStatus 반환 값이 이전 앱 세션의 동의 상태를 보유하도록 동기적으로 업데이트됩니다(있는 경우).
onComplete 콜백이 호출된 후 getConsentStatus를 최신 상태로 다시 업데이트할 수 있습니다.
| 매개변수 | |
|---|---|
|
디버깅 및 타겟팅을 위한 선택적 구성입니다. |
|
동의 정보 업데이트가 완료될 때 호출되는 콜백 함수입니다. 요청이 실패한 경우 선택적 FormError가 포함됩니다. |
reset
reset(): void
영구 스토리지에서 모든 동의 상태를 지웁니다.
디버깅 목적으로만 사용하세요.
디버깅 목적으로만 사용하세요.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
게시자 퍼스트 파티 ID가 사용 설정되어 있는지 여부를 제어합니다.
이전 명칭이 동일 앱 키인 Google 모바일 광고 SDK 게시자 퍼스트 파티 ID를 사용 설정하거나 중지합니다.
이전 명칭이 동일 앱 키인 Google 모바일 광고 SDK 게시자 퍼스트 파티 ID를 사용 설정하거나 중지합니다.
- 참고 항목
| 매개변수 | |
|---|---|
enabled: boolean
|
게시자 퍼스트 파티 ID를 사용 설정하려면 true, 사용 중지하려면 false입니다. 기본값은 true입니다.
|
setRequestConfiguration
setRequestConfiguration(_config): void
규정 준수 및 타겟팅을 위한 전역 요청 구성을 설정합니다.
이 메서드를 사용하여 광고 콘텐츠 등급 한도, 연령별 설정 태그와 같은 규정 준수 설정, 테스트 기기 ID와 같은 타겟팅 세부정보를 지정하세요.
이 메서드를 사용하여 광고 콘텐츠 등급 한도, 연령별 설정 태그와 같은 규정 준수 설정, 테스트 기기 ID와 같은 타겟팅 세부정보를 지정하세요.
| 매개변수 | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
사용자 제어 애플리케이션의 오디오 볼륨을 설정합니다.
이 메서드를 사용하여 기기의 다른 오디오 출력에 상대적인 모든 광고의 오디오 볼륨을 조정합니다.
이 메서드를 사용하여 기기의 다른 오디오 출력에 상대적인 모든 광고의 오디오 볼륨을 조정합니다.
| 매개변수 | |
|---|---|
volume: number
|
볼륨 수준입니다. 0.0 (무음)에서 1.0 (최대) 사이의 값입니다. 이 범위 내의 부동 소수점 값은 유효합니다 (예: 0.001 또는 0.33333). 값은 0.1과 같은 특정 단계 크기 증분으로 제한되지 않습니다. |
setUserMutedApp
setUserMutedApp(muted): void
애플리케이션이 음소거되었는지 설정합니다.
이 메서드를 사용하여 후속 광고의 초기 오디오 음소거 상태를 제어합니다.
이 메서드를 사용하여 후속 광고의 초기 오디오 음소거 상태를 제어합니다.
| 매개변수 | |
|---|---|
muted: boolean
|
애플리케이션 오디오를 음소거해야 하는지 여부입니다. 기본값은 false입니다.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
개인 정보 보호 옵션 양식을 표시합니다.
getPrivacyOptionsRequirementStatus가
이 메서드는 개인 정보 보호 옵션 양식을 표시하도록 요청하는 사용자 입력에 대한 응답으로만 호출해야 합니다.
양식을 사용할 수 있게 되면 SDK에서 개인 정보 보호 옵션 양식을 자동으로 미리 로드합니다. 미리 로드된 양식이 없는 경우 SDK는 비동기식으로 양식을 로드하려고 시도합니다.
getPrivacyOptionsRequirementStatus가
REQUIRED인 경우 개인 정보 보호 옵션 양식을 표시합니다.이 메서드는 개인 정보 보호 옵션 양식을 표시하도록 요청하는 사용자 입력에 대한 응답으로만 호출해야 합니다.
양식을 사용할 수 있게 되면 SDK에서 개인 정보 보호 옵션 양식을 자동으로 미리 로드합니다. 미리 로드된 양식이 없는 경우 SDK는 비동기식으로 양식을 로드하려고 시도합니다.
onDismissed 콜백은 사용자에게 양식이 표시되고, 사용자가 옵션을 선택하고, 양식을 닫은 후에 호출됩니다. 다음과 같은 경우 FormError와 함께 반환될 수도 있습니다.
- 양식을 사용할 수 없습니다.
- 양식이 표시되지 않습니다.
- 양식이 아직 사전 로드되고 있습니다.
| 매개변수 | |
|---|---|
|
양식이 닫힐 때 호출되는 콜백 함수입니다. 프레젠테이션이 실패한 경우 선택적 FormError가 포함됩니다. |