Google 사용자 메시지 플랫폼(UMP) SDK는 개인 정보 보호 옵션을 관리하는 데 도움이 되는 개인 정보 보호 및 메시지 도구입니다. 자세한 내용은 개인 정보 보호 및 메시지 정보를 참고하세요.
기본 요건
- Android API 수준 21 이상
메시지 유형 만들기
AdMob 계정의 개인 정보 보호 및 메시지 탭에서 사용 가능한 사용자 메시지 유형 중 하나를 사용하여 사용자 메시지를 만듭니다. UMP SDK는 프로젝트에 설정된 AdMob 애플리케이션 ID로 생성된 개인 정보 보호 메시지를 표시하려고 합니다.
자세한 내용은 개인 정보 보호 및 메시지에 대한 정보를 참고하세요.
Gradle로 설치
모듈의 앱 수준 Gradle 파일(일반적으로 app/build.gradle
)에 Google User Messaging Platform SDK의 종속 항목을 추가합니다.
dependencies {
implementation("com.google.android.ump:user-messaging-platform:3.1.0")
}
앱의 build.gradle
를 변경한 후에는 프로젝트를 Gradle 파일과 동기화해야 합니다.
애플리케이션 ID 추가
애플리케이션 ID는 AdMob UI에서 확인할 수 있습니다.
다음 코드 스니펫을 사용하여 AndroidManifest.xml
에 ID를 추가합니다.
<manifest>
<application>
<meta-data
android:name="com.google.android.gms.ads.APPLICATION_ID"
android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
</application>
</manifest>
동의 수집
동의를 수집하려면 다음 단계를 완료하세요.
- 최신 사용자 동의 정보를 요청합니다.
- 필요한 경우 동의 양식을 로드하고 제공합니다.
동의 정보 요청
앱을 실행할 때마다
requestConsentInfoUpdate()
를 사용하여 사용자 동의 정보 업데이트를 요청해야 합니다. 이 요청은 다음을 확인합니다.
- 동의 필요 여부. 예를 들어 처음으로 동의가 필요하거나 이전 동의 결정이 만료되었습니다.
- 개인 정보 보호 옵션 진입점이 필요한지 여부 일부 개인 정보 보호 메시지의 경우 앱에서 사용자가 언제든지 개인 정보 보호 옵션을 수정하도록 허용해야 합니다.
필요한 경우 개인 정보 보호 메시지 양식 로드 및 표시
최신 동의 상태를 수신한 후
loadAndShowConsentFormIfRequired()
를 호출하여 사용자 동의를 수집하는 데 필요한 양식을 로드합니다. 로드 후 양식이 즉시 표시됩니다.
다음 코드는 사용자의 최신 동의 정보를 요청하는 방법을 보여줍니다. 필요한 경우 코드는 개인 정보 보호 메시지 양식을 로드하여 표시합니다.
자바
// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
activity,
params,
() ->
UserMessagingPlatform.loadAndShowConsentFormIfRequired(
activity,
formError -> {
// Consent has been gathered.
onConsentGatheringCompleteListener.consentGatheringComplete(formError);
}),
requestConsentError ->
onConsentGatheringCompleteListener.consentGatheringComplete(requestConsentError));
Kotlin
// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
activity,
params,
{
UserMessagingPlatform.loadAndShowConsentFormIfRequired(activity) { formError ->
// Consent has been gathered.
onConsentGatheringCompleteListener.consentGatheringComplete(formError)
}
},
{ requestConsentError ->
onConsentGatheringCompleteListener.consentGatheringComplete(requestConsentError)
},
)
공개 설정 옵션
일부 개인 정보 보호 메시지 양식은 게시자가 렌더링한 개인 정보 보호 옵션 진입점에서 표시되며 사용자가 언제든지 개인 정보 보호 옵션을 관리할 수 있습니다. 사용자에게 개인 정보 보호 옵션 진입점에서 표시되는 메시지에 관해 자세히 알아보려면 사용 가능한 사용자 메시지 유형을 참고하세요.
개인 정보 보호 옵션 진입점이 필요한지 확인
requestConsentInfoUpdate()
를 호출한 후
getPrivacyOptionsRequirementStatus()
를 확인하여 앱에 개인 정보 보호 옵션 진입점이 필요한지 확인합니다.
자바
/** Helper variable to determine if the privacy options form is required. */
public boolean isPrivacyOptionsRequired() {
return consentInformation.getPrivacyOptionsRequirementStatus()
== PrivacyOptionsRequirementStatus.REQUIRED;
}
Kotlin
/** Helper variable to determine if the privacy options form is required. */
val isPrivacyOptionsRequired: Boolean
get() =
consentInformation.privacyOptionsRequirementStatus ==
ConsentInformation.PrivacyOptionsRequirementStatus.REQUIRED
앱에 보이는 요소 추가
개인 정보 보호 진입점이 필요한 경우 앱에 개인 정보 보호 옵션 양식을 표시하는 UI 요소를 표시하고 상호작용할 수 있도록 추가합니다. 개인 정보 보호 진입점이 필요하지 않은 경우 UI 요소가 표시되지 않고 상호작용이 불가능하도록 구성합니다.
자바
if (googleMobileAdsConsentManager.isPrivacyOptionsRequired()) {
// Regenerate the options menu to include a privacy setting.
invalidateOptionsMenu();
}
Kotlin
if (googleMobileAdsConsentManager.isPrivacyOptionsRequired) {
// Regenerate the options menu to include a privacy setting.
invalidateOptionsMenu()
}
개인 정보 보호 옵션 양식 표시
사용자가 요소와 상호작용할 때 개인 정보 보호 옵션 양식을 제시하세요.
자바
UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);
Kotlin
UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)
광고 요청
앱에서 광고를 요청하기 전에
canRequestAds()
를 사용하여 사용자의 동의를 얻었는지 확인합니다. 동의를 수집할 때는 다음 두 가지를 확인해야 합니다.
- 현재 세션에서 동의를 수집한 후
requestConsentInfoUpdate()
를 호출한 직후 이전 세션에서 동의를 받았을 수 있습니다. 앱 실행 후 최대한 빨리 광고 로드를 시작할 수 있도록 콜백이 완료될 때까지 기다리지 않는 것이 좋습니다.
동의 수집 절차 중에 오류가 발생하더라도 광고를 요청할 수 있는지 확인해야 합니다. UMP SDK는 이전 세션의 동의 상태를 사용합니다.
다음 코드는 동의 수집 절차 중에 광고를 요청할 수 있는지 확인합니다.
자바
googleMobileAdsConsentManager.gatherConsent(
this,
consentError -> {
if (consentError != null) {
// Consent not obtained in current session.
Log.w(
TAG,
String.format("%s: %s", consentError.getErrorCode(), consentError.getMessage()));
}
if (googleMobileAdsConsentManager.canRequestAds()) {
initializeMobileAdsSdk();
}
// ...
});
// This sample attempts to load ads using consent obtained in the previous session.
if (googleMobileAdsConsentManager.canRequestAds()) {
initializeMobileAdsSdk();
}
Kotlin
googleMobileAdsConsentManager.gatherConsent(this) { error ->
if (error != null) {
// Consent not obtained in current session.
Log.d(TAG, "${error.errorCode}: ${error.message}")
}
if (googleMobileAdsConsentManager.canRequestAds) {
initializeMobileAdsSdk()
}
// ...
}
// This sample attempts to load ads using consent obtained in the previous session.
if (googleMobileAdsConsentManager.canRequestAds) {
initializeMobileAdsSdk()
}
다음 코드는 사용자 동의를 수집한 후 Google 모바일 광고 SDK를 설정합니다.
자바
private void initializeMobileAdsSdk() {
if (isMobileAdsInitializeCalled.getAndSet(true)) {
return;
}
new Thread(
() -> {
// Initialize the Google Mobile Ads SDK on a background thread.
MobileAds.initialize(this, initializationStatus -> {});
// Load an ad on the main thread.
runOnUiThread(this::loadBanner);
})
.start();
}
Kotlin
private fun initializeMobileAdsSdk() {
if (isMobileAdsInitializeCalled.getAndSet(true)) {
return
}
CoroutineScope(Dispatchers.IO).launch {
// Initialize the Google Mobile Ads SDK on a background thread.
MobileAds.initialize(this@MainActivity) {}
runOnUiThread {
// Load an ad on the main thread.
loadBanner()
}
}
}
테스트
개발하면서 앱의 통합을 테스트하려면 이 단계에 따라 테스트 기기를 프로그래매틱 방식으로 등록하세요. 앱을 출시하기 전에 이러한 테스트 기기 ID를 설정하는 코드를 삭제해야 합니다.
requestConsentInfoUpdate()
를 호출합니다.로그 출력에서 기기 ID와 이를 테스트 기기로 추가하는 방법을 보여주는 다음 예와 유사한 메시지를 확인합니다.
Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.
테스트 기기 ID를 클립보드에 복사합니다.
ConsentDebugSettings.Builder().TestDeviceHashedIds
를 호출하고 테스트 기기 ID 목록을 전달하도록 코드를 수정합니다.자바
ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this) .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID") .build(); ConsentRequestParameters params = new ConsentRequestParameters .Builder() .setConsentDebugSettings(debugSettings) .build(); consentInformation = UserMessagingPlatform.getConsentInformation(this); // Include the ConsentRequestParameters in your consent request. consentInformation.requestConsentInfoUpdate( this, params, // ... );
Kotlin
val debugSettings = ConsentDebugSettings.Builder(this) .addTestDeviceHashedId("TEST-DEVICE-HASHED-ID") .build() val params = ConsentRequestParameters .Builder() .setConsentDebugSettings(debugSettings) .build() consentInformation = UserMessagingPlatform.getConsentInformation(this) // Include the ConsentRequestParameters in your consent request. consentInformation.requestConsentInfoUpdate( this, params, // ... )
지역 강제 설정
UMP SDK는 setDebugGeography()
를 사용하여 기기가 EEA 또는 영국과 같은 다양한 지역에 있는 것처럼 앱 동작을 테스트할 수 있는 방법을 제공합니다. 디버그 설정은 테스트 기기에서만 작동합니다.
자바
ConsentDebugSettings debugSettings = new ConsentDebugSettings.Builder(this)
.setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
.addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
.build();
ConsentRequestParameters params = new ConsentRequestParameters
.Builder()
.setConsentDebugSettings(debugSettings)
.build();
consentInformation = UserMessagingPlatform.getConsentInformation(this);
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
this,
params,
...
);
Kotlin
val debugSettings = ConsentDebugSettings.Builder(this)
.setDebugGeography(ConsentDebugSettings.DebugGeography.DEBUG_GEOGRAPHY_EEA)
.addTestDeviceHashedId("TEST-DEVICE-HASHED-ID")
.build()
val params = ConsentRequestParameters
.Builder()
.setConsentDebugSettings(debugSettings)
.build()
consentInformation = UserMessagingPlatform.getConsentInformation(this)
// Include the ConsentRequestParameters in your consent request.
consentInformation.requestConsentInfoUpdate(
this,
params,
...
)
동의 상태 재설정
UMP SDK로 앱을 테스트할 때 사용자의 첫 설치 환경을 시뮬레이션할 수 있도록 SDK의 상태를 재설정하면 유용합니다.
SDK에서는 이를 위한 reset()
메서드를 제공합니다.
자바
consentInformation.reset();
Kotlin
consentInformation.reset()
GitHub의 예
이 페이지에서 다룬 UMP SDK 통합의 전체 예는 Java BannerExample 및 Kotlin BannerExample를 참고하세요.