Save the date - Google I/O returns May 18-20. Register to get the most out of the digital experience: Build your schedule, reserve space, participate in Q&As, earn Google Developer profile badges, and more. Register now
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

अपने ऐप से कॉल फ़ंक्शन करें

Firebase क्लाइंट SDKs के लिए क्लाउड फ़ंक्शंस आपको सीधे Firebase ऐप से फ़ंक्शन करने देता है। इस तरह से अपने ऐप से फ़ंक्शन को कॉल करने के लिए, क्लाउड फ़ंक्शंस में HTTPS Callable फ़ंक्शन को लिखें और तैनात करें, और फिर अपने ऐप से फ़ंक्शन को कॉल करने के लिए क्लाइंट लॉजिक जोड़ें।

यह ध्यान रखना महत्वपूर्ण है कि HTTPS कॉल करने योग्य फ़ंक्शन समान हैं लेकिन HTTP फ़ंक्शन के समान नहीं हैं । HTTPS प्रतिदेय कार्यों का उपयोग करने के लिए आप ग्राहक एसडीके अपने मंच के लिए एक साथ के साथ उपयोग करना चाहिए functions.https बैकएंड API (या प्रोटोकॉल लागू)। कॉलबल्स में HTTP फ़ंक्शन से ये महत्वपूर्ण अंतर हैं:

  • कॉलबल्स के साथ, जब उपलब्ध हो, फायरबेस प्रमाणीकरण और एफसीएम टोकन स्वचालित रूप से अनुरोधों में शामिल हैं।
  • functions.https.onCall .https.onCall ट्रिगर स्वचालित रूप से अनुरोध निकाय को दिखाता है और ऑर्किटेक्ट टोकन को सत्यापित करता है।

क्लाउड फ़ंक्शंस v0.9.1 के लिए Firebase SDK और HTTPS Callable फ़ंक्शन का समर्थन करने के लिए इन Firebase क्लाइंट SDK न्यूनतम संस्करणों के साथ उच्च इंटरऑप्टर:

  • आईओएस 7.11.0 के लिए फायरबेस एसडीके
  • Android 19.2.0 के लिए फायरबेस एसडीके
  • फायरबेस जावास्क्रिप्ट एसडीके 8.5.0
  • फायरबेस मॉड्यूलर वेब एसडीके वी। 9.0

यदि आप असमर्थित प्लेटफ़ॉर्म पर बनाए गए ऐप में समान कार्यक्षमता जोड़ना चाहते हैं, तो https.onCall लिए प्रोटोकॉल विशिष्टता देखें। इस गाइड के बाकी हिस्सों में iOS, Android, वेब, C ++ और यूनिटी के लिए HTTPS कॉल करने योग्य फ़ंक्शन लिखने, तैनात करने और कॉल करने के निर्देश दिए गए हैं।

कॉल करने योग्य फ़ंक्शन लिखें और तैनात करें

HTTPS कॉल करने योग्य फ़ंक्शन बनाने के लिए functions.https.onCall का उपयोग करें। यह विधि दो पैरामीटर लेती है: data और वैकल्पिक context :

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

एक कॉल करने योग्य फ़ंक्शन के लिए, जो रियलटाइम डेटाबेस के लिए एक टेक्स्ट संदेश बचाता है, उदाहरण के लिए, 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;

कॉल करने योग्य फ़ंक्शन के स्थान और कॉलिंग क्लाइंट के स्थान के बीच की दूरी नेटवर्क विलंबता बना सकती है। प्रदर्शन का अनुकूलन करने के लिए, जहां लागू हो, फ़ंक्शन स्थान को निर्दिष्ट करने पर विचार करें, और क्लाइंट साइड पर एसडीके को इनिशियलाइज़ करने पर स्थान सेट के साथ कॉल करने योग्य स्थान को संरेखित करना सुनिश्चित करें।

परिणाम वापस भेजना

ग्राहक को डेटा वापस भेजने के लिए, JSON एनकोडेड डेटा वापस कर सकते हैं। उदाहरण के लिए, एक अतिरिक्त ऑपरेशन के परिणाम को वापस करने के लिए:

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

एक अतुल्यकालिक ऑपरेशन के बाद डेटा वापस करने के लिए, एक वादा वापस करें। वादा द्वारा लौटाए गए डेटा को क्लाइंट को वापस भेज दिया जाता है। उदाहरण के लिए, आप स्वच्छता संबंधी पाठ को लौटा सकते हैं जिसे कॉल करने योग्य फ़ंक्शन ने रियलटाइम डेटाबेस को लिखा था:

