firebase-admin package

Namespaced API ของ Firebase (เดิม)

ฟังก์ชัน

ฟังก์ชัน	คำอธิบาย
แอป(name)
appCheck(แอป)	รับบริการ AppCheck สำหรับแอปเริ่มต้นหรือแอปที่กำหนด จะเรียกใช้ admin.appCheck() ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ AppCheck ของแอปเริ่มต้น หรือใช้ admin.appCheck(app) เพื่อเข้าถึงบริการ AppCheck ที่เชื่อมโยงกับแอปใดแอปหนึ่ง
auth(แอป)	รับบริการ Auth สำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.auth() อาจเรียกใช้ admin.auth() โดยไม่ใช้อาร์กิวเมนต์เพื่อเข้าถึงบริการ Auth ของแอปเริ่มต้น หรือใช้ admin.auth(app) เพื่อเข้าถึงบริการ Auth ที่เชื่อมโยงกับแอปใดแอปหนึ่งได้
ฐานข้อมูล(แอป)	รับบริการฐานข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.database() เรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Database ของแอปเริ่มต้น หรือใช้ admin.database(app) เพื่อเข้าถึงบริการ Database ที่เชื่อมโยงกับแอปหนึ่งๆ admin.database เป็นเนมสเปซที่ใช้เข้าถึงค่าคงที่และเมธอดสากลที่เชื่อมโยงกับบริการ Database ได้ด้วย
firestore(แอป)
initializeApp(ตัวเลือก, ชื่อ)
จำนวนการติดตั้ง(แอป)	รับบริการการติดตั้งสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.installations() อาจเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการการติดตั้งของแอปเริ่มต้น หรือใช้ admin.installations(app) เพื่อเข้าถึงบริการการติดตั้งที่เชื่อมโยงกับแอปใดแอปหนึ่ง
instanceId(แอป)	รับบริการ InstanceId สำหรับแอปเริ่มต้นหรือแอปที่กำหนด จะเรียกใช้ admin.instanceId() ได้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ InstanceId ของแอปเริ่มต้น หรือใช้ admin.instanceId(app) เพื่อเข้าถึงบริการ InstanceId ที่เชื่อมโยงกับแอปที่ต้องการ
machineLearning(แอป)	รับบริการ MachineLearning สำหรับแอปเริ่มต้นหรือแอปที่ระบุ admin.machineLearning() เรียกใช้ได้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ MachineLearning ของแอปเริ่มต้น หรือใช้ admin.machineLearning(app) เพื่อเข้าถึงบริการ MachineLearning ที่เชื่อมโยงกับแอปใดแอปหนึ่ง
การรับส่งข้อความ(แอป)	รับบริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.messaging() อาจเรียกใช้ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ Messaging ของแอปเริ่มต้น หรือใช้ admin.messaging(app) เพื่อเข้าถึงบริการ Messaging ที่เชื่อมโยงกับแอปใดแอปหนึ่ง
การจัดการโปรเจ็กต์(แอป)	รับบริการการจัดการโปรเจ็กต์สำหรับแอปเริ่มต้นหรือแอปที่กำหนด จะเรียกใช้ admin.projectManagement() ได้โดยไม่ต้องมีอาร์กิวเมนต์เพื่อเข้าถึงบริการ ProjectManagement ของแอปเริ่มต้น หรือใช้ admin.projectManagement(app) เพื่อเข้าถึงบริการ ProjectManagement ที่เชื่อมโยงกับแอปใดแอปหนึ่ง
remoteConfig(แอป)	รับบริการ RemoteConfig สำหรับแอปเริ่มต้นหรือแอปที่กำหนด จะเรียกใช้ admin.remoteConfig() โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ RemoteConfig ของแอปเริ่มต้น หรือใช้ admin.remoteConfig(app) เพื่อเข้าถึงบริการ RemoteConfig ที่เชื่อมโยงกับแอปที่ต้องการได้
securityRule(แอป)	รับบริการ SecurityRules สำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.securityRules() อาจเรียกใช้โดยไม่มีอาร์กิวเมนต์เพื่อเข้าถึงบริการ SecurityRules ของแอปเริ่มต้น หรือใช้เป็น admin.securityRules(app) เพื่อเข้าถึงบริการ SecurityRules ที่เชื่อมโยงกับแอปหนึ่งๆ
พื้นที่เก็บข้อมูล(แอป)	รับบริการพื้นที่เก็บข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่กำหนด admin.storage() จะเรียกใช้บริการ Storage ของแอปเริ่มต้นได้โดยไม่ต้องมีอาร์กิวเมนต์ หรืออาจเรียกใช้ admin.storage(app) เพื่อเข้าถึงบริการ Storage ที่เชื่อมโยงกับแอปที่เจาะจงก็ได้

