メール アクションで状態を渡す

パスワードの再設定や、ユーザーのメールアドレスを確認する目的でメール アクションを送信するときに、続行 URL を使用して状態を渡すことができます。これにより、ユーザーはアクションの完了後にアプリに戻れるようになります。また、モバイルアプリがインストールされている場合に、ウェブページではなくモバイルアプリからメール アクション リンクが直接処理されるようにデベロッパー側で指定することも可能です。

この動作は、以下のようなよくある状況では非常に役立ちます。

  • 現在ログインしていないユーザーがログインの必要なコンテンツにアクセスしようとしているが、パスワードを忘れたため、パスワードを再設定するフローをトリガーする場合。ユーザーはこのフローの終了後、元々アクセスしようとしていたアプリのセクションに戻ることを期待します。

  • 確認済みのアカウントにしかアクセスを許可しないアプリの場合。たとえば、ニュースレターの登録では、ユーザーにメールアドレスの確認を求めます。ユーザーはメール確認フローを処理した後に、アプリに戻って登録を完了できることを期待します。

  • その他、ユーザーがモバイル端末からフローを開始した場合。ユーザーはフローの確認後、ブラウザではなくモバイルアプリに戻ることを期待します。

続行 URL を使用して状態を受け渡せる機能は、ユーザー エクスペリエンスを大幅に向上させることができる Firebase Auth の強力な特長です。

メール アクションで状態 / 続行 URL を渡す

続行 URL を安全に渡すには、URL のドメインが Firebase コンソールでホワイトリストに登録されている必要があります。それには、[Authentication] セクションで、[ログイン方法] タブの下にある [承認済みドメイン] のリストにこのドメインを追加します(まだ存在しない場合)。

パスワードの再設定メールまたは確認メールを送信する際は、ActionCodeSettings インスタンスを指定する必要があります。このインスタンスは、関連する ActionCodeSettings.Builder クラスを使用して作成できます。このクラスには次のメソッドが含まれています。

メソッド 説明
setUrl(String url)

コンテキストによって異なる意味を持つリンク(状態 / 続行 URL)を設定します。

  • リンクがウェブ アクション ウィジェットで処理される場合、これは continueUrl クエリ パラメータのディープリンクを表します。
  • リンクがアプリ内で直接処理される場合、これはダイナミック リンクのディープリンク内の continueUrl クエリ パラメータを表します。
setIOSBundleId(String iOSBundleId) iOS バンドル ID を設定します。これにより、iOS アプリがインストールされている場合に、そのアプリでリンクを開こうとします。iOS アプリはコンソールに登録されている必要があります。
setAndroidPackageName(String androidPackageName, boolean installIfNotAvailable, String minimumVersion) Android パッケージ名を設定します。これにより、Android アプリがインストールされている場合に、そのアプリでリンクを開くことを試みます。installIfNotAvailable を true に設定すると、Android アプリがサポートされる端末に Android アプリがまだインストールされていない場合に、Android アプリをインストールするかどうかが指定されます。minimumVersion が指定され、古いバージョンのアプリがインストールされている場合、ユーザーは Play ストアにリダイレクトされ、アプリのアップグレードを促されます。Android アプリはコンソールに登録されている必要があります。
setHandleCodeInApp(boolean status) メール アクション リンクがモバイルアプリとウェブリンクのどちらで最初に開かれるかを示します。デフォルトは false です。true に設定すると、アクション コード リンクはユニバーサル リンクまたは Android アプリリンクとして送信され、アプリがインストールされている場合はそのアプリで開かれます。false の場合、コードは最初にウェブ ウィジェットに送信され、続いてアプリがインストールされている場合はそのアプリにリダイレクトされます。

次の例は、モバイルアプリで最初に Firebase ダイナミック リンク(iOS アプリ com.example.ios または Android アプリ com.example.android)として開かれるメール確認リンクを送信する方法を示しています。ディープリンクには、続行 URL ペイロード https://www.example.com/?email=user@example.com が含まれています。

FirebaseAuth auth = FirebaseAuth.getInstance();
FirebaseUser user = auth.getCurrentUser();

String url = "http://www.example.com/verify?uid=" + user.getUid();
ActionCodeSettings actionCodeSettings = ActionCodeSettings.newBuilder()
        .setUrl(url)
        .setIOSBundleId("com.example.ios")
        // The default for this is populated with the current android package name.
        .setAndroidPackageName("com.example.android", false, null)
        .build();

user.sendEmailVerification(actionCodeSettings)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                if (task.isSuccessful()) {
                    Log.d(TAG, "Email sent.");
                }
            }
        });

