開始する

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>

ユーザーの同意情報を取得する手順は次のとおりです。

ConsentInformation のインスタンスを宣言します。

Java

private final ConsentInformation consentInformation;

Kotlin

private lateinit val consentInformation: ConsentInformation

ConsentInformation インスタンスを初期化します。

Java

consentInformation = UserMessagingPlatform.getConsentInformation(context);

Kotlin

consentInformation = UserMessagingPlatform.getConsentInformation(context)

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

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

Java


// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
    activity,
    params,
    () -> // Called when consent information is successfully updated.
    requestConsentError -> // Called when there's an error updating consent information.
GoogleMobileAdsConsentManager.java

Kotlin


// Requesting an update to consent information should be called on every app launch.
consentInformation.requestConsentInfoUpdate(
  activity,
  params,
  {
    // Called when consent information is successfully updated.
  },
  { requestConsentError ->
    // Called when there's an error updating consent information.
  },
)
GoogleMobileAdsConsentManager.kt

プライバシー メッセージ フォームを読み込んで表示する

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

Java


UserMessagingPlatform.loadAndShowConsentFormIfRequired(
    activity,
    formError -> {
      // Consent gathering process is complete.
    });
GoogleMobileAdsConsentManager.java

Kotlin


UserMessagingPlatform.loadAndShowConsentFormIfRequired(activity) { formError ->
  // Consent gathering process is complete.
}
GoogleMobileAdsConsentManager.kt

プライバシー オプション

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

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

requestConsentInfoUpdate() を呼び出した後、 getPrivacyOptionsRequirementStatus() をチェックして、アプリにプライバシー オプションのエントリ ポイントが必要かどうかを判断します。エントリ ポイントが必要な場合は、プライバシー オプションのフォームを表示する、表示可能で操作可能な UI 要素をアプリに追加します。プライバシー エントリ ポイントが不要な場合は、UI 要素を非表示にして操作できないように構成します。

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

プライバシー オプションの要件ステータスの一覧については、 ConsentInformation.PrivacyOptionsRequirementStatus をご覧ください。

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

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

Java


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

Kotlin


UserMessagingPlatform.showPrivacyOptionsForm(activity, onConsentFormDismissedListener)
GoogleMobileAdsConsentManager.kt

ユーザーの同意を得て広告をリクエストする

広告をリクエストする前に、 canRequestAds() を使用してユーザーの同意を得ているかどうかを確認します。

Java

consentInformation.canRequestAds();

Kotlin

consentInformation.canRequestAds()

同意を得ながら広告をリクエストできるかどうかを確認できる場所は次のとおりです。

  • UMP SDK が現在のセッションで同意を収集した後。
  • requestConsentInfoUpdate() を呼び出した直後。UMP SDK が前のアプリ セッションで同意を得ている可能性があります。

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

広告リクエストの重複を防ぐ

同意を取得した後と requestConsentInfoUpdate() を呼び出した後に canRequestAds() を確認する際は、両方のチェックで true が返される可能性がある重複する広告リクエストをロジックで防ぐようにしてください。たとえば、ブール変数を使用します。

テスト

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

  1. requestConsentInfoUpdate()までお電話ください。

  2. ログの出力で、次の例のようなメッセージを確認します。このメッセージには、デバイス ID と、デバイスをテストデバイスとして追加する方法が表示されます。

    Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231") to set this as a debug device.

  3. テストデバイスの ID をクリップボードにコピーします。

  4. 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 をご覧ください。