firebase-admin.remote-config package

الإعداد عن بُعد في Firebase.

الوظائف

الوظيفة	الوصف
getRemoteConfig(app)	يمكن الحصول على خدمة RemoteConfig للتطبيق التلقائي أو لتطبيق معيّن.ويمكن استدعاء getRemoteConfig() بدون وسيطات للوصول إلى خدمة RemoteConfig للتطبيق التلقائي أو كـ getRemoteConfig(app) للوصول إلى خدمة RemoteConfig المرتبطة بتطبيق معيّن.

صفوف

الفئة	الوصف
الإعداد عن بُعد	واجهة خدمة RemoteConfig في Firebase

التعدادات

التعداد	الوصف
عامل التشغيل PercentCondition	تحدِّد عوامل التشغيل المتوافقة لشروط النسبة المئوية.

الواجهات

الواجهة	الوصف
AndCondition	يمثل مجموعة من الشروط التي يتم تقييمها على صواب إذا كانت جميعها صحيحة.
وضِّحParameterValue	واجهة تمثّل قيمة مَعلمة صريحة
GetServerTemplateOptions	تمثل هذه السمة وسيطات اختيارية يمكن استخدامها عند إنشاء مثيل ServerTemplate.
InAppDefaultValue	واجهة تمثّل قيمة تلقائية داخل التطبيق
InitServerTemplateOptions	تمثّل هذه السمة وسيطات اختيارية يمكن استخدامها عند إنشاء مثيل ServerTemplate بشكل متزامن.
ListVersionsOptions	واجهة تمثّل خيارات عملية إصدارات قائمة "الإعداد عن بُعد"
ListVersionsResult	واجهة تمثّل قائمة بإصدارات نماذج "الإعداد عن بُعد"
MicroPercentRange	يمثّل حدّ النسب المئوية المُراد استهدافها بالنسب المئوية الصغرى. يجب أن تتراوح القيمة بين [0 و100000000]
NamedCondition	تُمثِّل هذه الدالة شرطًا من أجل "الإعداد عن بُعد" في مستوى البيانات. يستهدف الشرط مجموعة معينة من المستخدمين. تشكِّل قائمة هذه الشروط جزءًا من نموذج "الإعداد عن بُعد".
OneOfCondition	يمثل شرطًا قد يكون نوعًا من عدة أنواع. ستتم معالجة أول حقل محدّد فقط.
أو الشرط	يمثل مجموعة من الشروط التي يتم تقييمها على صواب إذا كانت أي منها صحيحة.
النسبة المئوية للشرط	تمثّل هذه السمة شرطًا يقارن بين نسبة مئوية عشوائية عشوائية وحدّ معيّن.
حالة الإعداد عن بُعد	واجهة تمثّل شرطًا من شروط "الإعداد عن بُعد" يستهدف الشرط مجموعة معينة من المستخدمين. تشكِّل قائمة بهذه الشروط جزءًا من نموذج "الإعداد عن بُعد".
RemoteConfigParameter	واجهة تمثّل مَعلمة "الإعداد عن بُعد" يجب توفّر إدخال defaultValue أو conditionalValues على الأقل حتى يكون للمَعلمة أي تأثير.
RemoteConfigParameterGroup	واجهة تمثّل مجموعة مَعلمات الإعداد عن بُعد يتم استخدام مَعلمات التجميع لأغراض الإدارة فقط، ولا يؤثر في استرجاع قيم المَعلمات من جهة العميل.
RemoteConfigTemplate	يمثّل نموذج عميل لميزة "الإعداد عن بُعد".
RemoteConfigUser	واجهة تمثّل أحد مستخدمي ميزة "الإعداد عن بُعد"
إعداد الخادم	تُمثِّل هذه السمة الإعدادات التي تم إنتاجها من خلال تقييم نموذج خادم.
نموذج الخادم	يُمثِّل ذلك تجريدًا ذا حالة لنموذج خادم الإعداد عن بُعد.
بيانات نموذج الخادم	يمثل هذا الخيار البيانات في نموذج خادم "الإعداد عن بُعد".
القيمة	تلفّ هذه الدالة قيمة مَعلمة مع بيانات وصفية ورموز حروف آمنة من النوع.تعزل هذه القيم منطقية التطبيق عن التغييرات عن بُعد في أسماء المَعلمات وأنواعها.
الإصدار	واجهة تمثّل إصدار نموذج "الإعداد عن بُعد" النتائج فقط، باستثناء وصف الإصدار. يحتوي على بيانات وصفية عن إصدار معيّن من نموذج "الإعداد عن بُعد". يتم ضبط جميع الحقول في وقت نشر نموذج "الإعداد عن بُعد" المحدّد. يمكن تحديد حقل وصف الإصدار في مكالمات publishTemplate.

الأسماء المستعارة للنوع

