Firebase रिमोट कॉन्फ़िगरेशन का इस्तेमाल शुरू करना

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

रिमोट कॉन्फ़िगरेशन लाइब्रेरी का इस्तेमाल इन-ऐप्लिकेशन डिफ़ॉल्ट पैरामीटर वैल्यू को स्टोर करने, रिमोट कॉन्फ़िगरेशन बैकएंड से अपडेट की गई पैरामीटर वैल्यू को फ़ेच करने, और आपके ऐप्लिकेशन पर लाई गई वैल्यू उपलब्ध होने पर कंट्रोल करने के लिए किया जाता है. ज़्यादा जानने के लिए, रिमोट कॉन्फ़िगरेशन लोड करने की रणनीतियां देखें.

इस गाइड में, इसका इस्तेमाल शुरू करने का तरीका बताया गया है. साथ ही, कुछ सैंपल कोड भी दिए गए हैं. ये कोड firebase/Quickstart-unity GitHub रिपॉज़िटरी से क्लोन करने या डाउनलोड करने के लिए उपलब्ध हैं.

पहला चरण: अपने ऐप्लिकेशन में रिमोट कॉन्फ़िगरेशन जोड़ना

रिमोट कॉन्फ़िगरेशन का इस्तेमाल करने से पहले, आपको ये काम करने होंगे:

Firebase का इस्तेमाल करने के लिए, अपना Unity प्रोजेक्ट रजिस्टर करें और कॉन्फ़िगर करें.
- अगर आपका Unity प्रोजेक्ट पहले से ही Firebase का इस्तेमाल कर रहा है, तो इसका मतलब है कि यह Firebase के लिए पहले से रजिस्टर और कॉन्फ़िगर है.
- अगर आपके पास Unity प्रोजेक्ट नहीं है, तो सैंपल ऐप्लिकेशन डाउनलोड करें.
अपने Unity प्रोजेक्ट में Firebase Unity SDK (खास तौर पर, FirebaseRemoteConfig.unitypackage) जोड़ें.

ध्यान दें कि Firebase को आपके यूनिटी प्रोजेक्ट में जोड़ने के लिए, Firebase कंसोल और आपके ओपन यूनिट प्रोजेक्ट, दोनों के टास्क शामिल होते हैं. उदाहरण के लिए, कंसोल से Firebase कॉन्फ़िगरेशन फ़ाइलों को डाउनलोड करके, Unity प्रोजेक्ट में ले जाया जाता है.

दूसरा चरण: ऐप्लिकेशन में डिफ़ॉल्ट पैरामीटर वैल्यू सेट करना

रिमोट कॉन्फ़िगरेशन ऑब्जेक्ट में इन-ऐप्लिकेशन डिफ़ॉल्ट पैरामीटर वैल्यू सेट की जा सकती हैं, ताकि रिमोट कॉन्फ़िगरेशन बैकएंड से कनेक्ट होने से पहले आपका ऐप्लिकेशन सही तरीके से काम करे. साथ ही, बैकएंड में कोई भी डिफ़ॉल्ट वैल्यू सेट न होने पर, डिफ़ॉल्ट वैल्यू उपलब्ध हों.

अहम जानकारी: गोपनीय डेटा को रिमोट कॉन्फ़िगरेशन के पैरामीटर की कुंजियों या वैल्यू में सेव न करें. रिमोट कॉन्फ़िगरेशन डेटा को ट्रांज़िशन के दौरान एन्क्रिप्ट (सुरक्षित) किया जाता है, लेकिन असली उपयोगकर्ता किसी भी डिफ़ॉल्ट या फ़ेच किए गए रिमोट कॉन्फ़िगरेशन पैरामीटर को ऐक्सेस कर सकते हैं, जो उनके क्लाइंट ऐप्लिकेशन इंस्टेंस के लिए उपलब्ध होता है.

