このページは Cloud Translation API によって翻訳されました。

開始する

Google User Messaging Platform（UMP）SDK は、プライバシーに関するユーザー設定の管理に役立つプライバシーとメッセージのツールです。詳しくは、プライバシーとメッセージについてをご覧ください。

前提条件

Android API レベル 21 以降

メッセージタイプを作成する

アドマネージャーアカウントの [プライバシーとメッセージ] タブで、利用可能なユーザー向けメッセージの種類のいずれかを使用してユーザー向けメッセージを作成します。UMP SDK は、プロジェクトで設定されたアドマネージャーのアプリケーション ID から作成されたプライバシーメッセージを表示しようとします。

詳しくは、プライバシーとメッセージについてをご覧ください。

Gradle でインストールする

Google User Messaging Platform SDK の依存関係をモジュールのアプリレベルの Gradle ファイル（通常は app/build.gradle）に追加します。

dependencies {
  implementation("com.google.android.ump:user-messaging-platform:3.1.0")
}

アプリの build.gradle を変更したら、プロジェクトを Gradle ファイルと必ず同期してください。

アプリケーション ID を追加する

アプリケーション ID はアドマネージャーの管理画面で確認できます。次のコードスニペットを使用して、ID を AndroidManifest.xml に追加します。

<manifest>
  <application>
    <meta-data
        android:name="com.google.android.gms.ads.APPLICATION_ID"
        android:value="ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy"/>
  </application>
</manifest>

同意を得る

同意を得るには、次の手順を行います。

最新のユーザーの同意情報をリクエストします。
必要に応じて同意フォームを読み込んで提示します。

アプリの起動ごとに requestConsentInfoUpdate() を使用して、ユーザーの同意情報の更新をリクエストする必要があります。このリクエストは、以下を確認します。

同意が必要かどうか。たとえば、初めて同意が必要な場合や、以前の同意決定が期限切れになっている場合です。
プライバシーオプションのエントリポイントが必要かどうか。プライバシーメッセージによっては、ユーザーがプライバシーオプションをいつでも変更できるようにアプリで設定する必要があります。

必要に応じてプライバシーメッセージフォームを読み込んで表示する

最新の同意ステータスを受け取ったら、loadAndShowConsentFormIfRequired() を呼び出して、ユーザーの同意を収集するために必要なフォームを読み込みます。読み込み後、フォームがすぐに表示されます。

次のコードは、ユーザーの最新の同意情報をリクエストする方法を示しています。必要に応じて、コードがプライバシーメッセージフォームを読み込んで表示します。

Java


// 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));GoogleMobileAdsConsentManager.java

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)
  },
)GoogleMobileAdsConsentManager.kt

プライバシーオプション

一部のプライバシーメッセージフォームは、パブリッシャーがレンダリングしたプライバシーオプションのエントリポイントから表示され、ユーザーはプライバシーオプションをいつでも管理できます。プライバシーオプションのエントリポイントでユーザーに表示されるメッセージの詳細については、使用可能なユーザーメッセージの種類をご覧ください。

プライバシーオプションのエントリポイントが必要かどうかを確認する

requestConsentInfoUpdate() を呼び出した後、ConsentInformation.PivacyOptionsRequirementStatus をチェックして、アプリにプライバシーオプションのエントリポイントが必要かどうかを判断します。

Java


/** Helper variable to determine if the privacy options form is required. */
public boolean isPrivacyOptionsRequired() {
  return consentInformation.getPrivacyOptionsRequirementStatus()
      == PrivacyOptionsRequirementStatus.REQUIRED;
}
GoogleMobileAdsConsentManager.java

Kotlin


/** Helper variable to determine if the privacy options form is required. */
val isPrivacyOptionsRequired: Boolean
  get() =
    consentInformation.privacyOptionsRequirementStatus ==
      ConsentInformation.PrivacyOptionsRequirementStatus.REQUIRED
