Admin SDK, REST API, और Firebase CLI का इस्तेमाल करके कॉन्फ़िगरेशन टेंप्लेट. page_type: guide
इस दस्तावेज़ में बताया गया है कि JSON फ़ॉर्मैट वाले पैरामीटर और शर्तों के सेट को प्रोग्राम के हिसाब से कैसे पढ़ा और बदला जा सकता है. इस सेट को Remote Config टेंप्लेट कहा जाता है. इससे आपको बैकएंड पर टेंप्लेट में बदलाव करने की सुविधा मिलती है. क्लाइंट ऐप्लिकेशन, क्लाइंट लाइब्रेरी का इस्तेमाल करके इन बदलावों को फ़ेच कर सकता है.
इस गाइड में बताए गए Remote Config REST API, Admin SDKs या Firebase सीएलआई का इस्तेमाल करके, Firebase कंसोल में टेंप्लेट को मैनेज करने की प्रोसेस को बायपास किया जा सकता है. इससे, Remote Config में किए गए बदलावों को सीधे अपनी प्रोसेस में इंटिग्रेट किया जा सकता है. उदाहरण के लिए, Remote Config बैकएंड एपीआई की मदद से ये काम किए जा सकते हैं:
- Remote Config अपडेट शेड्यूल करें. क्रॉन जॉब के साथ एपीआई कॉल का इस्तेमाल करके, तय शेड्यूल के हिसाब से Remote Config वैल्यू बदली जा सकती हैं.
- अपने मालिकाना हक वाले सिस्टम से Firebase Remote Config पर आसानी से ट्रांज़िशन करने के लिए, कॉन्फ़िगरेशन वैल्यू को बैच में इंपोर्ट करें.
- Cloud Functions for Firebase के साथ Remote Config का इस्तेमाल करें. इससे सर्वर-साइड पर होने वाले इवेंट के आधार पर, आपके ऐप्लिकेशन में वैल्यू बदल जाती हैं. उदाहरण के लिए, अपने ऐप्लिकेशन में किसी नई सुविधा का प्रमोशन करने के लिए, Remote Config का इस्तेमाल किया जा सकता है. इसके बाद, जब आपको लगे कि काफ़ी लोगों ने नई सुविधा का इस्तेमाल कर लिया है, तो प्रमोशन को अपने-आप बंद किया जा सकता है.

