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

概要

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

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

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

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

ユーザーの同意情報を取得する

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

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

@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      // Called when consent information is successfully updated.
    },
    (FormError error) {
      // Called when there's an error updating consent information.
    },
  );
}

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

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

@override
void initState() {
  super.initState();

  // Create a ConsentRequestParameters object.
  final params = ConsentRequestParameters();

  // Request an update to consent information on every app launch.
  ConsentInformation.instance.requestConsentInfoUpdate(
    params,
    () async {
      ConsentForm.loadAndShowConsentFormIfRequired((loadAndShowError) {
        if (loadAndShowError != null) {
          // Consent gathering failed.
        }

        // Consent has been gathered.
      });
    },
    (FormError error) {
      // Handle the error.
    },
  );
}

プライバシーオプション

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

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

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

/// Helper variable to determine if the privacy options entry point is required.
Future<bool> isPrivacyOptionsRequired() async {
  return await ConsentInformation.instance
      .getPrivacyOptionsRequirementStatus() ==
      PrivacyOptionsRequirementStatus.required;
}

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

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

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

ConsentForm.showPrivacyOptionsForm((formError) {
  if (formError != null) {
    debugPrint("${formError.errorCode}: ${formError.message}");
  }
});

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

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

await ConsentInformation.instance.canRequestAds()

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

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

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

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

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

テスト

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

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

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

Android

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

iOS

<UMP SDK>To enable debug mode for this device,
set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]

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

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

ConsentDebugSettings debugSettings = ConsentDebugSettings(
  testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
);

ConsentRequestParameters params =
    ConsentRequestParameters(consentDebugSettings: debugSettings);

ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
  // ...
};

地域を強制的に適用する

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

ConsentDebugSettings debugSettings = ConsentDebugSettings(
  debugGeography: DebugGeography.debugGeographyEea,
  testIdentifiers: ["TEST-DEVICE-HASHED-ID"],
);

ConsentRequestParameters params =
    ConsentRequestParameters(consentDebugSettings: debugSettings);

ConsentInformation.instance.requestConsentInfoUpdate(params, () async {
  // ...
};

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

UMP SDK でアプリをテストする際、ユーザーの初回インストールエクスペリエンスをシミュレーションできるように、SDK の状態をリセットすると便利な場合があります。SDK には、これを行う reset() メソッドが用意されています。

ConsentInformation.instance.reset();

GitHub の例

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