GoogleMobileAdsConsentManager.kt

アプリに表示要素を追加する

プライバシーエントリポイントが必要な場合は、プライバシーオプションフォームを表示する、表示可能で操作可能な UI 要素をアプリに追加します。プライバシーエントリポイントが不要な場合は、UI 要素を非表示にして操作できないように構成します。

Java


if (googleMobileAdsConsentManager.isPrivacyOptionsRequired()) {
  // Regenerate the options menu to include a privacy setting.
  invalidateOptionsMenu();
}MyActivity.java

Kotlin


if (googleMobileAdsConsentManager.isPrivacyOptionsRequired) {
  // Regenerate the options menu to include a privacy setting.
  invalidateOptionsMenu()
}MainActivity.kt

プライバシーオプションのフォームを表示する

ユーザーが要素を操作したときに、プライバシーオプションフォームを表示します。

Java


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener);GoogleMobileAdsConsentManager.java

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)GoogleMobileAdsConsentManager.kt

広告をリクエスト

アプリで広告をリクエストする前に、canRequestAds() を使用してユーザーの同意を得ているかどうかを確認します。同意を得る際に確認する必要がある項目は 2 つあります。

現在のセッションで同意が得られた場合。
requestConsentInfoUpdate() を呼び出した直後。前回のセッションで同意を得ている可能性があります。レイテンシに関するベストプラクティスとして、コールバックの完了を待たずに、アプリの起動後できるだけ早く広告の読み込みを開始することをおすすめします。

同意取得プロセス中にエラーが発生した場合でも、広告をリクエストできるかどうかを確認する必要があります。UMP SDK は、前のセッションの同意ステータスを使用します。

次のコードは、同意取得プロセス中に広告をリクエストできるかどうかを確認します。

Java


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 Mobile Ads SDK を設定します。

Java


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();
}
MyActivity.java

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()
    }
  }
}
MainActivity.kt

テスト

開発中のアプリで統合をテストする場合は、次の手順に沿ってプログラムでテストデバイスを登録します。アプリをリリースする前に、テストデバイス ID を設定するコードを必ず削除してください。

requestConsentInfoUpdate()までお電話ください。
ログ出力で次のようなメッセージを確認します。ここには、デバイス ID とテストデバイスとしてデバイスを追加する方法が示されています。
```
Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.
```
テストデバイスの ID をクリップボードにコピーします。

ConsentDebugSettings.Builder().TestDeviceHashedIds を呼び出してテストデバイス ID のリストを渡すようにコードを変更します。

Java

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 では、 DebugGeography を使用して、デバイスが EEA や英国などのさまざまな地域にあるかのようにアプリの動作をテストできます。デバッグ設定はテスト用デバイスでのみ機能します。

Java

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() メソッドが用意されています。

Java

consentInformation.reset();

Kotlin

consentInformation.reset()

GitHub の例

このページで説明する UMP SDK 統合の完全な例については、 Java BannerExample と Kotlin BannerExample をご覧ください。

開始する

前提条件

メッセージ タイプを作成する

Gradle でインストールする

アプリケーション ID を追加する

同意を得る

同意情報のリクエスト

必要に応じてプライバシー メッセージ フォームを読み込んで表示する

Java

Kotlin

プライバシー オプション

プライバシー オプションのエントリ ポイントが必要かどうかを確認する

Java

Kotlin

アプリに表示要素を追加する

Java

Kotlin

プライバシー オプションのフォームを表示する

Java

Kotlin

広告をリクエスト

Java

Kotlin

Java

Kotlin

テスト

Java

Kotlin

地域を強制的に適用する

Java

Kotlin

同意ステータスをリセットする

Java

Kotlin

GitHub の例

メッセージタイプを作成する

必要に応じてプライバシーメッセージフォームを読み込んで表示する

プライバシーオプション

プライバシーオプションのエントリポイントが必要かどうかを確認する

プライバシーオプションのフォームを表示する