อินเทอร์เฟซ

อินเทอร์เฟซ	คำอธิบาย
ตัวเลือกแอป	ตัวเลือกที่พร้อมใช้งานเพื่อส่งไปยัง initializeApp()
FirebaseArrayIndexError	ประเภทผสมซึ่งมีทั้งออบเจ็กต์ FirebaseError และดัชนีที่ใช้เพื่อรับรายการที่มีข้อผิดพลาดได้
ข้อผิดพลาด Firebase	FirebaseError เป็นคลาสย่อยของออบเจ็กต์ JavaScript Error มาตรฐาน นอกเหนือจากสตริงข้อความและสแต็กเทรซแล้ว ยังมีโค้ดสตริงด้วย
GoogleOAuthAccessToken	อินเทอร์เฟซสำหรับโทเค็นเพื่อการเข้าถึงของ Google OAuth 2.0
บัญชีบริการ

เนมสเปซ

เนมสเปซ	คำอธิบาย
แอป
appCheck
การตรวจสอบสิทธิ์
ข้อมูลเข้าสู่ระบบ
ฐานข้อมูล
Firestore
จำนวนการติดตั้ง
รหัสอินสแตนซ์
machineLearning
การรับส่งข้อความ
การจัดการโปรเจ็กต์
remoteConfig
กฎความปลอดภัย
พื้นที่เก็บข้อมูล

ตัวแปร

ตัวแปร	คำอธิบาย
แอป
SDK_VERSION

แอป(ชื่อ)

ลายเซ็น:

export declare function app(name?: string): app.App;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
name	สตริง

การคืนสินค้า:

app.App

appCheck(แอป)

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

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

ลายเซ็น:

export declare function appCheck(app?: App): appCheck.AppCheck;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับซึ่งจะส่งคืนบริการ AppCheck หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ AppCheck เริ่มต้น

การคืนสินค้า:

appCheck.AppCheck

บริการ AppCheck เริ่มต้นหากไม่มีการให้แอป หรือบริการ AppCheck ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();

ตัวอย่างที่ 2

// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);

auth(แอป)

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

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

ลายเซ็น:

export declare function auth(app?: App): auth.Auth;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป

การคืนสินค้า:

auth.Auth

ตัวอย่างที่ 1

// Get the Auth service for the default app
var defaultAuth = admin.auth();

ตัวอย่างที่ 2

// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);

ฐานข้อมูล(แอป)

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

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

admin.database ยังเป็นเนมสเปซที่ใช้เข้าถึงค่าคงที่สากลและเมธอดที่เชื่อมโยงกับบริการ Database ได้ด้วย

ลายเซ็น:

export declare function database(app?: App): database.Database;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป

การคืนสินค้า:

database.Database

บริการ Database เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ Database ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the Database service for the default app
var defaultDatabase = admin.database();

ตัวอย่างที่ 2

// Get the Database service for a specific app
var otherDatabase = admin.database(app);

Firestore(แอป)

ลายเซ็น:

export declare function firestore(app?: App): _firestore.Firestore;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป

การคืนสินค้า:

_firestore.Firestore

defaultizeApp(ตัวเลือก ชื่อ)

ลายเซ็น:

export declare function initializeApp(options?: AppOptions, name?: string): app.App;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
ตัวเลือก	ตัวเลือกแอป
name	สตริง

การคืนสินค้า:

app.App

จำนวนการติดตั้ง(แอป)

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

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

