firebase-admin.remote-config package

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

ฟังก์ชัน

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

คลาส

ชั้น	คำอธิบาย
การกำหนดค่าระยะไกล	อินเทอร์เฟซบริการ RemoteConfig ของ Firebase

การแจกแจง

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

อินเทอร์เฟซ

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

ประเภทชื่อแทน

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

getRemoteConfig(แอป)

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

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

ลายเซ็น:

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);

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

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

ลายเซ็น:

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

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

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

ลายเซ็น:

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

ประเภทค่าพารามิเตอร์

ประเภทที่แสดงประเภทข้อมูลค่าพารามิเตอร์การกำหนดค่าระยะไกล ค่าเริ่มต้นคือ STRING หากไม่ระบุ

ลายเซ็น:

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

RemoteConfigParametersValue

ประเภทที่แสดงค่าพารามิเตอร์การกำหนดค่าระยะไกล RemoteConfigParameterValue อาจเป็น ExplicitParameterValue หรือ InAppDefaultValue

ลายเซ็น:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ประเภทข้อมูลเทมเพลตเซิร์ฟเวอร์

แสดงประเภทเทมเพลตเซิร์ฟเวอร์การกำหนดค่าระยะไกลที่ตั้งค่าได้ใน ServerTemplate โดยอาจเป็นออบเจ็กต์ ServerTemplateData หรือสตริง JSON ของเทมเพลต

ลายเซ็น:

export type ServerTemplateDataType = ServerTemplateData | string;

สีแท็ก

สีที่เชื่อมโยงกับเงื่อนไขเพื่อการแสดงผล

ลายเซ็น:

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

แหล่งที่มาของค่า

ระบุแหล่งที่มาของค่า

• "static" หมายถึงค่าที่กำหนดโดยค่าคงที่คงที่
• "default" หมายถึงค่าที่กำหนดโดยการกำหนดค่าเริ่มต้น
• "remote" บ่งชี้ว่าค่าที่กำหนดโดยการกำหนดค่าซึ่งสร้างโดยการประเมินเทมเพลต

ลายเซ็น:

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"	กรณีข้อผิดพลาดแบบรับทั้งหมด