ऐसा करने के लिए, एक स्ट्रिंग डिक्शनरी बनाएं और उसमें उन कुंजी/वैल्यू पेयर से जानकारी भरें जो आपको जोड़े जाने वाले डिफ़ॉल्ट हैं. अगर आपने रिमोट कॉन्फ़िगरेशन में बैकएंड पैरामीटर वैल्यू को पहले ही कॉन्फ़िगर किया हुआ है, तो ऐसी फ़ाइल डाउनलोड की जा सकती है जिसमें ये कुंजी/वैल्यू पेयर हों और इसका इस्तेमाल अपनी स्ट्रिंग डिक्शनरी बनाने के लिए करें. ज़्यादा जानकारी के लिए, रिमोट कॉन्फ़िगरेशन टेंप्लेट की डिफ़ॉल्ट सेटिंग डाउनलोड करें लेख पढ़ें.

(SetDefaultsAsync() कॉल करने पर, बिना स्ट्रिंग वाली प्रॉपर्टी को प्रॉपर्टी के टाइप में बदल दिया जाएगा).

System.Collections.Generic.Dictionary<string, object> defaults =
  new System.Collections.Generic.Dictionary<string, object>();

// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);

Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
  .ContinueWithOnMainThread(task => {

तीसरा चरण: अपने ऐप्लिकेशन में इस्तेमाल करने के लिए पैरामीटर वैल्यू पाना

अब आप रिमोट कॉन्फ़िगरेशन ऑब्जेक्ट से पैरामीटर वैल्यू पा सकते हैं. अगर रिमोट कॉन्फ़िगरेशन बैकएंड में वैल्यू सेट की जाती हैं, उन्हें फ़ेच किया जाता है, और फिर उन्हें चालू किया जाता है, तो वे वैल्यू आपके ऐप्लिकेशन के लिए उपलब्ध होंगी. ऐसा न करने पर, आपको SetDefaultsAsync() का इस्तेमाल करके कॉन्फ़िगर की गई इन-ऐप्लिकेशन पैरामीटर वैल्यू मिलेंगी.

ये वैल्यू पाने के लिए, पैरामीटर कुंजी को तर्क के तौर पर देकर, GetValue() का इस्तेमाल करें. यह एक ConfigValue दिखाता है, जिसमें ऐसी प्रॉपर्टी हैं जो वैल्यू को अलग-अलग बेस टाइप में बदल सकती हैं.

चौथा चरण: पैरामीटर वैल्यू सेट करना

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

पांचवां चरण: ज़रूरत के हिसाब से वैल्यू को फ़ेच और चालू करना

रिमोट कॉन्फ़िगरेशन बैकएंड से पैरामीटर वैल्यू फ़ेच करने के लिए, FetchAsync() तरीके को कॉल करें. बैकएंड पर सेट की गई सभी वैल्यू, रिमोट कॉन्फ़िगरेशन ऑब्जेक्ट में फ़ेच और कैश मेमोरी में सेव की जाती हैं.

// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan.  Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
  DebugLog("Fetching data...");
  System.Threading.Tasks.Task fetchTask =
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
      TimeSpan.Zero);
  return fetchTask.ContinueWithOnMainThread(FetchComplete);
}

ऊपर दिए गए कोड में, FetchComplete एक ऐसा तरीका है जिसका सिग्नेचर, ContinueWithOnMainThread() के किसी एक ओवरलोड के पैरामीटर से मेल खाता है.

नीचे दिए गए सैंपल कोड में, FetchComplete तरीके को पिछला टास्क (fetchTask) पास किया गया है. इससे FetchComplete यह पता लगा सकता है कि टास्क पूरा हुआ है या नहीं. कोड Info.LastFetchStatus का इस्तेमाल करके यह पता लगाता है कि प्रोसेस भी पूरी हुई या नहीं. अगर ऐसा है, तो रिमोट कॉन्फ़िगरेशन पैरामीटर वैल्यू को इसके बाद ActivateAsync() का इस्तेमाल करके चालू किया जाता है.

