firebase-admin.remote-config package

การกำหนดค่าระยะไกลของ Firebase

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
getRemoteConfig(แอป)	รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด จะเรียกใช้ getRemoteConfig() โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ RemoteConfig ของแอปเริ่มต้น หรือใช้ getRemoteConfig(app) เพื่อเข้าถึงบริการ RemoteConfig ที่เชื่อมโยงกับแอปที่ต้องการได้

ชั้นเรียน

ชั้น	คำอธิบาย
RemoteConfig	อินเทอร์เฟซบริการ Firebase RemoteConfig

การแจงนับ

การแจงนับ	คำอธิบาย
PercentConditionOperator	กำหนดโอเปอเรเตอร์ที่รองรับสำหรับเงื่อนไขเปอร์เซ็นต์

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
AndCondition	แสดงชุดเงื่อนไขที่ประเมินว่าเป็นจริงหากทั้งหมดเป็นจริง
ExplicitParametersValue	อินเทอร์เฟซแสดงค่าพารามิเตอร์อย่างชัดเจน
GetServerTemplateOptions	แสดงอาร์กิวเมนต์ที่ไม่บังคับซึ่งนำมาใช้ได้เมื่อเริ่มต้น ServerTemplate
InAppDefaultValue	อินเทอร์เฟซที่แสดงค่าเริ่มต้นในแอป
InitServerTemplateOptions	แสดงอาร์กิวเมนต์ที่ไม่บังคับซึ่งใช้ได้เมื่อเริ่มต้น ServerTemplate แบบพร้อมกัน
ListVersionsOptions	อินเทอร์เฟซที่แสดงตัวเลือกสำหรับการดำเนินการเวอร์ชันของรายการการกำหนดค่าระยะไกล
ListVersionsผลลัพธ์	อินเทอร์เฟซที่แสดงรายการเวอร์ชันเทมเพลตการกำหนดค่าระยะไกล
MicroPercentRange	แสดงขีดจำกัดของเปอร์เซ็นไทล์ที่จะกำหนดเป้าหมายเป็นไมโครเปอร์เซ็นต์ ค่าต้องอยู่ในช่วง [0 ถึง 100000000]
NamedCondition	แสดงเงื่อนไขการกำหนดค่าระยะไกลในระนาบข้อมูล เงื่อนไขจะกำหนดเป้าหมายกลุ่มผู้ใช้ที่เฉพาะเจาะจง รายการเงื่อนไขเหล่านี้เป็นส่วนหนึ่งของเทมเพลตการกำหนดค่าระยะไกล
OneOfCondition	แสดงเงื่อนไขที่อาจเป็นหนึ่งในหลายๆ ประเภท ระบบจะประมวลผลเฉพาะฟิลด์แรกที่กำหนดไว้เท่านั้น
OrCondition	หมายถึงชุดเงื่อนไขที่ประเมินว่าเป็นจริง หากมีค่าเป็นจริง
PercentCondition	แสดงเงื่อนไขที่เปรียบเทียบเปอร์เซ็นไทล์แบบสุ่มของอินสแตนซ์กับขีดจำกัดที่กำหนด
RemoteConfigCondition	อินเทอร์เฟซที่แสดงเงื่อนไขการกำหนดค่าระยะไกล เงื่อนไขจะกำหนดเป้าหมายกลุ่มผู้ใช้ที่เฉพาะเจาะจง รายการเงื่อนไขเหล่านี้เป็นส่วนหนึ่งของเทมเพลตการกำหนดค่าระยะไกล
RemoteConfigParameters	อินเทอร์เฟซแสดงพารามิเตอร์การกำหนดค่าระยะไกล ต้องมีรายการ defaultValue หรือ conditionalValues เป็นอย่างน้อยเพื่อให้พารามิเตอร์มีผล
RemoteConfigParametersGroup	อินเทอร์เฟซแสดงกลุ่มพารามิเตอร์การกำหนดค่าระยะไกล การจัดกลุ่มพารามิเตอร์มีไว้เพื่อการจัดการเท่านั้น และจะไม่ส่งผลต่อการดึงข้อมูลค่าพารามิเตอร์ฝั่งไคลเอ็นต์
RemoteConfigTemplate	แสดงเทมเพลตไคลเอ็นต์การกำหนดค่าระยะไกล
RemoteConfigUser	อินเทอร์เฟซที่แสดงถึงผู้ใช้การกำหนดค่าระยะไกล
ServerConfig	แสดงการกำหนดค่าที่เกิดขึ้นจากการประเมินเทมเพลตเซิร์ฟเวอร์
ServerTemplate	แสดงการจัดการสถานะสำหรับเทมเพลตเซิร์ฟเวอร์การกำหนดค่าระยะไกล
ServerTemplateData	แสดงข้อมูลในเทมเพลตเซิร์ฟเวอร์การกำหนดค่าระยะไกล
ค่า	รวมค่าพารามิเตอร์ด้วยข้อมูลเมตาและ Getter ที่ปลอดภัยประเภท Getter ประเภทที่ปลอดภัยจะป้องกันลอจิกของแอปพลิเคชันจากการเปลี่ยนแปลงระยะไกลเป็นชื่อและประเภทของพารามิเตอร์
เวอร์ชัน	อินเทอร์เฟซแสดงเวอร์ชันเทมเพลตการกำหนดค่าระยะไกล เอาต์พุตเท่านั้น ยกเว้นคำอธิบายเวอร์ชัน มีข้อมูลเมตาเกี่ยวกับเวอร์ชันเฉพาะของเทมเพลตการกำหนดค่าระยะไกล ช่องทั้งหมดได้รับการตั้งค่าในเวลาที่มีการเผยแพร่เทมเพลตการกำหนดค่าระยะไกลที่ระบุ สามารถระบุช่องคำอธิบายของเวอร์ชันในการเรียกใช้ publishTemplate ครั้ง

