firebase-admin.remote-config package

Firebase रिमोट कॉन्फ़िगरेशन.

फ़ंक्शन

फ़ंक्शन ब्यौरा
getRemoteConfig(ऐप्लिकेशन) यह किसी डिफ़ॉल्ट ऐप्लिकेशन या किसी ऐप्लिकेशन के लिए, RemoteConfig सेवा मिलती है.getRemoteConfig() को डिफ़ॉल्ट ऐप्लिकेशन की RemoteConfig सेवा को ऐक्सेस करने के लिए, बिना किसी तर्क के या किसी खास ऐप्लिकेशन से जुड़ी RemoteConfig सेवा को ऐक्सेस करने के लिए getRemoteConfig(app) के तौर पर कॉल किया जा सकता है.

क्लास

क्लास ब्यौरा
रिमोट कॉन्फ़िगरेशन Firebase RemoteConfig सेवा का इंटरफ़ेस.

गिनती

गिनती ब्यौरा
PercentConditionOperator प्रतिशत की शर्तों के लिए इस्तेमाल किए जा सकने वाले ऑपरेटर के बारे में बताता है.

इंटरफ़ेस

इंटरफ़ेस ब्यौरा
AndCondition ऐसी स्थितियों का संग्रह दिखाता है जो सभी सही होने पर सही होती हैं.
Explicit पैरामीटर वैल्यू साफ़ तौर पर पैरामीटर वैल्यू दिखाने वाला इंटरफ़ेस.
GetServerTemplateOptions यह वैकल्पिक आर्ग्युमेंट के बारे में बताता है. इनका इस्तेमाल ServerTemplate को इंस्टैंशिएट करने के लिए किया जा सकता है.
InAppDefaultValue ऐप्लिकेशन में डिफ़ॉल्ट वैल्यू को दिखाने वाला इंटरफ़ेस.
InitServerTemplateOptions वैकल्पिक आर्ग्युमेंट का इस्तेमाल किया जाता है. इनका इस्तेमाल, ServerTemplate को एक साथ इंस्टैंशिएट करने के लिए किया जा सकता है.
ListVersionsOptions रिमोट कॉन्फ़िगरेशन की सूची वाले वर्शन की कार्रवाई के विकल्पों को दिखाने वाला इंटरफ़ेस.
ListVersionsresults रिमोट कॉन्फ़िगरेशन वाले टेंप्लेट के वर्शन की सूची दिखाने वाला इंटरफ़ेस.
माइक्रोपरसेंटरेंज माइक्रो-प्रतिशत में टारगेट करने के लिए पर्सेंटाइल की सीमा दिखाता है. यह वैल्यू, [0 से 10,00,00,000] की रेंज में होनी चाहिए
NamedCondition डेटाप्लेन में रिमोट कॉन्फ़िगरेशन की शर्त को दिखाता है. शर्त, उपयोगकर्ताओं के किसी खास ग्रुप को टारगेट करती है. इन शर्तों की सूची में रिमोट कॉन्फ़िगरेशन टेंप्लेट शामिल होगा.
OneOfCondition ऐसी स्थिति जो कई तरह की हो सकती है. सिर्फ़ पहले तय किए गए फ़ील्ड को ही प्रोसेस किया जाएगा.
OrCondition ऐसी शर्तों का कलेक्शन दिखाता है जो सही होने पर सही होती हैं.
PercentCondition यह ऐसी शर्त दिखाता है जो स्यूडो-रैंडम पर्सेंटाइल की तुलना, दी गई सीमा से करती है.
remoteConfigCondition रिमोट कॉन्फ़िगरेशन की स्थिति दिखाने वाला इंटरफ़ेस. शर्त, उपयोगकर्ताओं के किसी खास ग्रुप को टारगेट करती है. रिमोट कॉन्फ़िगरेशन टेंप्लेट में इन शर्तों की सूची दी गई है.
RemoteConfig पैरामीटर रिमोट कॉन्फ़िगरेशन पैरामीटर दिखाने वाला इंटरफ़ेस. पैरामीटर पर कोई असर डालने के लिए, कम से कम defaultValue या conditionalValues एंट्री मौजूद होनी चाहिए.
रिमोट कॉन्फ़िगरेशन पैरामीटर ग्रुप रिमोट कॉन्फ़िगरेशन पैरामीटर के ग्रुप को दिखाने वाला इंटरफ़ेस. पैरामीटर का इस्तेमाल सिर्फ़ मैनेजमेंट के लिए किया जाता है. इनसे पैरामीटर वैल्यू को क्लाइंट-साइड फ़ेच करने की प्रोसेस पर कोई असर नहीं पड़ता.
RemoteConfigTemplate रिमोट कॉन्फ़िगरेशन क्लाइंट टेंप्लेट के बारे में बताता है.
RemoteConfigUser रिमोट कॉन्फ़िगरेशन उपयोगकर्ता को दिखाने वाला इंटरफ़ेस.
सर्वर कॉन्फ़िगरेशन यह सर्वर टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन को दिखाता है.
सर्वर टेंप्लेट रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट के लिए स्टेटफ़ुल ऐब्स्ट्रैक्शन दिखाता है.
ServerTemplateData रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट में डेटा दिखाता है.
वैल्यू पैरामीटर वैल्यू को मेटाडेटा और टाइप-सेफ़ गेटर के साथ रैप करता है.टाइप-सुरक्षित गेटर, ऐप्लिकेशन लॉजिक को रिमोट बदलावों से लेकर पैरामीटर के नाम और टाइप तक, इन्सलेट करते हैं.
वर्शन रिमोट कॉन्फ़िगरेशन वाले टेंप्लेट का वर्शन दिखाने वाला इंटरफ़ेस. वर्शन की जानकारी को छोड़कर, सिर्फ़ आउटपुट के लिए. इसमें रिमोट कॉन्फ़िगरेशन टेंप्लेट के किसी खास वर्शन का मेटाडेटा होता है. सभी फ़ील्ड, बताए गए रिमोट कॉन्फ़िगरेशन टेंप्लेट के पब्लिश होने पर सेट किए जाते हैं. वर्शन की जानकारी वाला फ़ील्ड publishTemplate कॉल में बताया जा सकता है.

