रिमोट कॉन्फ़िगरेशन टेंप्लेट और वर्शन

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

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

यहां क्लाइंट टेंप्लेट फ़ाइल का उदाहरण दिया गया है:

      {
        "conditions": [
          {
            "name": "ios",
            "expression": "device.os == 'ios'"
          }
        ],
        "parameters": {
          "welcome_message": {
            "defaultValue": {
              "value": "Welcome to this sample app"
            },
            "conditionalValues": {
              "ios": {
                "value": "Welcome to this sample iOS app"
              }
            }
          },
          "welcome_message_caps": {
            "defaultValue": {
              "value": "false"
            }
          },
          "header_text": {
            "defaultValue": {
              "useInAppDefault": true
            }
          }
        },
        "version": {
          "versionNumber": "28",
          "updateTime": "2020-05-14T18:39:38.994Z",
          "updateUser": {
            "email": "user@google.com"
          },
          "updateOrigin": "CONSOLE",
          "updateType": "INCREMENTAL_UPDATE"
        }
      }

यहां सर्वर टेंप्लेट फ़ाइल का उदाहरण दिया गया है:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

Firebase कंसोल की मदद से, वर्शन मैनेजमेंट के ये काम किए जा सकते हैं:

  • सेव किए गए टेंप्लेट के सभी वर्शन की सूची बनाएं
  • किसी खास वर्शन को वापस पाना
  • किसी खास क्लाइंट वर्शन पर रोल बैक करें
  • बदलाव का इतिहास पेज से, रिमोट कॉन्फ़िगरेशन टेंप्लेट मिटाएं

अगर आप क्लाइंट टेंप्लेट को मैनेज कर रहे हैं, तो Firebase सीएलआई और रिमोट कॉन्फ़िगरेशन बैकएंड एपीआई का इस्तेमाल करके, टेंप्लेट की सूची बनाएं, टेंप्लेट फिर से पाएं, और टेंप्लेट को रोल बैक करें.

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

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

Firebase कंसोल, Firebase सीएलआई या रिमोट कॉन्फ़िगरेशन बैकएंड एपीआई की मदद से, वर्शन मैनेजमेंट के ये काम किए जा सकते हैं:

  • सेव किए गए टेंप्लेट के सभी वर्शन की सूची बनाएं
  • किसी खास वर्शन को वापस पाना
  • किसी खास वर्शन पर रोल बैक करें

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

रिमोट कॉन्फ़िगरेशन टेंप्लेट के वर्शन मैनेज करें

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

रिमोट कॉन्फ़िगरेशन टेंप्लेट के सेव किए गए सभी वर्शन की सूची बनाएं

रिमोट कॉन्फ़िगरेशन टेंप्लेट के सेव किए गए सभी वर्शन की सूची को फिर से हासिल किया जा सकता है. उदाहरण के लिए:

Node.js के लिए

function listAllVersions() {
  admin.remoteConfig().listVersions()
    .then((listVersionsResult) => {
      console.log("Successfully fetched the list of versions");
      listVersionsResult.versions.forEach((version) => {
        console.log('version', JSON.stringify(version));
      });
    })
    .catch((error) => {
      console.log(error);
    });
}

Java

ListVersionsPage page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
while (page != null) {
  for (Version version : page.getValues()) {
    System.out.println("Version: " + version.getVersionNumber());
  }
  page = page.getNextPage();
}

// Iterate through all versions. This will still retrieve versions in batches.
page = FirebaseRemoteConfig.getInstance().listVersionsAsync().get();
for (Version version : page.iterateAll()) {
  System.out.println("Version: " + version.getVersionNumber());
}

REST

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:listVersions

Firebase कंसोल

पैरामीटर टैब में, सबसे ऊपर दाईं ओर दिख रहे "घड़ी" आइकॉन को चुनें. इससे बदलाव का इतिहास पेज खुलेगा. इसमें दाईं ओर मौजूद सूची मेन्यू में, सेव किए गए टेंप्लेट के सभी वर्शन की सूची दिखेगी.

सेव किए गए हर वर्शन के लिए दिखाई जाने वाली जानकारी में यह जानकारी शामिल होती है कि बदलाव कंसोल से, REST API की मदद से, रोलबैक से किए गए थे या नहीं या फिर टेंप्लेट के फ़ोर्स किए गए सेव से ये बदलाव बढ़े हैं.

Firebase CLI

firebase remoteconfig:versions:list

दिखाए जाने वाले वर्शन की संख्या को सीमित करने के लिए, --limit विकल्प का इस्तेमाल करें. सभी वर्शन पाने के लिए, '0' को पास करें.