พิมพ์ชื่อแทน

พิมพ์ชื่อแทน	คำอธิบาย
DefaultConfig	กำหนดรูปแบบสำหรับค่าพารามิเตอร์เริ่มต้นในแอป
EvaluationContext	แสดงสัญญาณอินพุตสำหรับการประเมินเทมเพลต
ParametersValueType	ประเภทที่แสดงประเภทข้อมูลค่าพารามิเตอร์การกำหนดค่าระยะไกล ค่าเริ่มต้นจะเป็น STRING หากไม่ระบุ
RemoteConfigParametersValue	ประเภทที่แสดงค่าพารามิเตอร์การกำหนดค่าระยะไกล RemoteConfigParameterValue อาจเป็น ExplicitParameterValue หรือ InAppDefaultValue ก็ได้
ServerTemplateDataType	แสดงประเภทเทมเพลตเซิร์ฟเวอร์การกำหนดค่าระยะไกลที่ตั้งค่าได้ใน ServerTemplate ซึ่งอาจเป็นออบเจ็กต์ ServerTemplateData หรือสตริง JSON ของเทมเพลตก็ได้
สีแท็ก	สีที่เชื่อมโยงกับเงื่อนไขสำหรับวัตถุประสงค์ในการแสดงผล
ValueSource	ระบุแหล่งที่มาของค่า "คงที่" แสดงว่าค่านี้กำหนดโดยค่าคงที่คงที่ "ค่าเริ่มต้น" ระบุว่าค่านี้มีการกำหนดโดยการกำหนดค่าเริ่มต้น "รีโมต" ระบุว่าค่านี้กำหนดไว้โดยการกำหนดค่าที่สร้างขึ้นด้วยการประเมินเทมเพลต

getRemoteConfig(แอป)

รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด

สามารถเรียก getRemoteConfig() ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ RemoteConfig ของแอปเริ่มต้น หรือใช้เป็น getRemoteConfig(app) เพื่อเข้าถึงบริการของ RemoteConfig ที่เชื่อมโยงกับแอปที่ต้องการ

ลายเซ็น:

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

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับซึ่งจะส่งคืนบริการ 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);

การกำหนดค่าเริ่มต้น

กำหนดรูปแบบสำหรับค่าพารามิเตอร์เริ่มต้นในแอป

ลายเซ็น:

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

บริบทการประเมินผล

แสดงสัญญาณอินพุตสำหรับการประเมินเทมเพลต

ลายเซ็น:

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

พารามิเตอร์ValueType

ประเภทที่แสดงประเภทข้อมูลค่าพารามิเตอร์การกำหนดค่าระยะไกล ค่าเริ่มต้นจะเป็น 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"	เปอร์เซ็นไทล์เป้าหมายภายในช่วงเวลาที่กำหนดโดยขอบเขตล่างและขอบเขตบน ขอบเขตล่างเป็นขอบเขตพิเศษ (เปิด) และ micro_percent_range_upper_bound เป็นขอบเขตแบบรวม (ปิด) เงื่อนไขที่ใช้โอเปอเรเตอร์นี้ต้องระบุ microPercentRange
มากกว่า	"GREATER_THAN"	เปอร์เซ็นไทล์เป้าหมายมากกว่าเปอร์เซ็นต์เป้าหมาย เงื่อนไขที่ใช้โอเปอเรเตอร์นี้ต้องระบุ microPercent
น้อยกว่าหรือเท่ากับ	"LESS_OR_EQUAL"	เปอร์เซ็นไทล์เป้าหมายน้อยกว่าหรือเท่ากับเปอร์เซ็นต์เป้าหมาย เงื่อนไขที่ใช้โอเปอเรเตอร์นี้ต้องระบุ microPercent
ไม่ทราบ	"UNKNOWN"	กรณีข้อผิดพลาดที่เกิดขึ้นทั้งหมด