// 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 एक उदाहरण को फेंकने से (या खारिज किए गए एक वादे) को कॉल करने योग्य त्रुटियों को लौटाएं। त्रुटि में एक code विशेषता होती है, जो functions.https.HttpsError .https.HttpsError पर सूचीबद्ध मानों में से एक हो सकती functions.https.HttpsError । त्रुटियों में एक स्ट्रिंग message भी होता है, जो एक रिक्त स्ट्रिंग में चूक करता है। वे एक मनमाना मूल्य के साथ एक वैकल्पिक details क्षेत्र भी रख सकते हैं। यदि आपके कार्यों से HttpsError अलावा कोई त्रुटि HttpsError है, तो आपके क्लाइंट को INTERNAL संदेश और कोड internal साथ एक त्रुटि प्राप्त होती है।

उदाहरण के लिए, एक फ़ंक्शन कॉलिंग क्लाइंट पर लौटने के लिए त्रुटि संदेशों के साथ डेटा सत्यापन और प्रमाणीकरण त्रुटियों को फेंक सकता है:

074691 ए 400

कॉल करने योग्य फ़ंक्शन को तैनात करें

जब आप index.js भीतर एक पूरा होने योग्य index.js योग्य फ़ंक्शन को सहेजते हैं, तो यह तैनात किया जाता है अन्य सभी कार्यों के साथ जब आप firebase deploy । केवल --only करने योग्य को तैनात करने के लिए, आंशिक रूप से प्रदर्शन करने के लिए दिखाए गए अनुसार - केवल तर्क का उपयोग करें:

$ firebase deploy --only functions:addMessage

यदि आप फ़ंक्शन को लागू करते समय अनुमतियों की त्रुटियों का सामना करते हैं, तो सुनिश्चित करें कि तैनाती आदेशों को चलाने वाले उपयोगकर्ता को उपयुक्त IAM भूमिकाएं सौंपी गई हैं।

अपना क्लाइंट डेवलपमेंट वातावरण सेट करें

सुनिश्चित करें कि आप किसी भी आवश्यक शर्तें को पूरा करते हैं, फिर अपने ऐप में आवश्यक निर्भरताएं और क्लाइंट लाइब्रेरी जोड़ें।

आईओएस

  1. अपने आईओएस ऐप में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. अपने Podfile में क्लाउड फ़ंक्शंस पॉड जोड़ें:
    pod 'Firebase/Functions'
  3. फ़ाइल सहेजें, फिर चलाएँ:
    pod install

वेब 9

  1. अपने वेब ऐप में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. अपने ऐप में फायरबेस कोर और क्लाउड फ़ंक्शंस क्लाइंट लाइब्रेरी जोड़ें:
    <script src="https://www.gstatic.com/firebasejs/8.5.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.5.0/firebase-functions.js"></script>
    

क्लाउड फ़ंक्शंस SDK भी एक npm पैकेज के रूप में उपलब्ध है।

  1. अपने टर्मिनल से निम्न आदेश चलाएँ:
    npm install firebase@8.5.0 --save
    
  2. मैन्युअल रूप से फायरबेस कोर और क्लाउड फ़ंक्शंस दोनों की आवश्यकता होती है:

    import { initializeApp } from 'firebase/app';
    import { initializeFunctions } from 'firebase/functions';

    const app = initializeApp({ projectId: '### CLOUD FUNCTIONS PROJECT ID ###', apiKey: '### FIREBASE API KEY ###', authDomain: '### FIREBASE AUTH DOMAIN ###', }); const functions = initializeFunctions(app);

वेब v8

  1. अपने वेब ऐप में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. अपने ऐप में फायरबेस कोर और क्लाउड फ़ंक्शंस क्लाइंट लाइब्रेरी जोड़ें:
    <script src="https://www.gstatic.com/firebasejs/8.5.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/8.5.0/firebase-functions.js"></script>
    

क्लाउड फ़ंक्शंस SDK भी एक npm पैकेज के रूप में उपलब्ध है।

  1. अपने टर्मिनल से निम्न आदेश चलाएँ:
    npm install firebase@8.5.0 --save
    
  2. मैन्युअल रूप से फायरबेस कोर और क्लाउड फ़ंक्शंस दोनों की आवश्यकता होती है:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

जावा

  1. अपने Android ऐप में Firebase जोड़ने के निर्देशों का पालन करें।

  2. Firebase Android BoM का उपयोग करते हुए, अपने मॉड्यूल (ऐप-स्तरीय) ग्रेड फ़ाइल (आमतौर पर app/build.gradle ) में क्लाउड फ़ंक्शंस Android लाइब्रेरी के लिए निर्भरता की घोषणा करें।

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:27.1.0')
    
        // Declare the dependency for the Cloud Functions library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions'
    }
    

    Firebase Android BoM का उपयोग करके, आपका ऐप हमेशा Firebase Android पुस्तकालयों के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना Firebase पुस्तकालय निर्भरता घोषित करें

    यदि आप Firebase BoM का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक Firebase लाइब्रेरी संस्करण को उसकी निर्भरता लाइन में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में कई फायरबेस लाइब्रेरी का उपयोग करते हैं , तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए BoM का उपयोग करने की अत्यधिक अनुशंसा करते हैं, जो यह सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    dependencies {
        // Declare the dependency for the Cloud Functions library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions:19.2.0'
    }
    