उपनाम टाइप

उपनाम लिखें ब्यौरा
DefaultConfig यह ऐप्लिकेशन में डिफ़ॉल्ट पैरामीटर वैल्यू का फ़ॉर्मैट तय करता है.
आकलन का कॉन्टेक्स्ट टेंप्लेट के आकलन के इनपुट सिग्नल दिखाता है.
पैरामीटरValueType रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू के डेटा टाइप को दिखाने वाला टाइप. तय न होने पर, डिफ़ॉल्ट वैल्यू STRING होती है.
रिमोट कॉन्फ़िगरेशन पैरामीटर वैल्यू रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू दिखाने वाला टाइप. RemoteConfigParameterValue, ExplicitParameterValue या InAppDefaultValue हो सकता है.
ServerTemplateDataType यह रिमोट कॉन्फ़िगरेशन सर्वर टेंप्लेट के टाइप को दिखाता है, जिसे ServerTemplate पर सेट किया जा सकता है. यह ServerTemplateData ऑब्जेक्ट या टेंप्लेट की JSON स्ट्रिंग हो सकती है.
टैग का रंग ऐसे रंग जो डिसप्ले के लिए शर्तों से जुड़े होते हैं.
वैल्यू सोर्स वैल्यू का सोर्स दिखाता है.
  • "स्टैटिक" से पता चलता है कि वैल्यू को स्टैटिक कॉन्सटेंट की मदद से तय किया गया था.
  • "डिफ़ॉल्ट" से पता चलता है कि वैल्यू को डिफ़ॉल्ट कॉन्फ़िगरेशन से तय किया गया था.
  • "रिमोट" से पता चलता है कि वैल्यू को टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन की मदद से तय किया गया था.

getremoteConfig(ऐप्लिकेशन)

डिफ़ॉल्ट ऐप्लिकेशन या दिए गए ऐप्लिकेशन के लिए RemoteConfig सेवा मिलती है.