private void FetchComplete(Task fetchTask) {
  if (!fetchTask.IsCompleted) {
    Debug.LogError("Retrieval hasn't finished.");
    return;
  }

  var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
  var info = remoteConfig.Info;
  if(info.LastFetchStatus != LastFetchStatus.Success) {
    Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
    return;
  }

  // Fetch successful. Parameter values must be activated to use.
  remoteConfig.ActivateAsync()
    .ContinueWithOnMainThread(
      task => {
        Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
    });
}

FetchAsync() का इस्तेमाल करके फ़ेच की गई वैल्यू, फ़ेच पूरी हो जाने पर लोकल तौर पर कैश मेमोरी में सेव की जाती हैं. हालांकि, ActivateAsync() को शुरू किए जाने तक ये वैल्यू उपलब्ध नहीं होती हैं. इससे यह पक्का किया जा सकता है कि नई वैल्यू, कैलकुलेशन के बीच में या किसी अन्य समय पर लागू न हों, जिसकी वजह से समस्या या व्यवहार अजीब हो सकता है.

छठा चरण: रीयल टाइम में अपडेट सुनना

पैरामीटर वैल्यू फ़ेच करने के बाद, आपके पास रीयल-टाइम रिमोट कॉन्फ़िगरेशन इस्तेमाल करके, रिमोट कॉन्फ़िगरेशन बैकएंड के अपडेट सुनने का विकल्प होता है. अपडेट उपलब्ध होने पर, कनेक्ट किए गए डिवाइसों के लिए रीयल-टाइम कॉन्फ़िगरेशन सिग्नल. यह अपडेट उपलब्ध होने पर, नया रिमोट कॉन्फ़िगरेशन वर्शन पब्लिश होने के बाद बदलाव अपने-आप फ़ेच हो जाते हैं.

रीयल-टाइम अपडेट, Android और Apple प्लैटफ़ॉर्म के लिए Firebase Unity SDK के v11.0.0 और इसके बाद के वर्शन पर काम करते हैं.

अहम जानकारी: रीयल-टाइम रिमोट कॉन्फ़िगरेशन के लिए भी Firebase रिमोट कॉन्फ़िगरेशन का रीयल-टाइम एपीआई होना ज़रूरी है. यह एपीआई आपके लिए पहले से चालू होना चाहिए. पुष्टि करने के लिए, Google Cloud Console खोलें. अपना प्रोजेक्ट चुनें और एपीआई और सेवाएं पेज खोलें. एपीआई चालू होना चाहिए. अगर यह मौजूद नहीं है या चालू नहीं है, तो एपीआई और सेवाएं चालू करें पर क्लिक करें, Firebase रिमोट कॉन्फ़िगरेशन रीयल टाइम एपीआई खोजें और इसे चालू करें.

अपडेट सुनने के लिए, अपने ऐप्लिकेशन में OnConfigUpdateListener जोड़ें और किसी भी नए या अपडेट किए गए पैरामीटर की वैल्यू को अपने-आप फ़ेच करें. इसके बाद, अपडेट किए गए इवेंट को प्रोसेस करने के लिए, ConfigUpdateListenerEventHandler बनाएं. नीचे दिया गया उदाहरण, अपडेट पर ध्यान देता है. साथ ही, अपडेट किए गए वेलकम मैसेज दिखाने के लिए, फ़ेच की गई नई वैल्यू का इस्तेमाल करता है.

// Invoke the listener.
void Start()
{
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
    += ConfigUpdateListenerEventHandler;
}

// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
   object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
  if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
    Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
    return;
  }

  Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
  // Activate all fetched values and then display a welcome message.
  remoteConfig.ActivateAsync().ContinueWithOnMainThread(
    task => {
        DisplayWelcomeMessage();
    });
}

// Stop the listener.
void OnDestroy() {
    Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
      -= ConfigUpdateListenerEventHandler;
}

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

अगले चरण

अगर आपने अभी तक रिमोट कॉन्फ़िगरेशन के इस्तेमाल के उदाहरण नहीं देखे हैं, तो इन्हें देखें और कुछ खास कॉन्सेप्ट और बेहतर रणनीतियों के दस्तावेज़ देखें. इनमें ये शामिल हैं: