Firebase Realtime Database トリガー

ベータ版

この機能には、Google Cloud Platform 利用規約の pre-GA サービス規約が適用されます。pre-GA の機能についてはサポートが制限されます。また、pre-GA の機能の変更は他の pre-GA のバージョンと互換性がない可能性があります。詳細については、リリース ステージの説明をご覧ください。

特に、ベータ版トリガーによって生成された CloudEvents は、形式が変更される可能性があります。Source 属性と Subject 属性、追加の拡張属性、データ（ペイロード）形式は、すべて変更される可能性があります。

注: この内容は Cloud Functions（第 1 世代）にのみ適用されます。詳細については、Cloud Functions のバージョンの比較をご覧ください。

Cloud Functions（第 2 世代）で Firebase Realtime Database トリガーを使用するには、Eventarc トリガーを使用します。

Cloud Functions を使用すると、関数と同じ Google Cloud プロジェクトで Firebase Realtime Database 内のイベントを処理できます。Cloud Functions では、完全な管理者権限を使用してデータベース オペレーションを実行できます。また、データベースに対する個々の変更がそれぞれ別個に処理されます。Firebase Realtime Database の変更は、Firebase Admin SDK で行うことができます。

注: アプリケーションで Firebase プロダクトのみを使用する場合、Cloud Functions for Firebase SDK を使用すると、別の Firebase プロダクトを簡単に操作できます。

一般的なライフサイクルの場合、Firebase Realtime Database の関数は以下のように機能します。

1. 特定のデータベースに変更が加えられるのを待ちます。

2. イベントが発生するとトリガーされ、そのタスクを実行します。

3. 指定されたドキュメントに保存されているデータのスナップショットを含むデータ オブジェクトを受け取ります。

イベントタイプ

関数を使用して、2 つのレベルの特性でデータベース イベントを処理できます。作成イベント、更新イベントまたは削除イベントのみリッスンすることも、パスに対するあらゆる種類の変更をリッスンすることもできます。Cloud Functions は、Realtime Database で次のイベントタイプをサポートしています。

イベントタイプ	トリガー
providers/google.firebase.database/eventTypes/ref.write	任意のミューテーション イベントでトリガーされます。Realtime Database 内でデータが作成、更新、削除されるとトリガーされます。
providers/google.firebase.database/eventTypes/ref.create（デフォルト）	Realtime Database で新しいデータが作成されるとトリガーされます。
providers/google.firebase.database/eventTypes/ref.update	Realtime Database でデータが更新されるとトリガーされます。
providers/google.firebase.database/eventTypes/ref.delete	Realtime Database からデータが削除されるとトリガーされます。

データベース パスとインスタンスの指定

関数がトリガーされるタイミングと場所を制御するには、パスを指定する必要があります。必要であれば、データベース インスタンスも指定します。

パス

パスを指定すると、そのパスに関係するすべての書き込みが比較対象となります。指定したパスの下にある任意の場所で発生する書き込みも対象に含まれます。関数のパスを /foo/bar として設定すると、次の場所のイベントはいずれもマッチ対象となります。

 /foo/bar
 /foo/bar/baz/really/deep/path

どちらの場合も、Firebase ではイベントが /foo/bar で発生したと解釈され、イベントデータには /foo/bar の古いデータと新しいデータが含まれます。イベントデータが大きい場合は、データベースのルート付近で単一の関数を使用する代わりに、より深いパスで複数の関数を使用することを検討してください。最高のパフォーマンスを得るには、できるだけ深いレベルのデータのみを要求するようにします。

パス コンポーネントは、中かっこで囲むことでワイルドカードとして指定できます。foo/{bar} は /foo のすべての子と一致します。このワイルドカード パス コンポーネントの値は、関数の event.params オブジェクト内で使用できます。この例では、値は event.params.bar として使用可能になります。

ワイルドカードを含むパスは、1 つの書き込みの複数のイベントに一致する場合があります。次の挿入を見てみましょう。

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

これはパス /foo/{bar} と 2 回一致します。1 回目は "hello": "world" で、2 回目は "firebase": "functions" です。

インスタンス

Google Cloud コンソールを使用する場合は、データベース インスタンスを指定する必要があります。

Google Cloud CLI を使用する場合は、インスタンスを --trigger-resource 文字列の一部として指定する必要があります。

注: このルールは、以前の Firebase コンソールで作成され、その後 Google Cloud Platform に移行されたプロジェクトに適用されません。

たとえば、以下では --trigger-resource 文字列で次が使用されます。

--trigger-resource projects/_/instances/DATABASE_INSTANCE/refs/PATH

注: デフォルト データベースのインスタンス名は、プロジェクト ID か、PROJECT-ID-default-rtdb と同じになります。

イベントの構造

Realtime Database イベントが処理されると、data オブジェクトには 2 つのプロパティが JSON オブジェクト形式で含まれます。

• data: 関数をトリガーしたイベントの前に取得されたデータのスナップショット。

• delta: 関数をトリガーしたイベントの後に取得されたデータのスナップショット。

注: これらのオブジェクトの正確な構造は、データベース自体の構造によって異なります。

コードサンプル

Node.js

/**
 * Background Function triggered by a change to a Firebase RTDB reference.
 *
 * @param {!Object} event The Cloud Functions event.
 * @param {!Object} context The Cloud Functions event context.
 */
