Firebase is back at Google I/O on May 14! Register now.

Trang này được dịch bởi Cloud Translation API.

firebase-admin package

API được đặt tên trong vùng chứa tên của Firebase (cũ).

Hàm

Chức năng	Mô tả
ứng dụng(tên)
appCheck(ứng dụng)	Lấy dịch vụ AppCheck cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.appCheck()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `AppCheck` của ứng dụng mặc định hoặc `admin.appCheck(app)` để truy cập vào dịch vụ `AppCheck` liên kết với một ứng dụng cụ thể.
auth(ứng dụng)	Nhận dịch vụ Auth cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.auth()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng `admin.auth(app)` để truy cập vào dịch vụ Auth được liên kết với một ứng dụng cụ thể.
cơ sở dữ liệu(ứng dụng)	Lấy dịch vụ Database (Cơ sở dữ liệu) cho ứng dụng mặc định hoặc một ứng dụng nhất định.`admin.database()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `Database` của ứng dụng mặc định hoặc `admin.database(app)` để truy cập vào dịch vụ `Database` liên kết với một ứng dụng cụ thể.`admin.database` cũng là một không gian tên có thể dùng để truy cập các hằng số và phương thức chung liên kết với dịch vụ `Database`.
firestore(ứng dụng)
initializeApp(các lựa chọn, tên)
lượt cài đặt(ứng dụng)	Nhận dịch vụ Installations (Cài đặt) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.installations()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ Installations (Cài đặt) của ứng dụng mặc định hoặc `admin.installations(app)` để truy cập vào dịch vụ Cài đặt được liên kết với một ứng dụng cụ thể.
instanceId(ứng dụng)	Lấy dịch vụ InstanceId cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.instanceId()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `InstanceId` của ứng dụng mặc định hoặc `admin.instanceId(app)` để truy cập vào dịch vụ `InstanceId` liên kết với một ứng dụng cụ thể.
máy học(ứng dụng)	Lấy dịch vụ Machine Learning cho ứng dụng mặc định hoặc một ứng dụng nhất định.`admin.machineLearning()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `MachineLearning` của ứng dụng mặc định hoặc dưới dạng `admin.machineLearning(app)` để truy cập vào dịch vụ `MachineLearning` liên kết với một ứng dụng cụ thể.
nhắn tin(ứng dụng)	Lấy dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng nhất định.`admin.messaging()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `Messaging` của ứng dụng mặc định hoặc dưới dạng `admin.messaging(app)` để truy cập vào dịch vụ `Messaging` được liên kết với một ứng dụng cụ thể.
ProjectQuản lý(ứng dụng)	Lấy dịch vụ ProjectManagement (Quản lý dự án) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.projectManagement()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `ProjectManagement` của ứng dụng mặc định, hoặc dưới dạng `admin.projectManagement(app)` để truy cập vào dịch vụ `ProjectManagement` liên kết với một ứng dụng cụ thể.
remoteConfig(ứng dụng)	Lấy dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.remoteConfig()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `RemoteConfig` của ứng dụng mặc định hoặc `admin.remoteConfig(app)` để truy cập vào dịch vụ `RemoteConfig` liên kết với một ứng dụng cụ thể.
securityRules(ứng dụng)	Nhận dịch vụ SecurityRules cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.securityRules()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ SecurityRules của ứng dụng mặc định hoặc dưới dạng `admin.securityRules(app)` để truy cập vào dịch vụ SecurityRules được liên kết với một ứng dụng cụ thể.
bộ nhớ(ứng dụng)	Lấy dịch vụ Storage (Bộ nhớ) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.`admin.storage()` có thể được gọi mà không cần đối số để truy cập vào dịch vụ `Storage` của ứng dụng mặc định hoặc `admin.storage(app)` để truy cập dịch vụ `Storage` liên kết với một ứng dụng cụ thể.

Giao diện

Giao diện	Mô tả
AppOptions	Các tuỳ chọn có sẵn để chuyển đến initializeApp().
Lỗi FirebaseArrayIndex	Loại tổng hợp bao gồm cả đối tượng `FirebaseError` và chỉ mục có thể dùng để lấy mục bị lỗi.
Lỗi Firebase	`FirebaseError` là lớp con của đối tượng `Error` JavaScript chuẩn. Ngoài một chuỗi thông báo và dấu vết ngăn xếp, tệp này còn chứa một mã chuỗi.
GoogleOAuthAccessToken	Giao diện cho mã truy cập Google OAuth 2.0.
Tài khoản dịch vụ

Không gian tên

Không gian tên	Mô tả
ứng dụng
kiểm tra ứng dụng
xác thực
thông tin xác thực
cơ sở dữ liệu
cửa hàng cứu hoả
lượt cài đặt
InstanceId
máy học
nhắn tin
quản lý dự án
remoteConfig
securityRules (Quy tắc bảo mật)
bộ nhớ

Biến

Biến	Mô tả
ứng dụng
SDK_VERSION

ứng dụng(tên)

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
name	chuỗi

Trường hợp trả lại hàng:

app.App

appCheck(ứng dụng)

Lấy dịch vụ AppCheck cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.appCheck() mà không có đối số để truy cập vào dịch vụ AppCheck của ứng dụng mặc định hoặc dưới dạng admin.appCheck(app) để truy cập vào dịch vụ AppCheck liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc trả về dịch vụ `AppCheck`. Nếu không được cung cấp, dịch vụ `AppCheck` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

appCheck.AppCheck

Dịch vụ AppCheck mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ AppCheck liên kết với ứng dụng được cung cấp.

Ví dụ 1

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

Ví dụ 2

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

auth(ứng dụng)

Lấy dịch vụ Auth cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.auth() mà không có đối số để truy cập vào dịch vụ Auth của ứng dụng mặc định hoặc dưới dạng admin.auth(app) để truy cập vào dịch vụ Auth được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng

Trường hợp trả lại hàng:

auth.Auth

Ví dụ 1

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

Ví dụ 2

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

cơ sở dữ liệu(ứng dụng)

Lấy dịch vụ Database (Cơ sở dữ liệu) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.database() mà không có đối số để truy cập vào dịch vụ Database của ứng dụng mặc định hoặc dưới dạng admin.database(app) để truy cập vào dịch vụ Database liên kết với một ứng dụng cụ thể.

admin.database cũng là một không gian tên có thể dùng để truy cập các hằng số và phương thức chung liên kết với dịch vụ Database.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng

Trường hợp trả lại hàng:

database.Database

Dịch vụ Database mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Database liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

Firestore(ứng dụng)

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng

Trường hợp trả lại hàng:

_firestore.Firestore

LaunchApp(tuỳ chọn, tên)

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tuỳ chọn	AppOptions
name	chuỗi

Trường hợp trả lại hàng:

app.App

lượt cài đặt(ứng dụng)

Nhận dịch vụ Installations (Cài đặt) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.installations() mà không có đối số để truy cập vào dịch vụ Installations (Cài đặt) của ứng dụng mặc định hoặc admin.installations(app) để truy cập vào dịch vụ Installations (Cài đặt) được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc có dịch vụ `Installations` cần trả về. Nếu không được cung cấp, dịch vụ `Installations` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

installs.Installations

Dịch vụ Installations mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Installations liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

exampleId(ứng dụng)

Lấy dịch vụ InstanceId cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.instanceId() mà không có đối số để truy cập vào dịch vụ InstanceId của ứng dụng mặc định hoặc dưới dạng admin.instanceId(app) để truy cập vào dịch vụ InstanceId liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc có dịch vụ `InstanceId` cần trả về. Nếu không được cung cấp, dịch vụ `InstanceId` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

InstanceId.InstanceId

Dịch vụ InstanceId mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ InstanceId liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

học máy(ứng dụng)

Lấy dịch vụ Machine Learning cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.machineLearning() mà không có đối số để truy cập vào dịch vụ MachineLearning của ứng dụng mặc định hoặc dưới dạng admin.machineLearning(app) để truy cập vào dịch vụ MachineLearning liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc có dịch vụ `MachineLearning` cần trả về. Nếu không được cung cấp, dịch vụ `MachineLearning` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

Machine Learning.MachineML

Dịch vụ MachineLearning mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ MachineLearning liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

nhắn tin(ứng dụng)

Nhận dịch vụ Nhắn tin cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.messaging() mà không có đối số để truy cập vào dịch vụ Messaging của ứng dụng mặc định hoặc dưới dạng admin.messaging(app) để truy cập vào dịch vụ Messaging liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc có dịch vụ `Messaging` cần trả về. Nếu không được cung cấp, dịch vụ `Messaging` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

Nhắn tin.Nhắn tin

Dịch vụ Messaging mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ Messaging liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

Quản lý dự án(ứng dụng)

Lấy dịch vụ ProjectManagement (Quản lý dự án) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.projectManagement() mà không có đối số để truy cập vào dịch vụ ProjectManagement của ứng dụng mặc định hoặc admin.projectManagement(app) để truy cập vào dịch vụ ProjectManagement liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc có dịch vụ `ProjectManagement` cần trả về. Nếu không được cung cấp, dịch vụ `ProjectManagement` mặc định sẽ được trả về. *

Trường hợp trả lại hàng:

projectManagement.ProjectManagement

Dịch vụ ProjectManagement mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ ProjectManagement liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

Cấu hình từ xa(ứng dụng)

Lấy dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.remoteConfig() mà không có đối số để truy cập vào dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng admin.remoteConfig(app) để truy cập vào dịch vụ RemoteConfig liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc trả về dịch vụ `RemoteConfig`. Nếu không được cung cấp, dịch vụ `RemoteConfig` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

remoteConfig.RemoteConfig

Dịch vụ RemoteConfig mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ RemoteConfig liên kết với ứng dụng được cung cấp.

Ví dụ 1

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

Ví dụ 2

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

SecurityRules(ứng dụng)

Nhận dịch vụ SecurityRules (Quy tắc bảo mật) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.securityRules() mà không có đối số để truy cập vào dịch vụ SecurityRules của ứng dụng mặc định hoặc admin.securityRules(app) để truy cập vào dịch vụ SecurityRules được liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng	Ứng dụng không bắt buộc để trả về dịch vụ `SecurityRules`. Nếu không được cung cấp, dịch vụ `SecurityRules` mặc định sẽ được trả về.

Trường hợp trả lại hàng:

securityRules.SecurityRules

Dịch vụ SecurityRules mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ SecurityRules liên kết với ứng dụng được cung cấp.

Ví dụ 1

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

Ví dụ 2

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

bộ nhớ(ứng dụng)

Lấy dịch vụ Storage (Bộ nhớ) cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi admin.storage() mà không có đối số để truy cập vào dịch vụ Storage của ứng dụng mặc định hoặc dưới dạng admin.storage(app) để truy cập vào dịch vụ Storage liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng

Trường hợp trả lại hàng:

storage.Storage

Ví dụ 1

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

Ví dụ 2

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

ứng dụng

Chữ ký:

apps: (app.App | null)[]

PHIÊN_BẢN_SDK

Chữ ký:

SDK_VERSION: string