Firebase Authentication トリガー

Cloud Functions は、その関数と同じ Cloud プロジェクトの Firebase Authentication のイベントによってトリガーできます。これには、ユーザーの作成やユーザーの削除などのイベントが含まれます。たとえば、アプリでアカウントを作成したばかりのユーザーに登録完了の通知メールを送信できます。

イベントの種類

Firebase Authentication は、create と delete イベントに応じて関数をトリガーできます。

イベントタイプ	トリガー
`providers/firebase.auth/eventTypes/user.create`	ユーザーアカウントが作成されるとトリガーされます。
`providers/firebase.auth/eventTypes/user.delete`	ユーザーアカウントが削除されるとトリガーされます。

ユーザーの作成

Firebase アカウントでは、以下の場合に Cloud Functions のユーザー作成イベントがトリガーされます。

ユーザーがメールアカウントとパスワードを作成します。
ユーザーがフェデレーション ID プロバイダを使用して初めてログインしたとき。
デベロッパーが Firebase Admin SDK を使用してアカウントを作成したとき。
ユーザーが新しい匿名 Auth セッションに初めてログインします。

ユーザーの削除

ユーザーの削除時にトリガーするように関数を構成することもできます。

イベントの構造

イベントデータは、UserRecord オブジェクトとして指定されます。

以下に、パスワードベースのアカウントの作成イベントの例を示します。

{
  "email": "me@example.com",
  "metadata": {
      "createdAt": "2018-10-19T19:29:16Z"
  },
  "uid": "XXXXX"
}

このオブジェクトの一部のプロパティは、特定の認証方法を使用する場合にのみ定義されます。たとえば、パスワードベースのアカウントイベントは、ユーザーのメールアドレスを含む email プロパティを定義します。プロジェクトに固有のユーザー ID を含む uid プロパティは常に定義されます。

サンプルコード

Node.js

functions/firebase/index.js

GitHub で表示フィードバック

/**
 * Background Function triggered by a change to a Firebase Auth user object.
 *
 * @param {!Object} event The Cloud Functions event.
 */
exports.helloAuth = event => {
  try {
    console.log(`Function triggered by change to user: ${event.uid}`);
    console.log(`Created at: ${event.metadata.createdAt}`);

    if (event.email) {
      console.log(`Email: ${event.email}`);
    }
  } catch (err) {
    console.error(err);
  }
};

Python

functions/firebase/main.py

GitHub で表示フィードバック

import json
def hello_auth(data, context):
    """ Triggered by creation or deletion of a Firebase Auth user object.
     Args:
            data (dict): The event payload.
            context (google.cloud.functions.Context): Metadata for the event.
    """
    print('Function triggered by creation/deletion of user: %s' % data["uid"])
    print('Created at: %s' % data["metadata"]["createdAt"])

    if 'email' in data:
        print('Email: %s' % data["email"])

Go

functions/firebase/auth.go

GitHub で表示フィードバック


// Package firebase contains a Firestore Cloud Function.
package firebase

import (
	"context"
	"log"
	"time"
)

// AuthEvent is the payload of a Firestore Auth event.
type AuthEvent struct {
	Email    string `json:"email"`
	Metadata struct {
		CreatedAt time.Time `json:"createdAt"`
	} `json:"metadata"`
	UID string `json:"uid"`
}

// HelloAuth is triggered by Firestore Auth events.
func HelloAuth(ctx context.Context, e AuthEvent) error {
	log.Printf("Function triggered by creation or deletion of user: %q", e.UID)
	log.Printf("Created at: %v", e.Metadata.CreatedAt)
	if e.Email != "" {
		log.Printf("Email: %q", e.Email)
	}
	return nil
}

Java

functions/firebase/auth/src/main/java/functions/FirebaseAuth.java

GitHub で表示フィードバック

import com.google.cloud.functions.Context;
import com.google.cloud.functions.RawBackgroundFunction;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import java.util.logging.Logger;

public class FirebaseAuth implements RawBackgroundFunction {
  private static final Logger logger = Logger.getLogger(FirebaseAuth.class.getName());

  // Use GSON (https://github.com/google/gson) to parse JSON content.
  private static final Gson gson = new Gson();