टेंप्लेट की सूची में सभी स्टोर किए गए वर्शन का मेटाडेटा शामिल होता है. इसमें अपडेट का समय और उसे करने वाले उपयोगकर्ता की जानकारी शामिल होती है. साथ ही, इसमें यह जानकारी भी शामिल होती है कि इसे कंसोल या REST API से बनाया गया था या नहीं. यहां वर्शन एलिमेंट का एक उदाहरण दिया गया है:

{
  "versions": [{
    "version_number": "6",
    "update_time": "2022-05-12T02:38:54Z",
    "update_user": {
      "name": "Jane Smith",
      "email": "jane@developer.org",
      "imageUrl": "https://lh3.googleusercontent.com/a-/..."
    },
    "description": "One small change on the console",
    "origin": "CONSOLE",
    "update_type": "INCREMENTAL_UPDATE"
  }]

रिमोट कॉन्फ़िगरेशन टेंप्लेट का कोई खास वर्शन वापस पाएं

रिमोट कॉन्फ़िगरेशन टेंप्लेट के किसी खास स्टोर किए गए वर्शन को वापस लाया जा सकता है. उदाहरण के लिए:

Node.js के लिए

टेंप्लेट का सबसे नया वर्शन पाने के लिए, बिना किसी आर्ग्युमेंट के getTemplate() को पास करें या किसी खास वर्शन को वापस पाने के लिए, getTemplateAtVersion() का इस्तेमाल करें.

// Get template version: 6
admin.remoteConfig().getTemplateAtVersion('6')
  .then((template) => {
    console.log("Successfully fetched the template with ETag: " + template.etag);
  })
  .catch((error) => {
    console.log(error);
  });

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAtVersionAsync(versionNumber).get();
// See the ETag of the fetched template.
System.out.println("Successfully fetched the template with ETag: " + template.getETag());

REST

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig?version_number=6

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

Firebase कंसोल

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

चुने गए किसी वर्शन के संदर्भ मेन्यू पर कर्सर घुमाकर और चुने गए वर्शन से तुलना करें को चुनकर, मौजूदा वर्शन और सेव किए गए किसी भी वर्शन के अंतर को देखा जा सकता है.

Firebase CLI

firebase remoteconfig:get -v VERSION_NUMBER

इसके अलावा, -o, FILENAME का इस्तेमाल करके, किसी बताई गई फ़ाइल में आउटपुट लिखा जा सकता है.

रिमोट कॉन्फ़िगरेशन टेंप्लेट के सेव किए गए किसी खास वर्शन पर रोल बैक करें

आपके पास टेंप्लेट के सेव किए गए किसी भी वर्शन पर रोल बैक करने का विकल्प है. उदाहरण के लिए:

Node.js के लिए

// Roll back to template version: 6
admin.remoteConfig().rollback('6')
  .then((template) => {
    console.log("Successfully rolled back to template version 6.");
    console.log("New ETag: " + template.etag);
  })
  .catch((error) => {
    console.log('Error trying to rollback:', e);
  })

Java

try {
  Template template = FirebaseRemoteConfig.getInstance().rollbackAsync(versionNumber).get();
  System.out.println("Successfully rolled back to template version: " + versionNumber);
  System.out.println("New ETag: " + template.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Error trying to rollback template.");
    System.out.println(rcError.getMessage());
  }
}

REST

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

curl --compressed -D headers -H "Authorization: Bearer <var>token</var>" -H "Content-Type: application/json" -X POST https://firebaseremoteconfig.googleapis.com/v1/projects/<var>my-project-id</var>/remoteConfig:rollback -d '{"version_number": 6}'

इस रिस्पॉन्स में, स्टोर किए गए नए वर्शन के मेटाडेटा के साथ-साथ, स्टोर किए गए नए टेंप्लेट का कॉन्टेंट शामिल होता है.

Firebase कंसोल

टेंप्लेट के जिन पिछले वर्शन को रोल बैक किया जा सकता है उनके लिए, उस वर्शन पर रोल बैक करने का विकल्प बटन, बदलाव का इतिहास पेज पर सबसे ऊपर दाईं ओर दिखता है. इस विकल्प पर सिर्फ़ तब क्लिक करके पुष्टि करें, जब आपको पक्का पता हो कि आपको उस वर्शन पर रोल बैक करना है और सभी ऐप्लिकेशन और उपयोगकर्ताओं के लिए उन वैल्यू का तुरंत इस्तेमाल करना है.

Firebase CLI

firebase remoteconfig:rollback -v VERSION_NUMBER

ध्यान दें कि यह रोलबैक कार्रवाई असरदार तरीके से एक नया नंबर वाला वर्शन बनाती है. उदाहरण के लिए, वर्शन 10 से वर्शन 6 में रोल बैक करने पर, वर्शन 6 की एक नई कॉपी बनती है. यह कॉपी सिर्फ़ ओरिजनल से अलग होती है, क्योंकि वर्शन नंबर 11 होता है. ओरिजनल वर्शन 6 अब भी सेव रहता है, यह मानते हुए कि उसकी समयसीमा खत्म नहीं हुई है. वर्शन 11 चालू टेंप्लेट बन जाता है.

रिमोट कॉन्फ़िगरेशन वाला टेंप्लेट मिटाना

Firebase कंसोल से, रिमोट कॉन्फ़िगरेशन टेंप्लेट मिटाए जा सकते हैं. रिमोट कॉन्फ़िगरेशन टेंप्लेट मिटाने के लिए:

  1. रिमोट कॉन्फ़िगरेशन पैरामीटर पेज से, बदलाव का इतिहास पर क्लिक करें.

  2. जिस टेंप्लेट को मिटाना है उसके बगल में टॉगल करके ज़्यादा पर क्लिक करें. इसके बाद, मिटाएं को चुनें.

  3. जब मिटाए जाने की पुष्टि करने के लिए कहा जाए, तो मिटाएं पर क्लिक करें.

रिमोट कॉन्फ़िगरेशन टेंप्लेट डाउनलोड और पब्लिश करना

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

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

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

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

A/B टेस्टिंग एक्सपेरिमेंट में, वैरिएंट के तौर पर बनाए गए पैरामीटर और पैरामीटर की वैल्यू, एक्सपोर्ट किए गए टेंप्लेट में शामिल नहीं की जाती हैं.

रिमोट कॉन्फ़िगरेशन टेंप्लेट एक्सपोर्ट और इंपोर्ट करने के लिए:

  1. मौजूदा रिमोट कॉन्फ़िगरेशन कॉन्फ़िगरेशन टेंप्लेट डाउनलोड करें.
  2. रिमोट कॉन्फ़िगरेशन टेंप्लेट की पुष्टि करें.
  3. रिमोट कॉन्फ़िगरेशन टेंप्लेट पब्लिश करें.

मौजूदा रिमोट कॉन्फ़िगरेशन टेंप्लेट डाउनलोड करें

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

चालू रिमोट कॉन्फ़िगरेशन टेंप्लेट को JSON फ़ॉर्मैट में डाउनलोड करने के लिए, इन निर्देशों का इस्तेमाल करें:

Node.js के लिए

function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}

