アプリから関数を呼び出す

Cloud Functions for Firebase のクライアント SDK を使用すると、Firebase アプリから関数を直接呼び出すことができます。この方法でアプリから関数を呼び出すには、Cloud Functions において HTTPS で呼び出し可能な関数を記述してデプロイし、アプリから関数を呼び出すためのクライアント ロジックを追加します。

呼び出し可能関数は他の HTTP 関数と似ていますが、次の追加機能があります。

  • 呼び出し可能関数では、Firebase Authentication と FCM トークンが使用可能な場合、自動的にリクエストに追加されます。
  • functions.https.onCall トリガーは、自動的にリクエスト本文を逆シリアル化して認証トークンを検証します。

HTTPS で呼び出し可能な関数をサポートするために、Firebase SDK for Cloud Functions v0.9.1 以降は以下の各 Firebase クライアント SDK の最小バージョンと連携して動作します。

  • Firebase SDK for iOS 5.10.0
  • Firebase SDK for Android 16.1.1
  • Firebase JavaScript SDK 5.5.5

サポートされていないプラットフォーム上に構築されたアプリに同様の機能を追加する場合は、https.onCall のプロトコル仕様をご覧ください。ここからは、HTTPS で呼び出し可能な、iOS、Android、ウェブ、C++、Unity 用の関数を作成、デプロイ、呼び出しをする方法について説明します。

呼び出し可能関数の記述とデプロイ

functions.https.onCall を使用して、HTTPS で呼び出し可能な関数を作成します。このメソッドは、data とオプションの context の 2 つのパラメータを受け取ります。

// Saves a message to the Firebase Realtime Database but sanitizes the text by removing swearwords.
exports.addMessage = functions.https.onCall((data, context) => {
  // ...
});

たとえば、テキスト メッセージを Realtime Database に保存する呼び出し可能関数の場合、data にはメッセージ テキストが含まれ、context パラメータはユーザーの認証情報を表します。

// Message text passed from the client.
const text = data.text;
// Authentication / user information is automatically added to the request.
const uid = context.auth.uid;
const name = context.auth.token.name || null;
const picture = context.auth.token.picture || null;
const email = context.auth.token.email || null;

呼び出し可能な関数のロケーションと呼び出し側のクライアントのロケーションが離れている場合、ネットワーク レイテンシが発生する可能性があります。パフォーマンスを改善するには、適切な場所に関数のロケーションを指定し、クライアント側で SDK を初期化するときに設定されたロケーションに合わせて、呼び出し可能な関数のロケーションを調整してください。

結果を返送する

クライアントにデータを返送するには、JSON でエンコード可能なデータを返します。たとえば、付加オペレーションの結果を返すには、次のように使用します。

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: '+',
  operationResult: firstNumber + secondNumber,
};

非同期オペレーションの後にデータを返すには、Promise を返します。Promise によって返されたデータは、クライアントに返送されます。たとえば、呼び出し可能関数が Realtime Database に書き込んだサニタイズ済みのテキストを返すことができます。

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

エラーを処理する

有用なエラーの詳細をクライアントで取得できるようにするには、functions.https.HttpsError のインスタンスをスローする(またはこのインスタンスで拒否された Promise を返す)ことにより、呼び出し可能関数からエラーを返します。エラーには code 属性があり、functions.https.HttpsError にリストされている値の 1 つが設定されます。エラーには文字列 message も含まれています。デフォルトは空の文字列です。エラーでは、オプションの details フィールドに任意の値を設定することもできます。関数から HttpsError 以外のエラーがスローされると、クライアントでは代わりにメッセージ INTERNAL とコード internal が含まれるエラーを受け取ります。

たとえば、関数はデータ検証や認証に関するエラーをスローすることができますが、その際に呼び出し元のクライアントに返すエラー メッセージを付加することができます。