  @Override
  public void accept(String json, Context context) {
    JsonObject body = gson.fromJson(json, JsonObject.class);

    if (body != null && body.has("uid")) {
      logger.info("Function triggered by change to user: " + body.get("uid").getAsString());
    }

    if (body != null && body.has("metadata")) {
      JsonObject metadata = body.get("metadata").getAsJsonObject();
      logger.info("Created at: " + metadata.get("createdAt").getAsString());
    }

    if (body != null && body.has("email")) {
      logger.info("Email: " + body.get("email").getAsString());
    }
  }
}

C#

functions/firebase/FirebaseAuth/Function.cs

GitHub で表示フィードバック

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Firebase.Auth.V1;
using Microsoft.Extensions.Logging;
using System.Threading;
using System.Threading.Tasks;

namespace FirebaseAuth
{
    public class Function : ICloudEventFunction<AuthEventData>
    {
        private readonly ILogger _logger;

        public Function(ILogger<Function> logger) =>
            _logger = logger;

        public Task HandleAsync(CloudEvent cloudEvent, AuthEventData data, CancellationToken cancellationToken)
        {
            _logger.LogInformation("Function triggered by change to user: {uid}", data.Uid);
            if (data.Metadata is UserMetadata metadata)
            {
                _logger.LogInformation("User created at: {created:s}", metadata.CreateTime.ToDateTimeOffset());
            }
            if (!string.IsNullOrEmpty(data.Email))
            {
                _logger.LogInformation("Email: {email}", data.Email);
            }

            // In this example, we don't need to perform any asynchronous operations, so the
            // method doesn't need to be declared async.
            return Task.CompletedTask;
        }
    }
}

Ruby

functions/firebase/auth/app.rb

GitHub で表示フィードバック

require "functions_framework"

# Triggered by creation or deletion of a Firebase Auth user object.
FunctionsFramework.cloud_event "hello_auth" do |event|
  # Event-triggered Ruby functions receive a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  # The Firebase event payload can be obtained from the `data` field.
  payload = event.data

  logger.info "Function triggered by creation/deletion of user: #{payload['uid']}"
  logger.info "Created at: #{payload['metadata']['createdAt']}"
  logger.info "Email: #{payload['email']}" if payload.key? "email"
end

PHP

functions/firebase_auth/index.php

GitHub で表示フィードバック


use Google\CloudFunctions\CloudEvent;

function firebaseAuth(CloudEvent $cloudevent)
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');
    $data = $cloudevent->getData();

    fwrite(
        $log,
        'Function triggered by change to user: ' . $data['uid'] . PHP_EOL
    );
    fwrite($log, 'Created at: ' . $data['metadata']['createTime'] . PHP_EOL);

    if (isset($data['email'])) {
        fwrite($log, 'Email: ' . $data['email'] . PHP_EOL);
    }
}

関数のデプロイ

関数をデプロイするには、Firebase Authentication が構成されているイベントタイプとプロジェクトを指定する必要があります。Cloud Console にはイベントタイプのフィールドが 1 つ表示されます。これは、プロジェクトが関数を含むプロジェクトと同じであると想定されるためです。

コマンドラインの場合は、この 2 つのパラメータを指定するために特定の文字列を使用する必要があります。次の gcloud コマンドは、ユーザーの create イベントによってトリガーされる関数をデプロイします。

gcloud functions deploy FUNCTION_NAME \
  --entry-point ENTRY_POINT \
  --trigger-event providers/firebase.auth/eventTypes/user.create \
  --trigger-resource YOUR_PROJECT_ID \
  --runtime RUNTIME

引数	説明
`FUNCTION_NAME`	デプロイする Cloud Functions の関数の登録名。ソースコード内の関数の名前にすることも、任意の文字列にすることもできます。`FUNCTION_NAME` が任意の文字列の場合は、`--entry-point` フラグを含める必要があります。
`--entry-point ENTRY_POINT`	ソースコード内の関数またはクラスの名前。`FUNCTION_NAME` を使用して、デプロイ時に実行する関数をソースコードに指定していない場合は省略できます。その場合は、`--entry-point` を使用して実行可能関数の名前を指定する必要があります。
`--trigger-event NAME`	関数をトリガーするイベントタイプの名前。この場合、上記のように create または delete のいずれかにする必要があります。
`--trigger-resource NAME`	関数と Firebase Authentication を含むプロジェクトのプロジェクト ID（この例では `YOUR_PROJECT_ID`）。
`--runtime RUNTIME`	使用しているランタイムの名前。網羅的なリストについては、`gcloud` リファレンスをご覧ください。