Java

Template template = FirebaseRemoteConfig.getInstance().getTemplateAsync().get();
// See the ETag of the fetched template.
System.out.println("ETag from server: " + template.getETag());

REST

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filename

यह निर्देश, JSON पेलोड को एक फ़ाइल में और हेडर (इसमें ETag शामिल है) को एक अलग headers फ़ाइल में भेजता है.

Firebase कंसोल

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

Firebase CLI

firebase remoteconfig:get -o filename

रिमोट कॉन्फ़िगरेशन टेंप्लेट की पुष्टि करें

Firebase के एडमिन SDK या REST API का इस्तेमाल करके, टेंप्लेट के अपडेट पब्लिश करने से पहले उनकी पुष्टि की जा सकती है. Firebase सीएलआई या Firebase कंसोल से पब्लिश करने की कोशिश करने पर भी, टेंप्लेट की पुष्टि की जाती है.

टेंप्लेट की पुष्टि करने की प्रक्रिया में, पैरामीटर और शर्तों के लिए डुप्लीकेट कुंजियों, शर्तों के अमान्य नाम या मौजूद न होने वाली स्थितियों या गलत फ़ॉर्मैट किए गए ETag जैसी गड़बड़ियों की जांच की जाती है. उदाहरण के लिए, कुंजी की अनुमति वाली संख्या—2000 से ज़्यादा वाला अनुरोध, गड़बड़ी का मैसेज, Param count too large दिखाएगा.

Node.js के लिए

function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}

Java

try {
  Template validatedTemplate = FirebaseRemoteConfig.getInstance()
          .validateTemplateAsync(template).get();
  System.out.println("Template was valid and safe to use");
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Template is invalid and cannot be published");
    System.out.println(rcError.getMessage());
  }
}

REST

पब्लिश करने के अनुरोध में यूआरएल पैरामीटर ?validate_only=true जोड़कर, टेंप्लेट के अपडेट की पुष्टि करें:

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig?validate_only=true -d @filename