डिफ़ॉल्ट ऐप्लिकेशन की RemoteConfig सेवा को ऐक्सेस करने के लिए, getRemoteConfig() को बिना किसी तर्क के कॉल किया जा सकता है. इसके अलावा, किसी खास ऐप्लिकेशन से जुड़ी RemoteConfig सेवा को ऐक्सेस करने के लिए, getRemoteConfig(app) के तौर पर कॉल किया जा सकता है.

हस्ताक्षर:

export declare function getRemoteConfig(app?: App): RemoteConfig;

पैरामीटर

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

लौटाए जाने वाले प्रॉडक्ट:

रिमोट कॉन्फ़िगरेशन

अगर कोई ऐप्लिकेशन नहीं दिया गया है, तो डिफ़ॉल्ट RemoteConfig सेवा या दिए गए ऐप्लिकेशन से जुड़ी RemoteConfig सेवा.

पहला उदाहरण

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

दूसरा उदाहरण

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

डिफ़ॉल्ट कॉन्फ़िगरेशन

यह ऐप्लिकेशन में डिफ़ॉल्ट पैरामीटर वैल्यू का फ़ॉर्मैट तय करता है.

हस्ताक्षर:

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

आकलन का कॉन्टेक्स्ट

टेंप्लेट के आकलन के इनपुट सिग्नल दिखाता है.

हस्ताक्षर:

export type EvaluationContext = {
    randomizationId?: string;
};

पैरामीटर वैल्यू टाइप

रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू के डेटा टाइप को दिखाने वाला टाइप. तय न होने पर, डिफ़ॉल्ट वैल्यू STRING होती है.

हस्ताक्षर:

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

RemoteConfig पैरामीटर वैल्यू

रिमोट कॉन्फ़िगरेशन पैरामीटर की वैल्यू दिखाने वाला टाइप. RemoteConfigParameterValue, ExplicitParameterValue या InAppDefaultValue हो सकता है.

हस्ताक्षर:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

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

हस्ताक्षर:

export type ServerTemplateDataType = ServerTemplateData | string;

टैग का रंग

ऐसे रंग जो डिसप्ले के लिए शर्तों से जुड़े होते हैं.

हस्ताक्षर:

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

वैल्यू सोर्स

वैल्यू का सोर्स दिखाता है.

  • "स्टैटिक" से पता चलता है कि वैल्यू को स्टैटिक कॉन्सटेंट की मदद से तय किया गया था.
  • "डिफ़ॉल्ट" से पता चलता है कि वैल्यू को डिफ़ॉल्ट कॉन्फ़िगरेशन से तय किया गया था.
  • "रिमोट" से पता चलता है कि वैल्यू को टेंप्लेट का आकलन करके बनाए गए कॉन्फ़िगरेशन की मदद से तय किया गया था.

हस्ताक्षर:

export type ValueSource = 'static' | 'default' | 'remote';

PercentConditionOperator

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

हस्ताक्षर:

export declare enum PercentConditionOperator 

इन्युमेशन सदस्य

सदस्य वैल्यू ब्यौरा
BETWEEN "BETWEEN" कम और ज़्यादा सीमा के तय किए गए इंटरवल में टारगेट किए गए पर्सेंटाइल. निचली सीमा, एक्सक्लूसिव (ओपन) बाउंड है और माइक्रो_percent_range_upper_bound शामिल है (क्लोज़्ड) है. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में, microPercentRange के बारे में बताना ज़रूरी है.
धन्यवाद "GREATER_THAN" टारगेट प्रतिशत से ज़्यादा टारगेट किए गए पर्सेंटाइल. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में, MicroPercent के बारे में बताना ज़रूरी है.
कम "LESS_OR_EQUAL" टारगेट किए गए प्रतिशत के हिसाब से, टारगेट प्रतिशत कम या उसके बराबर होता है. इस ऑपरेटर का इस्तेमाल करने वाली शर्त में, MicroPercent के बारे में बताना ज़रूरी है.
कोई जानकारी नहीं है "UNKNOWN" गड़बड़ी का एक कैचऑल केस.