Firebase Auth では、モバイルアプリで開かれるリンクを送信するときに Firebase Dynamic Links が使用されます。この機能を使用するには、Firebase コンソールで Dynamic Links を構成する必要があります。

  1. Firebase Dynamic Links を有効にします。

    1. Firebase コンソールで [Dynamic Links] セクションを開きます。
    2. Dynamic Links の利用規約をまだ受け入れておらず、また Dynamic Links のドメインをまだ作成していない場合は、この時点でその作業を行います。

      Dynamic Links のドメインが作成済みである場合は、それをメモしておきます。Dynamic Links のドメインは、通常、次の例のようになります。

      example.page.link

      受信リンクをインターセプトするように iOS または Android アプリを構成するときに、この値が必要になります。

  2. Android アプリを構成します。

    1. Android アプリでこれらのリンクを処理する予定の場合は、Firebase コンソールのプロジェクト設定で Android パッケージ名を指定する必要があります。それに加えて、アプリ証明書の SHA-1 および SHA-256 を指定する必要があります。
    2. AndroidManifest.xml ファイルで、ディープリンクのインテント フィルタを設定する必要があります。
    3. 詳しくは、Android Dynamic Links の受信の手順をご覧ください。
  3. iOS アプリを設定します。

    1. iOS アプリでこれらのリンクを処理する予定の場合は、Firebase コンソールのプロジェクト設定で iOS バンドル ID を指定する必要があります。それに加えて、App Store ID と Apple デベロッパー チーム ID を指定する必要があります。
    2. FDL ユニバーサル リンク ドメインをアプリ機能の関連ドメインとして構成する必要があります。
    3. アプリを iOS バージョン 8 以下に配布する予定がある場合は、iOS バンドル ID を受信 URL のカスタム スキームとして設定する必要があります。
    4. 詳しくは、iOS Dynamic Links の受信の手順をご覧ください。

ウェブアプリでメール アクションを処理する

最初にウェブアプリでアクション コード リンクを処理し、正常に完了した後で別のウェブページまたはモバイルアプリ(使用可能な場合)にリダイレクトするかどうかを指定できます。この操作を行うには、setHandleCodeInApp(false)ActionCodeSettings.Builder オブジェクト内で呼び出します。iOS バンドル ID または Android パッケージ名は必須ではありませんが、指定すると、メール アクション コードの完了時に、指定されたアプリにユーザーをリダイレクトすることができます。

ここで使用されるウェブ URL は、メール アクション テンプレートのセクションで設定された URL です。デフォルトの URL がすべてのプロジェクトにプロビジョニングされます。メール アクション ハンドラをカスタマイズする方法について詳しくは、メールハンドラのカスタマイズをご覧ください。

この場合、continueUrl クエリ パラメータ内のリンクは、ActionCodeSettings オブジェクトで指定された URL がペイロードに含まれる FDL リンクになります。アプリからの受信リンクは、他の依存関係なしでもインターセプトして処理することができますが、FDL クライアント ライブラリを使用してディープリンクを解析することをおすすめします。

モバイルアプリでメール アクションを処理する

モバイルアプリがインストールされている場合に、最初にモバイルアプリ内でアクション コード リンクを処理するかどうかを指定できます。Android アプリの場合は、installIfNotAvailable ブール値を使って、端末でサポートされているものの、まだインストールされていないアプリをインストールするよう指定することもできます。そのモバイルアプリをサポートしていない端末からリンクがクリックされた場合、リンクはウェブページから開かれます。この操作を行うには、setHandleCodeInApp(true)ActionCodeSettings.Builder オブジェクト内で呼び出します。モバイルアプリの Android パッケージ名または iOS バンドル ID も指定する必要があります。

モバイルアプリが使用できない場合に使用される代替ウェブ URL は、メール アクション テンプレートのセクションで設定された URL です。デフォルトの URL がすべてのプロジェクトにプロビジョニングされます。メール アクション ハンドラをカスタマイズする方法について詳しくは、メールハンドラのカスタマイズをご覧ください。

この場合、ユーザーに送信されるモバイルアプリ リンクは、コンソールで設定されたアクション コード URL にクエリ パラメータ oobCodemodeapiKeycontinueUrl が追加されたものをペイロードに含む FDL リンクとなります。後者は、ActionCodeSettings オブジェクトで指定された元の URL になります。アプリからの受信リンクは、他の依存関係なしでもインターセプトして処理することができますが、FDL クライアント ライブラリを使用してディープリンクを解析することをおすすめします。アクション コードは、メールハンドラのカスタマイズで説明されているウェブフローからの処理方法と同様に、モバイルアプリから直接適用できます。

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。