exports.helloRTDB = (event, context) => {
  const triggerResource = context.resource;

  console.log(`Function triggered by change to: ${triggerResource}`);
  console.log(`Admin?: ${!!context.auth.admin}`);
  console.log('Delta:');
  console.log(JSON.stringify(event.delta, null, 2));
};

Python

import json

def hello_rtdb(data, context):
    """Triggered by a change to a Firebase RTDB reference.
    Args:
        data (dict): The event payload.
        context (google.cloud.functions.Context): Metadata for the event.
    """
    trigger_resource = context.resource

    print("Function triggered by change to: %s" % trigger_resource)
    print("Admin?: %s" % data.get("admin", False))
    print("Delta:")
    print(json.dumps(data["delta"]))

Go

// Package p contains a Cloud Function triggered by a Firebase Realtime Database
// event.
package p

import (
	"context"
	"fmt"
	"log"

	"cloud.google.com/go/functions/metadata"
)

// RTDBEvent is the payload of a RTDB event.
type RTDBEvent struct {
	Data  interface{} `json:"data"`
	Delta interface{} `json:"delta"`
}

// HelloRTDB handles changes to a Firebase RTDB.
func HelloRTDB(ctx context.Context, e RTDBEvent) error {
	meta, err := metadata.FromContext(ctx)
	if err != nil {
		return fmt.Errorf("metadata.FromContext: %w", err)
	}
	log.Printf("Function triggered by change to: %v", meta.Resource)
	log.Printf("%+v", e)
	return nil
}

Java

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 FirebaseRtdb implements RawBackgroundFunction {
  private static final Logger logger = Logger.getLogger(FirebaseRtdb.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) {
    logger.info("Function triggered by change to: " + context.resource());

    JsonObject body = gson.fromJson(json, JsonObject.class);

    boolean isAdmin = false;
    if (body != null && body.has("auth")) {
      JsonObject authObj = body.getAsJsonObject("auth");
      isAdmin = authObj.has("admin") && authObj.get("admin").getAsBoolean();
    }

    logger.info("Admin?: " + isAdmin);

    if (body != null && body.has("delta")) {
      logger.info("Delta:");
      logger.info(body.get("delta").toString());
    }
  }
}

C#

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

namespace FirebaseRtdb;

public class Function : ICloudEventFunction<ReferenceEventData>
{
    private readonly ILogger _logger;

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

    public Task HandleAsync(CloudEvent cloudEvent, ReferenceEventData data, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Function triggered by change to {subject}", cloudEvent.Subject);
        _logger.LogInformation("Delta: {delta}", data.Delta);

        // 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

require "functions_framework"

# Triggered by a change to a Firebase RTDB document.
FunctionsFramework.cloud_event "hello_rtdb" 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 change to: #{event.source}"
  logger.info "Admin?: #{payload.fetch 'admin', false}"
  logger.info "Delta: #{payload['delta']}"
end

PHP

use Google\CloudFunctions\CloudEvent;

function firebaseRTDB(CloudEvent $cloudevent)
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    fwrite($log, 'Event: ' . $cloudevent->getId() . PHP_EOL);

    $data = $cloudevent->getData();
    $resource = $data['resource'] ?? '<null>';

    fwrite($log, 'Function triggered by change to: ' . $resource . PHP_EOL);

    $isAdmin = isset($data['auth']['admin']) && $data['auth']['admin'] == true;

    fwrite($log, 'Admin?: ' . var_export($isAdmin, true) . PHP_EOL);
    fwrite($log, 'Delta: ' . json_encode($data['delta'] ?? '') . PHP_EOL);
}

関数のデプロイ

次の gcloud コマンドは、パス /messages/{pushId}/original の create イベントによってトリガーされる関数をデプロイします。

gcloud functions deploy FUNCTION_NAME \
  --entry-point ENTRY_POINT \
  --trigger-event providers/google.firebase.database/eventTypes/ref.create \
  --trigger-resource projects/_/instances/DATABASE_INSTANCE/refs/messages/{pushId}/original \
  --runtime RUNTIME

注: Google Cloud CLI コマンドライン ツールを使用して関数をデプロイする場合、deploy コマンドを実行するコードに含まれる関数の名前をコマンドに指定する必要があります。この関数は、実装のニーズに応じて、FUNCTION_NAME またはオプションの --entry-point フラグで指定します。このトピックの詳細については、gcloud CLI によるデプロイをご覧ください。

引数	説明
FUNCTION_NAME	デプロイする Cloud Functions の関数の登録名。ソースコード内の関数の名前にすることも、任意の文字列にすることもできます。FUNCTION_NAME が任意の文字列の場合は、--entry-point フラグを含める必要があります。
--entry-point ENTRY_POINT	ソースコード内の関数またはクラスの名前。FUNCTION_NAME を使用して、デプロイ時に実行する関数をソースコードに指定していない場合は省略できます。それ以外の場合は、--entry-point を使用して実行可能関数の名前を指定する必要があります。
--trigger-event NAME	関数が受信するイベントタイプの名前。この場合、write、create、update、delete のいずれかになります。
--trigger-resource NAME	関数がリッスンするデータベース パスの完全修飾名。次の形式に従う必要があります。 projects/_/instances/DATABASE_INSTANCE/refs/PATH
--runtime RUNTIME	使用しているランタイムの名前。網羅的なリストについては、gcloud リファレンスをご覧ください。