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


Firebase Remote Config का इस्तेमाल करके, अपने ऐप्लिकेशन में पैरामीटर तय किए जा सकते हैं और क्लाउड में उनकी वैल्यू अपडेट की जा सकती हैं. इससे, ऐप्लिकेशन का अपडेट डिस्ट्रिब्यूट किए बिना, उसके लुक और काम करने के तरीके में बदलाव किया जा सकता है.

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

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

पहला चरण: अपने ऐप्लिकेशन में Remote Config जोड़ना

Remote Config का इस्तेमाल करने से पहले, आपको ये काम करने होंगे:

  • अपना Unity प्रोजेक्ट रजिस्टर करें और उसे Firebase का इस्तेमाल करने के लिए कॉन्फ़िगर करें.

    • अगर आपका Unity प्रोजेक्ट पहले से ही Firebase का इस्तेमाल करता है, तो इसका मतलब है कि वह पहले से ही Firebase के लिए रजिस्टर और कॉन्फ़िगर किया गया है.

    • अगर आपके पास कोई Unity प्रोजेक्ट नहीं है, तो सैंपल ऐप्लिकेशन डाउनलोड किया जा सकता है.

  • अपने Unity प्रोजेक्ट में Firebase Unity SDK टूल (खास तौर पर, FirebaseRemoteConfig.unitypackage) जोड़ें.

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

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

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

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

(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 => {

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

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

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

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

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

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

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

// 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() का इस्तेमाल करके Remote Config पैरामीटर की वैल्यू चालू की जाती हैं.

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() को ट्रिगर नहीं किया जाता. इससे यह पक्का किया जा सकता है कि नई वैल्यू, कैलकुलेशन के बीच में या किसी ऐसे समय पर लागू न की जाएं जिससे समस्याएं या गड़बड़ियां हो सकती हैं.

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

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

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

  1. अपने ऐप्लिकेशन में 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;
}

अगली बार जब आप Remote Config का नया वर्शन पब्लिश करेंगे, तो आपके ऐप्लिकेशन को चला रहे और बदलावों को सुनने वाले डिवाइस, पूरा होने के बाद होने वाली कार्रवाई करने वाले फ़ंक्शन को कॉल करेंगे.

अगले चरण

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