अगर आपके टेंप्लेट की पुष्टि हो जाती है, तो curl कमांड आपके सबमिट किए गए JSON टेंप्लेट को दिखाता है. साथ ही, सेव की गई headers फ़ाइल में, आपको एचटीटीपी/2 स्टेटस 200 और -0 सफ़िक्स वाला अपडेट किया गया ईटैग मिलेगा. अगर आपके टेंप्लेट की पुष्टि नहीं की गई है, तो आपको JSON के रिस्पॉन्स में पुष्टि करने से जुड़ी गड़बड़ी मिलेगी. साथ ही, आपकी headers फ़ाइल में 200 रिस्पॉन्स नहीं होगा (और कोई ETag नहीं होगा).

रिमोट कॉन्फ़िगरेशन टेंप्लेट पब्लिश करना

टेंप्लेट को डाउनलोड करने, JSON कॉन्टेंट में ज़रूरी बदलाव करने, और उसकी पुष्टि करने के बाद, उसे प्रोजेक्ट में पब्लिश किया जा सकता है.

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

पब्लिश होने के बाद, पैरामीटर और वैल्यू में किए गए बदलाव आपके ऐप्लिकेशन और उपयोगकर्ताओं के लिए तुरंत उपलब्ध हो जाते हैं. अगर ज़रूरी हो, तो पिछले वर्शन पर रोल बैक किया जा सकता है.

अपना टेंप्लेट पब्लिश करने के लिए, इन निर्देशों का पालन करें:

Node.js के लिए

function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}

Java

try {
  Template publishedTemplate = FirebaseRemoteConfig.getInstance()
          .publishTemplateAsync(template).get();
  System.out.println("Template has been published");
  // See the ETag of the published template.
  System.out.println("ETag from server: " + publishedTemplate.getETag());
} catch (ExecutionException e) {
  if (e.getCause() instanceof FirebaseRemoteConfigException) {
    FirebaseRemoteConfigException rcError = (FirebaseRemoteConfigException) e.getCause();
    System.out.println("Unable to publish template.");
    System.out.println(rcError.getMessage());
  }
}

REST

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag" -H "Authorization: Bearer token" -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -d @filename

इस curl निर्देश के लिए, "@" वर्ण और उसके बाद फ़ाइल का नाम इस्तेमाल करके, कॉन्टेंट के बारे में जानकारी दी जा सकती है.

Firebase कंसोल

  1. रिमोट कॉन्फ़िगरेशन पैरामीटर या शर्तें टैब से, मेन्यू खोलें और किसी फ़ाइल से पब्लिश करें को चुनें.
  2. जब कहा जाए, तब ब्राउज़ करें पर क्लिक करें. इसके बाद, उस रिमोट कॉन्फ़िगरेशन फ़ाइल पर जाएं और उसे चुनें जिसे आपको पब्लिश करना है. इसके बाद, चुनें पर क्लिक करें.
  3. फ़ाइल की पुष्टि की जाएगी. इसके बाद, पब्लिश करें पर क्लिक करके, कॉन्फ़िगरेशन को अपने ऐप्लिकेशन और उपयोगकर्ताओं को तुरंत उपलब्ध कराया जा सकता है.

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

  • प्रोजेक्ट से प्रोजेक्ट में मनमुताबिक बनाने के विकल्प इंपोर्ट नहीं किए जा सकते.

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

  • शर्तों को एक प्रोजेक्ट से दूसरे प्रोजेक्ट में इंपोर्ट किया जा सकता है. हालांकि, ध्यान रखें कि पब्लिश करने से पहले, टारगेट प्रोजेक्ट में कोई खास कंडीशनल वैल्यू (जैसे कि ऐप्लिकेशन आईडी या ऑडियंस) मौजूद होनी चाहिए.

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

  • अगर आपको जिस टेंप्लेट को पब्लिश करना है उसमें Google Analytics पर निर्भर करने वाली शर्तें हैं, तो टारगेट प्रोजेक्ट में Analytics चालू होना चाहिए.

रिमोट कॉन्फ़िगरेशन टेंप्लेट की डिफ़ॉल्ट सेटिंग डाउनलोड करें

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

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

इन फ़ाइलों को Android ऐप्लिकेशन के लिए एक्सएमएल फ़ॉर्मैट, iOS ऐप्लिकेशन के लिए प्रॉपर्टी लिस्ट (plist) फ़ॉर्मैट, और वेब ऐप्लिकेशन के लिए JSON फ़ॉर्मैट में डाउनलोड किया जा सकता है.

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

डिफ़ॉल्ट टेंप्लेट वाली फ़ाइल डाउनलोड करने के लिए:

REST

curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=file_format'

आपको जिस फ़ाइल फ़ॉर्मैट को डाउनलोड करना है, उसके हिसाब से format वैल्यू के तौर पर XML, PLIST या JSON का इस्तेमाल करें.

Firebase कंसोल

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

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