firebase-admin.remote-config package

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

الدوال

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

صفوف

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

عمليات التعداد

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

واجهات

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

كتابة العناوين البديلة للبريد الإلكتروني

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

getRemoteConfig(app)

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

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

Signature:

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

المَعلمات

المعلمة النوع الوصف
التطبيق التطبيق التطبيق الاختياري المطلوب عرض خدمة 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;
};

سياق التقييم

يمثّل هذا الإعداد إشارات إدخال تقييم النماذج.

Signature:

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

نوع قيمة المَعلمة

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

Signature:

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

عن بُعد مَعلمة قيمة

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

Signature:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

نوع الخادم ServerTemplateDataType

يُمثِّل هذا الحقل نوع نموذج خادم "الإعداد عن بُعد" الذي يمكن ضبطه على 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';

مصدر القيمة

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

  • "ثابت" تشير إلى القيمة التي تم تحديدها بواسطة ثابت ثابت.
  • "تلقائي" تشير إلى تحديد القيمة من خلال التهيئة الافتراضية.
  • "بعيد" يشير إلى القيمة التي تم تحديدها من خلال الإعداد الذي تم إنتاجه من خلال تقييم نموذج.

Signature:

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

عامل تشغيل النسبة المئوية

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

Signature:

export declare enum PercentConditionOperator 

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

عضو القيمة الوصف
بين "BETWEEN" الشرائح المئوية المستهدفة ضمن فاصل زمني محدَّد من خلال حدّ أدنى وحدّ أعلى فالحد الأدنى هو حد حصري (مفتوح)، بينما يكون الحد الصغير (micro_percent_range_upper_bound) محدودًا (مغلقًا). يجب أن يحدد شرط يستخدم عامل التشغيل هذا MicroPercentRange.
أكثر_من "GREATER_THAN" الشرائح المئوية المستهدَفة أكبر من النسبة المئوية المستهدَفة. يجب أن يحدد الشرط الذي يستخدم عامل التشغيل هذا MicroPercent.
LESS_OR_EQUAL "LESS_OR_EQUAL" الشرائح المئوية المستهدَفة أقل من أو تساوي النسبة المئوية المستهدَفة. يجب أن يحدد الشرط الذي يستخدم عامل التشغيل هذا MicroPercent.
غير معروف "UNKNOWN" حالة خطأ عام.