// Checking attribute.
if (!(typeof text === 'string') || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('invalid-argument', 'The function must be called with ' +
      'one arguments "text" containing the message text to add.');
}
// Checking that the user is authenticated.
if (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

呼び出し可能関数をデプロイする

完成した呼び出し可能関数を index.js 内に保存した後、firebase deploy を実行すると、他のすべての関数とともにデプロイされます。呼び出し可能関数のみをデプロイするには、次に示すように --only 引数を使用して部分デプロイを実行します。

$ firebase deploy --only functions:addMessage

クライアント開発環境を設定する

すべての前提条件を満たしていることを確認し、必要な依存関係とクライアント ライブラリをアプリに追加します。

iOS

  1. Firebase を iOS アプリに追加する手順に従います。
  2. Cloud Functions ポッドを Podfile に追加します。
    pod 'Firebase/Core'
    pod 'Firebase/Functions'
  3. ファイルを保存し、pod install を実行します。

ウェブ

  1. Firebase をウェブアプリに追加する手順に従います。
  2. Firebase と Cloud Functions のクライアント ライブラリをアプリに追加します。
    <script src="https://www.gstatic.com/firebasejs/5.5.5/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/5.5.5/firebase-functions.js"></script>
    
    Cloud Functions SDK は、npm パッケージとしても提供されています。
    npm install firebase@5.3.0 --save
    
    Firebase と Cloud Functions の両方を手動で require する必要があります。
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

Android

  1. Android アプリに Firebase を追加する手順に従います。
  2. Cloud Functions Android ライブラリを app/build.gradle ファイルに追加します。
    implementation 'com.google.firebase:firebase-functions:16.1.1'

C++

Android の C ++ の場合:

  1. Firebase を C++ プロジェクトに追加する手順に沿って操作します。
  2. Cloud Functions Android ライブラリを app/build.gradle ファイルに追加します。
    implementation 'com.google.firebase:firebase-functions:16.1.1'
  3. C++ SDK の静的ライブラリ libfirebase_app.alibfirebase_functions.a をリンクします。

iOS の C ++ の場合:

  1. Firebase を C++ プロジェクトに追加する手順に沿って操作します。
  2. Cloud Functions ポッドを Podfile に追加します。
    pod 'Firebase/Core'
    pod 'Firebase/Functions'
  3. ファイルを保存し、pod install を実行します。
  4. C++ SDKfirebase.frameworkfirebase_functions.framework を Xcode プロジェクトに追加します。

Unity

  1. Firebase Unity SDK をダウンロードします。
  2. Firebase を Unity プロジェクトに追加する手順に沿って操作します。
  3. [Assets] > [Import Package] > [Custom Package] メニュー項目を選択します。
  4. 先にダウンロードした Firebase Unity SDK から FirebaseFunctions.unitypackage パッケージをインポートします。
  5. [Import Unity Package] ウィンドウが表示されたら [Import] をクリックします。

クライアント SDK を初期化する

Cloud Functions のインスタンスを初期化します。

Swift

lazy var functions = Functions.functions()

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];

ウェブ

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Android

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

関数を呼び出す

Swift

functions.httpsCallable("addMessage").call(["text": inputField.text]) { (result, error) in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let text = (result?.data as? [String: Any])?["text"] as? String {
    self.resultField.text = text
  }
}

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if (error.domain == FIRFunctionsErrorDomain) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

ウェブ

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.data.text;
  // ...
});

Android

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}

C++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

クライアントでエラーを処理する

サーバーがエラーをスローした場合、または結果の Promise が拒否された場合、クライアントはエラーを受け取ります。

関数から返されたエラーの型が function.https.HttpsError の場合、クライアントはサーバーエラーからエラーの codemessagedetails を受け取ります。それ以外の場合、エラーにはメッセージ INTERNAL とコード INTERNAL が含まれます。呼び出し可能関数でエラーを処理する方法については、ガイダンスをご覧ください。

Swift

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}

Objective-C

if (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

ウェブ

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({text: messageText}).then(function(result) {
  // Read result of the Cloud Function.
  var sanitizedMessage = result.data.text;
}).catch(function(error) {
  // Getting the Error details.
  var code = error.code;
  var message = error.message;
  var details = error.details;
  // ...
});

Android

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }

                    // ...
                }

                // ...
            }
        });

C++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult *result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
// ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

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

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