इस गाइड के इन सेक्शन में, Remote Config बैकएंड एपीआई का इस्तेमाल करके किए जा सकने वाले कामों के बारे में बताया गया है.
Firebase Admin SDK का इस्तेमाल करके, Remote Config में बदलाव करें
Admin SDK, सर्वर लाइब्रेरी का एक सेट है. इसकी मदद से, खास सुविधाओं वाले एनवायरमेंट से Firebase के साथ इंटरैक्ट किया जा सकता है. Remote Config को अपडेट करने के अलावा, Admin SDK की मदद से Firebase के पुष्टि करने वाले टोकन जनरेट किए जा सकते हैं और उनकी पुष्टि की जा सकती है. साथ ही, Realtime Database से डेटा पढ़ा और उसमें डेटा सेव किया जा सकता है. Admin SDK की ज़रूरी शर्तों और सेटअप के बारे में ज़्यादा जानने के लिए, अपने सर्वर में Firebase Admin SDK जोड़ें लेख पढ़ें.
Admin SDK का इस्तेमाल करके, इन टास्क को पूरा करने वाले सैंपल कोड की समीक्षा करने के लिए, इनमें से कोई एक क्विकस्टार्ट ऐप्लिकेशन देखें:
- Firebase Remote Config Java क्विकस्टार्ट
- Firebase Remote Config Node.js क्विकस्टार्ट
- Firebase Remote Config Python क्विकस्टार्ट
Remote Config के सामान्य फ़्लो में, आपको मौजूदा टेंप्लेट मिल सकता है. साथ ही, कुछ पैरामीटर या पैरामीटर ग्रुप और शर्तों में बदलाव किया जा सकता है. इसके बाद, टेंप्लेट की पुष्टि करके उसे पब्लिश किया जा सकता है. एपीआई कॉल करने से पहले, आपको एसडीके से किए गए अनुरोधों को अनुमति देनी होगी.
एसडीके टूल को शुरू करना और एपीआई अनुरोधों को अनुमति देना
जब Admin SDK को बिना किसी पैरामीटर के शुरू किया जाता है, तो SDK टूल Google ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल का इस्तेमाल करता है. साथ ही, FIREBASE_CONFIG एनवायरमेंट वैरिएबल से विकल्प पढ़ता है.
अगर FIREBASE_CONFIG वैरिएबल का कॉन्टेंट { से शुरू होता है, तो उसे JSON ऑब्जेक्ट के तौर पर पार्स किया जाएगा. ऐसा न होने पर, SDK टूल यह मान लेता है कि स्ट्रिंग, विकल्पों वाली JSON फ़ाइल का नाम है.
उदाहरण के लिए:
Node.js
const admin = require('firebase-admin'); admin.initializeApp();
Java
FileInputStream serviceAccount = new FileInputStream("service-account.json"); FirebaseOptions options = FirebaseOptions.builder() .setCredentials(GoogleCredentials.fromStream(serviceAccount)) .build(); FirebaseApp.initializeApp(options);
मौजूदा Remote Config टेंप्लेट पाना
Remote Config टेंप्लेट के साथ काम करते समय, ध्यान रखें कि उनके वर्शन होते हैं. साथ ही, हर वर्शन की समयसीमा सीमित होती है. यह समयसीमा, टेंप्लेट बनाने से लेकर उसे अपडेट करने तक होती है: 90 दिन. साथ ही, ज़्यादा से ज़्यादा 300 वर्शन सेव किए जा सकते हैं. ज़्यादा जानकारी के लिए, टेंप्लेट और वर्शनिंग देखें.
बैकएंड एपीआई का इस्तेमाल करके, Remote Config टेंप्लेट के मौजूदा वर्शन को 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());
Remote Config पैरामीटर में बदलाव करें
प्रोग्राम के हिसाब से, Remote Config पैरामीटर और पैरामीटर ग्रुप में बदलाव किया जा सकता है और उन्हें जोड़ा जा सकता है. उदाहरण के लिए, "new_menu" नाम के किसी मौजूदा पैरामीटर ग्रुप में, सीज़न के हिसाब से जानकारी दिखाने के लिए एक पैरामीटर जोड़ा जा सकता है:
Node.js
function addParameterToGroup(template) { template.parameterGroups['new_menu'].parameters['spring_season'] = { defaultValue: { useInAppDefault: true }, description: 'spring season menu visibility.', }; }
Java
template.getParameterGroups().get("new_menu").getParameters() .put("spring_season", new Parameter() .setDefaultValue(ParameterValue.inAppDefault()) .setDescription("spring season menu visibility.") );
एपीआई की मदद से, नए पैरामीटर और पैरामीटर ग्रुप बनाए जा सकते हैं. इसके अलावा, डिफ़ॉल्ट वैल्यू, शर्त के हिसाब से तय होने वाली वैल्यू, और ब्यौरों में बदलाव किया जा सकता है. सभी मामलों में, बदलाव करने के बाद आपको टेंप्लेट को साफ़ तौर पर पब्लिश करना होगा.
Remote Config शर्तों में बदलाव करें
आपके पास प्रोग्राम के हिसाब से, Remote Config शर्तों और कंडीशनल वैल्यू में बदलाव करने और उन्हें जोड़ने का विकल्प होता है. उदाहरण के लिए, कोई नई शर्त जोड़ने के लिए:
Node.js
function addNewCondition(template) { template.conditions.push({ name: 'android_en', expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']', tagColor: 'BLUE', }); }
Java
template.getConditions().add(new Condition("android_en", "device.os == 'android' && device.country in ['us', 'uk']", TagColor.BLUE));
सभी मामलों में, बदलाव करने के बाद आपको टेंप्लेट को साफ़ तौर पर पब्लिश करना होगा.
Remote Config बैकएंड एपीआई, कई शर्तें और तुलना करने वाले ऑपरेटर उपलब्ध कराते हैं. इनका इस्तेमाल करके, अपने ऐप्लिकेशन के काम करने के तरीके और उसके दिखने के तरीके में बदलाव किया जा सकता है. शर्तों और इन शर्तों के लिए इस्तेमाल किए जा सकने वाले ऑपरेटर के बारे में ज़्यादा जानने के लिए, कंडिशनल एक्सप्रेशन रेफ़रंस देखें.
Remote Config टेंप्लेट की पुष्टि करना
आपके पास अपने अपडेट पब्लिश करने से पहले, उनकी पुष्टि करने का विकल्प भी होता है. इसके लिए, यहां दिया गया तरीका अपनाएं:
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()); } }
पुष्टि करने की इस प्रोसेस में, पैरामीटर और शर्तों के लिए डुप्लीकेट कुंजियां, अमान्य या मौजूद न होने वाली शर्तें या गलत तरीके से फ़ॉर्मैट किए गए ई-टैग जैसी गड़बड़ियों की जांच की जाती है. उदाहरण के लिए, अगर किसी अनुरोध में तय सीमा से ज़्यादा कुंजियां शामिल हैं, तो गड़बड़ी का मैसेज दिखेगा. जैसे, 2,000 से ज़्यादा कुंजियां शामिल करने पर, Param count too large मैसेज दिखेगा.
Remote Config टेंप्लेट पब्लिश करना
टेंप्लेट को वापस पाने और उसमें अपडेट करने के बाद, उसे पब्लिश किया जा सकता है. इस सेक्शन में बताए गए तरीके से टेंप्लेट पब्लिश करने पर, मौजूदा कॉन्फ़िगरेशन टेंप्लेट की जगह अपडेट की गई फ़ाइल ले लेती है. साथ ही, नए चालू टेंप्लेट को उस टेंप्लेट से एक नंबर ज़्यादा वाला वर्शन नंबर असाइन किया जाता है जिसकी जगह उसने ली है.
अगर ज़रूरी हो, तो REST API का इस्तेमाल करके, पिछले वर्शन पर वापस जाएं. अपडेट में गड़बड़ियों के जोखिम को कम करने के लिए, पब्लिश करने से पहले पुष्टि की जा सकती है.
Remote Config डाउनलोड किए गए टेंप्लेट में, पसंद के मुताबिक बनाए गए वर्शन और शर्तें शामिल होती हैं. इसलिए, किसी दूसरे प्रोजेक्ट में पब्लिश करते समय, इन सीमाओं के बारे में जानना ज़रूरी है:
पसंद के मुताबिक बनाए गए अनुभव को एक प्रोजेक्ट से दूसरे प्रोजेक्ट में इंपोर्ट नहीं किया जा सकता.
उदाहरण के लिए, अगर आपने अपने प्रोजेक्ट में, उपयोगकर्ता के हिसाब से कॉन्टेंट बनाने की सुविधा चालू की है और किसी टेंप्लेट को डाउनलोड करके उसमें बदलाव किया है, तो उसे उसी प्रोजेक्ट में पब्लिश किया जा सकता है. हालांकि, उसे किसी दूसरे प्रोजेक्ट में तब तक पब्लिश नहीं किया जा सकता, जब तक कि टेंप्लेट से, उपयोगकर्ता के हिसाब से बनाए गए कॉन्टेंट को मिटा न दिया जाए.
शर्तों को एक प्रोजेक्ट से दूसरे प्रोजेक्ट में इंपोर्ट किया जा सकता है. हालांकि, ध्यान रखें कि शर्त के हिसाब से तय की गई कोई भी वैल्यू (जैसे, ऐप्लिकेशन आईडी या ऑडियंस), पब्लिश करने से पहले टारगेट प्रोजेक्ट में मौजूद होनी चाहिए.
उदाहरण के लिए, अगर आपके पास कोई ऐसा Remote Config पैरामीटर है जो किसी शर्त का इस्तेमाल करता है और उस शर्त में प्लैटफ़ॉर्म की वैल्यू
iOSहै, तो टेंप्लेट को किसी दूसरे प्रोजेक्ट में पब्लिश किया जा सकता है. ऐसा इसलिए, क्योंकि प्लैटफ़ॉर्म की वैल्यू हर प्रोजेक्ट के लिए एक जैसी होती हैं. हालांकि, अगर इसमें ऐसी शर्त शामिल है जो किसी खास ऐप्लिकेशन आईडी या उपयोगकर्ता ऑडियंस पर निर्भर करती है और वह टारगेट प्रोजेक्ट में मौजूद नहीं है, तो पुष्टि नहीं हो पाएगी.अगर आपको जो टेंप्लेट पब्लिश करना है उसमें ऐसी शर्तें शामिल हैं जो Google Analytics पर निर्भर करती हैं, तो टारगेट प्रोजेक्ट में Analytics को चालू करना ज़रूरी है.
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 API का इस्तेमाल करके, Remote Config में बदलाव करना
इस सेक्शन में, https://firebaseremoteconfig.googleapis.com पर मौजूद Remote Config REST API की मुख्य सुविधाओं के बारे में बताया गया है. ज़्यादा जानकारी के लिए, एपीआई का संदर्भ देखें.
एपीआई अनुरोधों की पुष्टि करने और उन्हें अनुमति देने के लिए, ऐक्सेस टोकन पाना
Firebase प्रोजेक्ट, Google सेवा खातों के साथ काम करते हैं. इनका इस्तेमाल करके, अपने ऐप्लिकेशन सर्वर या भरोसेमंद एनवायरमेंट से Firebase सर्वर एपीआई को कॉल किया जा सकता है. अगर कोड को स्थानीय तौर पर डेवलप किया जा रहा है या ऐप्लिकेशन को कंपनी की इमारत में डिप्लॉय किया जा रहा है, तो सर्वर के अनुरोधों को अनुमति देने के लिए, इस सेवा खाते से मिले क्रेडेंशियल का इस्तेमाल किया जा सकता है.
अपने Firebase प्रोजेक्ट के सभी सेवा खाते देखने के लिए,
किसी सेवा खाते की पुष्टि करने और उसे Firebase की सेवाओं को ऐक्सेस करने की अनुमति देने के लिए, आपको JSON फ़ॉर्मैट में एक निजी कुंजी फ़ाइल जनरेट करनी होगी.
अपने सेवा खाते के लिए निजी पासकोड वाली फ़ाइल जनरेट करने के लिए:
Firebase कंसोल में,
सेटिंग > सेवा खाते टैब पर जाएं.नया निजी पासकोड जनरेट करें पर क्लिक करें. इसके बाद, पासकोड जनरेट करें पर क्लिक करके पुष्टि करें.
कुंजी वाली JSON फ़ाइल को सुरक्षित तरीके से सेव करें.
सेवा खाते से अनुमति देते समय, आपके पास अपने ऐप्लिकेशन को क्रेडेंशियल देने के दो विकल्प होते हैं. GOOGLE_APPLICATION_CREDENTIALS एनवायरमेंट वैरिएबल को सेट किया जा सकता है या कोड में सेवा खाते की कुंजी का पाथ साफ़ तौर पर पास किया जा सकता है.
पहला विकल्प ज़्यादा सुरक्षित है और इसका सुझाव दिया जाता है.
एनवायरमेंट वैरिएबल सेट करने के लिए:
एनवायरमेंट वैरिएबल GOOGLE_APPLICATION_CREDENTIALS को उस JSON फ़ाइल के पाथ पर सेट करें जिसमें आपके सेवा खाते की कुंजी मौजूद है.
यह वैरिएबल सिर्फ़ आपके मौजूदा शेल सेशन पर लागू होता है. इसलिए, नया सेशन खोलने पर, वैरिएबल को फिर से सेट करें.
Linux या macOS
export GOOGLE_APPLICATION_CREDENTIALS="KEY_FILE_PATH"
खिड़कियां
PowerShell की मदद से:
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_FILE_PATH"
ऊपर दिया गया तरीका अपनाने के बाद, ऐप्लिकेशन डिफ़ॉल्ट क्रेडेंशियल (एडीसी) आपके क्रेडेंशियल का पता लगा सकता है. इससे आपको Google से बाहर के प्लैटफ़ॉर्म पर टेस्टिंग या रनिंग के दौरान, सेवा खाते के क्रेडेंशियल इस्तेमाल करने की सुविधा मिलती है.
कम समय तक चलने वाला OAuth 2.0 ऐक्सेस टोकन पाने के लिए, अपनी पसंदीदा भाषा में Google Auth Library के साथ अपने Firebase क्रेडेंशियल इस्तेमाल करें:
node.js
function getAccessToken() {
return admin.credential.applicationDefault().getAccessToken()
.then(accessToken => {
return accessToken.access_token;
})
.catch(err => {
console.error('Unable to get access token');
console.error(err);
});
}
इस उदाहरण में, Google API की क्लाइंट लाइब्रेरी, JSON वेब टोकन या JWT की मदद से अनुरोध की पुष्टि करती है. ज़्यादा जानकारी के लिए, JSON वेब टोकन देखें.
Python
def _get_access_token():
"""Retrieve a valid access token that can be used to authorize requests.
:return: Access token.
"""
credentials = ServiceAccountCredentials.from_json_keyfile_name(
'service-account.json', SCOPES)
access_token_info = credentials.get_access_token()
return access_token_info.access_token
Java
public static String getAccessToken() throws IOException {
GoogleCredentials googleCredentials = GoogleCredentials
.fromStream(new FileInputStream("service-account.json"))
.createScoped(Arrays.asList(SCOPES));
googleCredentials.refreshAccessToken();
return googleCredentials.getAccessToken().getTokenValue();
}
ऐक्सेस टोकन की समयसीमा खत्म होने के बाद, अपडेट किया गया ऐक्सेस टोकन पाने के लिए, टोकन रीफ़्रेश करने का तरीका अपने-आप कॉल हो जाता है.
Remote Config को ऐक्सेस करने की अनुमति देने के लिए, https://www.googleapis.com/auth/firebase.remoteconfig स्कोप का अनुरोध करें.
Remote Config टेंप्लेट में बदलाव करना
Remote Config टेंप्लेट के साथ काम करते समय, ध्यान रखें कि उनके वर्शन होते हैं. साथ ही, हर वर्शन की समयसीमा सीमित होती है. यह समयसीमा, वर्शन बनाने के समय से लेकर उसे अपडेट के साथ बदलने के समय तक होती है: 90 दिन. साथ ही, सेव किए गए वर्शन की कुल सीमा 300 होती है. ज़्यादा जानकारी के लिए, टेंप्लेट और वर्शनिंग देखें.
मौजूदा Remote Config टेंप्लेट पाना
बैकएंड एपीआई का इस्तेमाल करके, Remote Config टेंप्लेट के मौजूदा वर्शन को JSON फ़ॉर्मैट में पाया जा सकता है.
किसी
इन निर्देशों का इस्तेमाल करें:
cURL
curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig -o filenameयह कमांड, JSON पेलोड को एक फ़ाइल में और हेडर (Etag के साथ) को दूसरी फ़ाइल में आउटपुट करता है.
रॉ एचटीटीपी अनुरोध
Host: firebaseremoteconfig.googleapis.com GET /v1/projects/my-project-id/remoteConfig HTTP/1.1 Authorization: Bearer token Accept-Encoding: gzip
यह एपीआई कॉल, यहां दिया गया JSON दिखाता है. साथ ही, एक अलग हेडर दिखाता है, जिसमें ई-टैग शामिल होता है. इसका इस्तेमाल, अगले अनुरोध के लिए किया जाता है.
Remote Config टेंप्लेट की पुष्टि करना
इसके अलावा, अपडेट पब्लिश करने से पहले उनकी पुष्टि की जा सकती है.
टेंप्लेट के अपडेट की पुष्टि करने के लिए, पब्लिश करने के अनुरोध में यूआरएल पैरामीटर ?validate_only=true जोड़ें.
जवाब में, स्टेटस कोड 200 और सफ़िक्स -0 के साथ अपडेट किया गया ईटैग मिलने का मतलब है कि आपके अपडेट की पुष्टि हो गई है. 200 के अलावा कोई भी रिस्पॉन्स मिलने का मतलब है कि JSON डेटा में गड़बड़ियां हैं. आपको पब्लिश करने से पहले, उन्हें ठीक करना होगा.
Remote Config टेंप्लेट को अपडेट करना
टेंप्लेट को वापस पाने और JSON कॉन्टेंट में बदलाव करने के बाद, उसे पब्लिश किया जा सकता है. इस सेक्शन में बताए गए तरीके से टेंप्लेट पब्लिश करने पर, मौजूदा कॉन्फ़िगरेशन टेंप्लेट की जगह अपडेट की गई फ़ाइल ले लेती है. साथ ही, नए चालू टेंप्लेट को उस टेंप्लेट से एक नंबर ज़्यादा वाला वर्शन नंबर असाइन किया जाता है जिसकी जगह उसने ली है.
अगर ज़रूरी हो, तो REST API का इस्तेमाल करके, पिछले वर्शन पर वापस जाएं. अपडेट में गड़बड़ियों के जोखिम को कम करने के लिए, पब्लिश करने से पहले पुष्टि की जा सकती है.
Remote Config डाउनलोड किए गए टेंप्लेट में, पसंद के मुताबिक बनाए गए वर्शन और शर्तें शामिल होती हैं. इसलिए, किसी दूसरे प्रोजेक्ट में पब्लिश करते समय, इन सीमाओं के बारे में जानना ज़रूरी है:
पसंद के मुताबिक बनाए गए अनुभव को एक प्रोजेक्ट से दूसरे प्रोजेक्ट में इंपोर्ट नहीं किया जा सकता.
उदाहरण के लिए, अगर आपने अपने प्रोजेक्ट में, उपयोगकर्ता के हिसाब से कॉन्टेंट बनाने की सुविधा चालू की है और किसी टेंप्लेट को डाउनलोड करके उसमें बदलाव किया है, तो उसे उसी प्रोजेक्ट में पब्लिश किया जा सकता है. हालांकि, उसे किसी दूसरे प्रोजेक्ट में तब तक पब्लिश नहीं किया जा सकता, जब तक कि टेंप्लेट से, उपयोगकर्ता के हिसाब से बनाए गए कॉन्टेंट को मिटा न दिया जाए.
शर्तों को एक प्रोजेक्ट से दूसरे प्रोजेक्ट में इंपोर्ट किया जा सकता है. हालांकि, ध्यान रखें कि शर्त के हिसाब से तय की गई कोई भी वैल्यू (जैसे, ऐप्लिकेशन आईडी या ऑडियंस), पब्लिश करने से पहले टारगेट प्रोजेक्ट में मौजूद होनी चाहिए.
उदाहरण के लिए, अगर आपके पास कोई ऐसा Remote Config पैरामीटर है जो किसी शर्त का इस्तेमाल करता है और उस शर्त में प्लैटफ़ॉर्म की वैल्यू
iOSहै, तो टेंप्लेट को किसी दूसरे प्रोजेक्ट में पब्लिश किया जा सकता है. ऐसा इसलिए, क्योंकि प्लैटफ़ॉर्म की वैल्यू हर प्रोजेक्ट के लिए एक जैसी होती हैं. हालांकि, अगर इसमें ऐसी शर्त शामिल है जो किसी खास ऐप्लिकेशन आईडी या उपयोगकर्ता ऑडियंस पर निर्भर करती है और वह टारगेट प्रोजेक्ट में मौजूद नहीं है, तो पुष्टि नहीं हो पाएगी.अगर आपको जो टेंप्लेट पब्लिश करना है उसमें ऐसी शर्तें शामिल हैं जो Google Analytics पर निर्भर करती हैं, तो टारगेट प्रोजेक्ट में Analytics को चालू करना ज़रूरी है.
cURL
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 कमांड के लिए, "@" वर्ण के बाद फ़ाइल का नाम डालकर, कॉन्टेंट की जानकारी दी जा सकती है.
रॉ एचटीटीपी अनुरोध
Host: firebaseremoteconfig.googleapis.com PUT /v1/projects/my-project-id/remoteConfig HTTP/1.1 Content-Length: size Content-Type: application/json; UTF8 Authorization: Bearer token If-Match: expected ETag Accept-Encoding: gzip JSON_HERE
यह एक राइट रिक्वेस्ट है. इसलिए, इस निर्देश से ई-टैग में बदलाव किया जाता है. साथ ही, अगले PUT निर्देश के रिस्पॉन्स हेडर में, अपडेट किया गया ई-टैग दिया जाता है.
Remote Config शर्तों में बदलाव करें
प्रोग्राम के हिसाब से, Remote Config शर्तों और शर्त के हिसाब से तय की गई वैल्यू में बदलाव किया जा सकता है. REST API का इस्तेमाल करके, टेंप्लेट को पब्लिश करने से पहले, शर्तों में बदलाव करने के लिए आपको टेंप्लेट में सीधे बदलाव करना होगा.
{
"conditions": [{
"name": "android_english",
"expression": "device.os == 'android' && device.country in ['us', 'uk']",
"tagColor": "BLUE"
}, {
"name": "tenPercent",
"expression": "percent <= 10",
"tagColor": "BROWN"
}],
"parameters": {
"welcome_message": {
"defaultValue": {
"value": "Welcome to this sample app"
},
"conditionalValues": {
"tenPercent": {
"value": "Welcome to this new sample app"
}
},
"description": "The sample app's welcome message"
},
"welcome_message_caps": {
"defaultValue": {
"value": "false"
},
"conditionalValues": {
"android_english": {
"value": "true"
}
},
"description": "Whether the welcome message should be displayed in all
capital letters."
}
}
}ऊपर दिए गए स्निपेट में किए गए बदलाव, सबसे पहले शर्तों का एक सेट तय करते हैं. इसके बाद, हर पैरामीटर के लिए डिफ़ॉल्ट वैल्यू और शर्त के आधार पर पैरामीटर (शर्त के हिसाब से वैल्यू) की वैल्यू तय करते हैं. वे हर एलिमेंट के लिए, ब्यौरा भी जोड़ते हैं. हालांकि, ऐसा करना ज़रूरी नहीं है. कोड की टिप्पणियों की तरह ही, ये ब्यौरे भी डेवलपर के इस्तेमाल के लिए होते हैं और ऐप्लिकेशन में नहीं दिखते. वर्शन कंट्रोल के लिए, एक ETag भी दिया जाता है.
Remote Config बैकएंड एपीआई, कई शर्तें और तुलना करने वाले ऑपरेटर उपलब्ध कराते हैं. इनका इस्तेमाल करके, अपने ऐप्लिकेशन के काम करने के तरीके और उसके दिखने के तरीके में बदलाव किया जा सकता है. शर्तों और इन शर्तों के लिए इस्तेमाल किए जा सकने वाले ऑपरेटर के बारे में ज़्यादा जानने के लिए, कंडिशनल एक्सप्रेशन रेफ़रंस देखें.
एचटीटीपी गड़बड़ी के कोड
| स्थिति कोड | मतलब |
|---|---|
| 200 | अपडेट हो गया |
| 400 | पुष्टि करने में कोई गड़बड़ी हुई. उदाहरण के लिए, अगर किसी अनुरोध में तय सीमा से ज़्यादा कुंजियां शामिल हैं, तो गड़बड़ी का मैसेज Param count too large के साथ 400 (खराब अनुरोध) दिखेगा. अनुरोध में ज़्यादा से ज़्यादा 2,000 कुंजियां शामिल की जा सकती हैं.
साथ ही, यह एचटीटीपीएस स्टेटस कोड इन दो स्थितियों में दिख सकता है:
|
| 401 | अनुमति देने में कोई गड़बड़ी हुई. ऐसा इसलिए हुआ, क्योंकि कोई ऐक्सेस टोकन नहीं दिया गया था या Cloud Developer Console में आपके प्रोजेक्ट में Firebase Remote Config REST API नहीं जोड़ा गया था |
| 403 | पुष्टि करने के दौरान गड़बड़ी हुई (गलत ऐक्सेस टोकन दिया गया) |
| 500 | एक आंतरिक गड़बड़ी हुई. अगर यह गड़बड़ी होती है, तो Firebase सहायता टिकट सबमिट करें |
स्टेटस कोड 200 का मतलब है कि Remote Config टेंप्लेट (प्रोजेक्ट के लिए पैरामीटर, वैल्यू, और शर्तें) अपडेट हो गया है. साथ ही, अब यह इस प्रोजेक्ट का इस्तेमाल करने वाले ऐप्लिकेशन के लिए उपलब्ध है. अन्य स्टेटस कोड से पता चलता है कि पहले से मौजूद Remote Config टेंप्लेट अब भी लागू है.
अपने टेंप्लेट में अपडेट सबमिट करने के बाद, Firebase कंसोल पर जाएं और पुष्टि करें कि आपके बदलाव उम्मीद के मुताबिक दिख रहे हैं. यह ज़रूरी है, क्योंकि शर्तों के क्रम से उनके आकलन पर असर पड़ता है. जिस शर्त का आकलन सबसे पहले true के तौर पर किया जाता है वह लागू होती है.
ईटैग का इस्तेमाल और ज़बरदस्ती किए जाने वाले अपडेट
Remote Config REST API, रेस कंडिशन और संसाधनों के ओवरलैप होने वाले अपडेट को रोकने के लिए, इकाई टैग (ई-टैग) का इस्तेमाल करता है. ईटैग के बारे में ज़्यादा जानने के लिए, ETag - HTTP देखें.
REST API के लिए, Google का सुझाव है कि आप सबसे हाल के GET कमांड से मिले ई-टैग को कैश मेमोरी में सेव करें. साथ ही, PUT कमांड जारी करते समय, If-Match अनुरोध के हेडर में उस ई-टैग वैल्यू का इस्तेमाल करें. अगर आपके PUT कमांड के नतीजे में एचटीटीपीएस स्टेटस कोड 409 मिलता है, तो आपको नया ई-टैग और टेंप्लेट पाने के लिए, नया GET कमांड जारी करना चाहिए. इससे आपको अपने अगले PUT कमांड के साथ इस्तेमाल करने के लिए नया ई-टैग और टेंप्लेट मिल जाएगा.
ईटैग और इससे मिलने वाली सुरक्षा को बायपास किया जा सकता है. इसके लिए, Remote Config टेंप्लेट को इस तरह अपडेट करें:
If-Match: *. हालांकि, ऐसा करने का सुझाव नहीं दिया जाता, क्योंकि अगर कई क्लाइंट Remote Config टेंप्लेट को अपडेट कर रहे हैं, तो आपके Remote Config टेंप्लेट के अपडेट मिटने का खतरा रहता है. इस तरह की समस्या, एपीआई का इस्तेमाल करने वाले कई क्लाइंट के साथ हो सकती है. इसके अलावा, एपीआई क्लाइंट और Firebase कंसोल के उपयोगकर्ताओं के अपडेट में अंतर होने की वजह से भी ऐसा हो सकता है.
Remote Config टेंप्लेट के वर्शन मैनेज करने के बारे में जानने के लिए, Remote Config टेंप्लेट और वर्शनिंग लेख पढ़ें.
Firebase सीएलआई का इस्तेमाल करके Remote Config में बदलाव करना
Firebase सीएलआई की मदद से, Remote Config टेंप्लेट की जांच की जा सकती है, उन्हें मैनेज किया जा सकता है, और उन्हें वापस लाया जा सकता है. साथ ही, सीधे कमांड लाइन से Remote Config एक्सपेरिमेंट और रोलआउट की सूची देखी जा सकती है, उनकी जांच की जा सकती है, और उन्हें मिटाया जा सकता है.
ज़रूरी शर्तें और सेटअप
Firebase में साइन इन करें:
firebase loginअपना ऐक्टिव प्रोजेक्ट सेट करें या हर कमांड के साथ
--project PROJECT_IDकी जानकारी दें:firebase use PROJECT_ID
पक्का करें कि आपके खाते या सेवा खाते के पास, आईएएम की ज़रूरी अनुमतियां हों:
- Remote Config टेंप्लेट की जांच करने, उन्हें डाउनलोड करने या रोल बैक करने और रोल आउट मैनेज करने के लिए, आपके पास Firebase Remote Config एडमिन की भूमिका (
roles/cloudconfig.admin) याcloudconfig.configs.get,cloudconfig.configs.update,cloudconfig.rollouts.get,cloudconfig.rollouts.list, औरcloudconfig.rollouts.archiveअनुमतियां होनी चाहिए. सिर्फ़ देखने के लिए, Firebase Remote Config दर्शक की भूमिका (roles/cloudconfig.viewer) (cloudconfig.configs.get,cloudconfig.rollouts.get, औरcloudconfig.rollouts.list) काफ़ी है. A/B Testing एक्सपेरिमेंट मैनेज करने के लिए, आपके पास FirebaseA/B Testing एडमिन की भूमिका (roles/firebaseabt.admin) याfirebaseabt.experiments.get,firebaseabt.experiments.list, औरfirebaseabt.experiments.deleteअनुमतियां होनी चाहिए. सिर्फ़ देखने के लिए, FirebaseA/B Testing दर्शक की भूमिका (roles/firebaseabt.viewer) काफ़ी है.
सीएलआई कमांड की खास जानकारी
| निर्देश देने के लिए | ब्यौरा |
|---|---|
firebase remoteconfig:versions:list |
इससे Remote Config टेंप्लेट के हाल ही के वर्शन की सूची दिखती है. |
firebase remoteconfig:get |
Remote Config टेंप्लेट को फ़ेच करता है. इसके अलावा, फ़ाइल में भी लिखा जा सकता है. |
firebase remoteconfig:rollback |
Remote Config टेंप्लेट को पिछले वर्शन पर रोल बैक करता है. |
firebase remoteconfig:experiments:list |
प्रोजेक्ट में मौजूद सभी Remote Config एक्सपेरिमेंट की सूची दिखाता है. |
firebase remoteconfig:experiments:get |
किसी खास Remote Config एक्सपेरिमेंट की जानकारी मिलती है. |
firebase remoteconfig:experiments:delete |
इससे कोई खास Remote Config एक्सपेरिमेंट मिट जाता है. |
firebase remoteconfig:rollouts:list |
प्रोजेक्ट में मौजूद सभी Remote Config रोलआउट की सूची दिखाता है. |
firebase remoteconfig:rollouts:get |
किसी खास Remote Config रोलआउट की जानकारी मिलती है. |
firebase remoteconfig:rollouts:delete |
इससे Remote Config का कोई खास रोलआउट मिट जाता है. |
Remote Config के टेंप्लेट और वर्शन में बदलाव करना
Remote Config टेंप्लेट और उनके वर्शन इतिहास की जांच करने, उन्हें डाउनलोड करने, और उन्हें पहले जैसा करने के लिए, इन निर्देशों का इस्तेमाल करें:
टेंप्लेट के वर्शन की सूची दिखाना
डिफ़ॉल्ट रूप से, Remote Config टेंप्लेट के सबसे नए 10 वर्शन की सूची दिखाता है. इसमें वर्शन नंबर, अपडेट का समय, अपडेट का सोर्स, अपडेट का टाइप, और updateUser शामिल है.
firebase remoteconfig:versions:list [--limit NUMBER_OF_VERSIONS]--limit NUMBER_OF_VERSIONS: वर्शन की ज़्यादा से ज़्यादा संख्या. सभी मौजूदा वर्शन वापस पाने के लिए,0डालें. हालांकि, ज़्यादा से ज़्यादा 300 वर्शन ही सेव किए जा सकते हैं.
उदाहरण:
सबसे नए 10 वर्शन की सूची बनाएं:
firebase remoteconfig:versions:listउपलब्ध सभी वर्शन की सूची:
firebase remoteconfig:versions:list --limit 0सबसे नए पांच वर्शन की सूची बनाएं:
firebase remoteconfig:versions:list --limit 5
कोई टेंप्लेट चुनें
Remote Config टेंप्लेट को फ़ेच करता है और पैरामीटर ग्रुप, पैरामीटर, शर्त के नाम, और वर्शन को आउटपुट करता है. डिफ़ॉल्ट रूप से, यह सबसे नया ऐक्टिव वर्शन हासिल करता है और टर्मिनल पर फ़ॉर्मैट की गई खास जानकारी दिखाता है.
firebase remoteconfig:get [-v, --version_number VERSION_NUMBER] [-o, --output FILENAME]-v, --version_number VERSION_NUMBER: जिस टेंप्लेट को वापस लाना है उसका वर्शन नंबर. अगर इसे शामिल नहीं किया जाता है, तो डिफ़ॉल्ट रूप से नया वर्शन इस्तेमाल किया जाता है.-o, --output FILENAME: यह टेंप्लेट के JSON पेलोड को stdout पर प्रिंट करने के बजाय, सीधे तौर पर बताए गए पाथ पर लिखता है.
उदाहरण:
टर्मिनल में, फ़िलहाल चालू टेंप्लेट दिखाएं:
firebase remoteconfig:getमौजूदा चालू टेंप्लेट को JSON फ़ाइल में डाउनलोड करने के लिए:
firebase remoteconfig:get -o remote_config_template.jsonकिसी खास पुराने वर्शन (उदाहरण के लिए, वर्शन 12) को फ़ाइल में डाउनलोड करना:
firebase remoteconfig:get -v 12 -o remote_config_v12.json
किसी टेंप्लेट को रोल बैक करना
यह चालू Remote Config टेंप्लेट को पिछले वर्शन पर रोल बैक करता है. इससे एक नया ऐक्टिव वर्शन बनता है, जिसका कॉन्टेंट टारगेट वर्शन से मिलता-जुलता होता है.
firebase remoteconfig:rollback [-v, --version_number VERSION_NUMBER] [--force]-v, --version_number VERSION_NUMBER: रोल बैक करने के लिए, टारगेट वर्शन का नंबर. अगर इसे शामिल नहीं किया जाता है, तो डिफ़ॉल्ट रूप से इसके ठीक पहले वाले वर्शन (मौजूदा वर्शन से एक पहले वाला वर्शन) का इस्तेमाल किया जाता है.--force: इंटरैक्टिव तरीके से पुष्टि (Y/N) के लिए पूछे बिना, तुरंत रोलबैक करता है. सीआई/सीडी पाइपलाइन और ऑटोमेटेड स्क्रिप्ट के लिए मददगार.
उदाहरण:
इंटरैक्टिव तरीके से पुष्टि करके, पिछले वर्शन पर रोल बैक करना:
firebase remoteconfig:rollbackबिना पूछे वर्शन 8 पर रोल बैक करें:
firebase remoteconfig:rollback -v 8 --force
A/B Testing एक्सपेरिमेंट में बदलाव करें
सीधे सीएलआई से Remote Config
एक्सपेरिमेंट की सूची बनाएं
प्रोजेक्ट के लिए सभी Remote Config एक्सपेरिमेंट की सूची दिखाता है. इसमें फ़िल्टर करने और पेज पर नंबर डालने का विकल्प भी होता है.
firebase remoteconfig:experiments:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]--filter EXPRESSION: एक्सपेरिमेंट की सूची पर लागू करने के लिए फ़िल्टर एक्सप्रेशन.--pageSize NUMBER: हर पेज पर दिखाए जाने वाले एक्सपेरिमेंट की संख्या (डिफ़ॉल्ट रूप से 10).--pageToken TOKEN: पेज के हिसाब से नतीजे वापस पाने के दौरान, पेज ऑफ़सेट के लिए टोकन.
उदाहरण:
firebase remoteconfig:experiments:listएक्सपेरिमेंट की जानकारी पाना
इससे किसी Remote Config एक्सपेरिमेंट की पूरी जानकारी मिलती है.
firebase remoteconfig:experiments:get EXPERIMENT_IDउदाहरण:
firebase remoteconfig:experiments:get exp_promo_discount_2026किसी एक्सपेरिमेंट को मिटाना
इससे, Remote Config का तय किया गया एक्सपेरिमेंट मिट जाता है.
firebase remoteconfig:experiments:delete EXPERIMENT_IDउदाहरण:
firebase remoteconfig:experiments:delete exp_promo_discount_2026Remote Config रोलआउट में बदलाव करें
सीधे सीएलआई की मदद से, Remote Config रोलआउट की सूची देखने, उनकी जांच करने, और उन्हें मिटाने के लिए, इन कमांड का इस्तेमाल करें:
रोल आउट की सूची दिखाना
प्रोजेक्ट के लिए सभी Remote Config रोलआउट की सूची दिखाता है. इसमें फ़िल्टर करने और पेज पर नंबर डालने के विकल्प मिलते हैं.
firebase remoteconfig:rollouts:list [--filter EXPRESSION] [--pageSize NUMBER] [--pageToken TOKEN]--filter EXPRESSION: रोलआउट की सूची पर लागू करने के लिए, फ़िल्टर एक्सप्रेशन.--pageSize NUMBER: हर पेज पर दिखने वाले रोलआउट की संख्या (डिफ़ॉल्ट रूप से 10).--pageToken TOKEN: पेज के हिसाब से नतीजे वापस पाने के दौरान, पेज ऑफ़सेट के लिए टोकन.
उदाहरण:
firebase remoteconfig:rollouts:listरोलआउट की जानकारी पाना
इससे, रोल आउट किए गए किसी Remote Config की पूरी जानकारी मिलती है.
firebase remoteconfig:rollouts:get ROLLOUT_IDउदाहरण:
firebase remoteconfig:rollouts:get rollout_new_checkout_flowकिसी रोलआउट को मिटाना
यह Remote Config के लिए तय किए गए रोलआउट को मिटाता है.
firebase remoteconfig:rollouts:delete ROLLOUT_IDउदाहरण:
firebase remoteconfig:rollouts:delete rollout_new_checkout_flowFirebase सीएलआई कमांड के बारे में ज़्यादा जानकारी के लिए, Firebase सीएलआई रेफ़रंस देखें.