ลายเซ็น:

export declare function installations(app?: App): installations.Installations;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับที่มีบริการ Installations ที่จะส่งคืน หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ Installations เริ่มต้น

การคืนสินค้า:

installations.การติดตั้ง

บริการ Installations เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ Installations ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the Installations service for the default app
var defaultInstallations = admin.installations();

ตัวอย่างที่ 2

// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);

รหัสอินสแตนซ์(แอป)

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

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

ลายเซ็น:

export declare function instanceId(app?: App): instanceId.InstanceId;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับที่มีบริการ InstanceId ที่จะส่งคืน หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ InstanceId เริ่มต้น

การคืนสินค้า:

instanceId.InstanceId

บริการ InstanceId เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ InstanceId ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();

ตัวอย่างที่ 2

// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);

MachineLearning(แอป)

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

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

ลายเซ็น:

export declare function machineLearning(app?: App): machineLearning.MachineLearning;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับที่มีบริการ MachineLearning ที่จะส่งคืน หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ MachineLearning เริ่มต้น

การคืนสินค้า:

machineLearning.MachineLearning

บริการ MachineLearning เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ MachineLearning ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();

ตัวอย่างที่ 2

// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);

การรับส่งข้อความ(แอป)

ใช้บริการการรับส่งข้อความสำหรับแอปเริ่มต้นหรือแอปที่กำหนด

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

ลายเซ็น:

export declare function messaging(app?: App): messaging.Messaging;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับที่มีบริการ Messaging ที่จะส่งคืน หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ Messaging เริ่มต้น

การคืนสินค้า:

การส่งข้อความ

บริการ Messaging เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ Messaging ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();

ตัวอย่างที่ 2

// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);

การจัดการโปรเจ็กต์(แอป)

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

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

ลายเซ็น:

export declare function projectManagement(app?: App): projectManagement.ProjectManagement;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับที่มีบริการ ProjectManagement ที่จะส่งคืน หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ ProjectManagement เริ่มต้น *

การคืนสินค้า:

projectManagement.ProjectManagement

บริการ ProjectManagement เริ่มต้นหากไม่ได้ให้แอปไว้ หรือบริการ ProjectManagement ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();

ตัวอย่างที่ 2

// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);

RemoteConfig(แอป)

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

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

ลายเซ็น:

export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับซึ่งจะส่งคืนบริการ RemoteConfig หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ RemoteConfig เริ่มต้น

การคืนสินค้า:

remoteConfig.RemoteConfig

บริการ RemoteConfig เริ่มต้นหากไม่มีการให้แอป หรือบริการ RemoteConfig ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();

ตัวอย่างที่ 2

// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);

กฎความปลอดภัย(แอป)

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

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

ลายเซ็น:

export declare function securityRules(app?: App): securityRules.SecurityRules;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป	แอปที่ไม่บังคับสำหรับแสดงบริการ SecurityRules หากไม่ได้ระบุไว้ ระบบจะแสดงผลบริการ SecurityRules เริ่มต้น

การคืนสินค้า:

securityRules.SecurityRules

บริการ SecurityRules เริ่มต้นหากไม่มีการให้แอป หรือบริการ SecurityRules ที่เชื่อมโยงกับแอปที่ระบุ

ตัวอย่างที่ 1

// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();

ตัวอย่างที่ 2

// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);

พื้นที่เก็บข้อมูล(แอป)

รับบริการพื้นที่เก็บข้อมูลสำหรับแอปเริ่มต้นหรือแอปที่กำหนด

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

ลายเซ็น:

export declare function storage(app?: App): storage.Storage;

พารามิเตอร์

พารามิเตอร์	ประเภท	คำอธิบาย
แอป	แอป

การคืนสินค้า:

storage.Storage

ตัวอย่างที่ 1

// Get the Storage service for the default app
var defaultStorage = admin.storage();

ตัวอย่างที่ 2

// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);

แอป

ลายเซ็น:

apps: (app.App | null)[]

SDK_VERSION

ลายเซ็น:

SDK_VERSION: string