النوع البديل	الوصف
الإعداد التلقائي	تُحدِّد تنسيق قيم المَعلمات التلقائية داخل التطبيق.
EvaluationContext	يُمثِّل ذلك إشارات إدخال تقييم النموذج.
ParameterValueType	النوع الذي يمثّل نوع بيانات قيمة مَعلمة "الإعداد عن بُعد". يتم ضبط القيمة تلقائيًا على STRING في حال عدم تحديدها.
RemoteConfigParameterValue	النوع الذي يمثّل قيمة مَعلمة "الإعداد عن بُعد" قد تكون السمة RemoteConfigParameterValue إما ExplicitParameterValue أو InAppDefaultValue.
ServerTemplateDataType	يمثل نموذج خادم "الإعداد عن بُعد" الذي يمكن ضبطه على ServerTemplate. ويمكن أن يكون هذا إما كائن ServerTemplateData أو نموذج سلسلة JSON لنموذج.
لون العلامة	الألوان المرتبطة بالشروط لأغراض العرض.
مصدر القيمة	يشير إلى مصدر القيمة. تشير القيمة "ثابت" إلى القيمة التي تم تحديدها من خلال ثابت ثابت. يشير الخيار "تلقائي" إلى أنّه تم تحديد القيمة من خلال الإعداد التلقائي. يشير الخيار "Remote" إلى القيمة التي تم تحديدها من خلال الإعدادات التي تم إنتاجها من خلال تقييم نموذج.

getRemoteConfig(app)

الحصول على خدمة RemoteConfig للتطبيق التلقائي أو لتطبيق معين.

يمكن طلب getRemoteConfig() بدون وسيطات للوصول إلى خدمة RemoteConfig للتطبيق التلقائي أو كـ getRemoteConfig(app) للوصول إلى خدمة RemoteConfig المرتبطة بتطبيقٍ معيّن.

Signature:

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

المَعلمات

المَعلمة	Type	الوصف
التطبيق	التطبيق	التطبيق الاختياري الذي يتم عرض خدمة RemoteConfig له. وفي حال عدم توفيرها، يتم عرض خدمة RemoteConfig التلقائية.

المرتجعات:

الإعداد عن بُعد

هي خدمة RemoteConfig التلقائية في حال عدم توفُّر أي تطبيق، أو خدمة RemoteConfig المرتبطة بالتطبيق المقدَّم.

مثال 1

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

مثال 2

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

الإعداد التلقائي

تُحدِّد تنسيق قيم المَعلمات التلقائية داخل التطبيق.

Signature:

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

سياق EvaluationContext

يُمثِّل ذلك إشارات إدخال تقييم النموذج.

Signature:

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

ParameterValueType

النوع الذي يمثّل نوع بيانات قيمة مَعلمة "الإعداد عن بُعد". يتم ضبط القيمة تلقائيًا على STRING في حال عدم تحديدها.

Signature:

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

قيمة RemoteConfigParameterValue

النوع الذي يمثّل قيمة مَعلمة "الإعداد عن بُعد" قد تكون السمة RemoteConfigParameterValue إما ExplicitParameterValue أو InAppDefaultValue.

Signature:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

نوع بيانات نموذج الخادم

يمثل نموذج خادم "الإعداد عن بُعد" الذي يمكن ضبطه على ServerTemplate. ويمكن أن يكون هذا إما كائن ServerTemplateData أو نموذج سلسلة JSON لنموذج.

Signature:

export type ServerTemplateDataType = ServerTemplateData | string;

لون العلامة

الألوان المرتبطة بالشروط لأغراض العرض.

Signature:

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

مصدر القيمة

يشير إلى مصدر القيمة.

• تشير القيمة "ثابت" إلى القيمة التي تم تحديدها من خلال ثابت ثابت.
• يشير الخيار "تلقائي" إلى أنّه تم تحديد القيمة من خلال الإعداد التلقائي.
• يشير الخيار "Remote" إلى القيمة التي تم تحديدها من خلال الإعدادات التي تم إنتاجها من خلال تقييم نموذج.

Signature:

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

عامل التشغيل PercentCondition

تحدِّد عوامل التشغيل المتوافقة لشروط النسبة المئوية.

Signature:

export declare enum PercentConditionOperator 

أعضاء التعداد

عضو	القيمة	الوصف
بين	"BETWEEN"	الشرائح المئوية المستهدفة خلال فاصل يتم تحديده من خلال حد أدنى وحد أعلى. الحد الأدنى هو حد حصري (مفتوح) وmic_percent_range_upper_bound عبارة عن حدود شاملة (مغلقة). يجب أن تحدد الحالة التي تستخدم عامل التشغيل هذا المجال microPercentRange.
رائع	"GREATER_THAN"	القيم المئوية المستهدفة أكبر من النسبة المئوية المستهدفة. يجب أن تحدد الحالة التي تستخدم عامل التشغيل هذا نسبة microPercent.
أقل_أو_متساوية	"LESS_OR_EQUAL"	الشرائح المئوية المستهدفة أقل من أو تساوي النسبة المئوية المستهدفة يجب أن تحدد الحالة التي تستخدم عامل التشغيل هذا نسبة microPercent.
غير معروف	"UNKNOWN"	حالة خطأ عام.