कोटलिन + केटीएक्स

  1. अपने Android ऐप में Firebase जोड़ने के निर्देशों का पालन करें।

  2. Firebase Android BoM का उपयोग करते हुए, अपने मॉड्यूल (ऐप-स्तरीय) ग्रेड फ़ाइल (आमतौर पर app/build.gradle ) में क्लाउड फ़ंक्शंस एंड्रॉइड लाइब्रेरी के लिए निर्भरता की घोषणा करें।

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:27.1.0')
    
        // Declare the dependency for the Cloud Functions library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions-ktx'
    }
    

    Firebase Android BoM का उपयोग करके, आपका ऐप हमेशा Firebase Android पुस्तकालयों के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना Firebase पुस्तकालय निर्भरता घोषित करें

    यदि आप Firebase BoM का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक Firebase लाइब्रेरी संस्करण को उसकी निर्भरता लाइन में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में कई फायरबेस लाइब्रेरी का उपयोग करते हैं , तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए BoM का उपयोग करने की अत्यधिक अनुशंसा करते हैं, जो यह सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    dependencies {
        // Declare the dependency for the Cloud Functions library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-functions-ktx:19.2.0'
    }
    

सी ++

Android के साथ C ++ के लिए :

  1. अपने C ++ प्रोजेक्ट में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने CMakeLists.txt फ़ाइल में firebase_functions लाइब्रेरी जोड़ें।

IOS के साथ C ++ के लिए :

  1. अपने C ++ प्रोजेक्ट में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने Podfile में क्लाउड फ़ंक्शंस पॉड जोड़ें:
    pod 'Firebase/Functions'
  3. फ़ाइल सहेजें, फिर चलाएँ:
    pod install
  4. अपने Xcode प्रोजेक्ट में Firebase C ++ SDK से फायरबेस कोर और क्लाउड फ़ंक्शंस चौखटे जोड़ें।
    • firebase.framework
    • firebase_functions.framework

एकता

  1. अपने एकता प्रोजेक्ट में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. जोड़े FirebaseFunctions.unitypackage से Firebase एकता एसडीके अपने एकता परियोजना के लिए।

क्लाइंट SDK को इनिशियलाइज़ करें

क्लाउड फ़ंक्शंस का एक उदाहरण प्रारंभ करें:

तीव्र

lazy var functions = Functions.functions()

उद्देश्य सी

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

वेब v8

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();

वेब 9

initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});

जावा

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

कोटलिन + केटीएक्स

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions

सी ++

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

एकता

functions = Firebase.Functions.DefaultInstance;

फ़ंक्शन को कॉल करें

तीव्र

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 data = result?.data as? [String: Any], let text = data["text"] as? String {
    self.resultField.text = text
  }
}

उद्देश्य सी

[[_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"];
}];

वेब v8

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

वेब 9

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });

जावा

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;
                }
            });
}

कोटलिन + केटीएक्स

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true
    )

    return functions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith { task ->
                // This continuation runs on either success or failure, but if the task
                // has failed then result will throw an Exception which will be
                // propagated down.
                val result = task.result?.data as String
                result
            }
}

सी ++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::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);
}

एकता

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;
  });
}
है

क्लाइंट पर त्रुटियों को हैंडल करें

यदि सर्वर ने कोई त्रुटि की या परिणामी वादा अस्वीकार कर दिया गया, तो क्लाइंट को एक त्रुटि मिलती है।

यदि फ़ंक्शन द्वारा दी गई त्रुटि प्रकार function.https.HttpsError , तो क्लाइंट को सर्वर त्रुटि से त्रुटि code , message और details प्राप्त होता है। अन्यथा, त्रुटि में संदेश INTERNAL और कोड INTERNAL । अपने कॉल करने योग्य फ़ंक्शन में त्रुटियों को कैसे प्रबंधित करें, इसके लिए मार्गदर्शन देखें।

तीव्र

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 (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

वेब v8

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

वेब 9

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });
है

जावा

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();
                    }

                    // ...
                }

                // ...
            }
        });

कोटलिन + केटीएक्स

addMessage(inputMessage)
        .addOnCompleteListener(OnCompleteListener { task ->
            if (!task.isSuccessful) {
                val e = task.exception
                if (e is FirebaseFunctionsException) {
                    val code = e.code
                    val details = e.details
                }

                // ...
            }

            // ...
        })

सी ++

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.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

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

एकता

 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;
  }
});