Watch demos on how to build & run AI-powered apps with Firebase at Demo Day '24. Watch now.

Halaman ini diterjemahkan oleh Cloud Translation API.

firebase-admin package

API dengan namespace Firebase (lama).

Functions

Fungsi	Deskripsi
aplikasi(nama)
appCheck(aplikasi)	Mendapatkan layanan AppCheck untuk aplikasi default atau aplikasi tertentu.`admin.appCheck()` dapat dipanggil tanpa argumen untuk mengakses layanan `AppCheck` aplikasi default atau sebagai `admin.appCheck(app)` untuk mengakses layanan `AppCheck` yang terkait dengan aplikasi tertentu.
auth(aplikasi)	Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu.`admin.auth()` dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai `admin.auth(app)` untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu.
database(aplikasi)	Mendapatkan layanan Database untuk aplikasi default atau aplikasi tertentu.`admin.database()` dapat dipanggil tanpa argumen untuk mengakses layanan `Database` aplikasi default atau sebagai `admin.database(app)` untuk mengakses layanan `Database` yang terkait dengan aplikasi tertentu.`admin.database` juga merupakan namespace yang dapat digunakan untuk mengakses konstanta dan metode global yang terkait dengan layanan `Database`.
firestore(app)
inisialisasiApp(opsi, nama)
penginstalan(aplikasi)	Mendapatkan layanan Penginstalan untuk aplikasi default atau aplikasi tertentu.`admin.installations()` dapat dipanggil tanpa argumen untuk mengakses layanan Penginstalan aplikasi default atau sebagai `admin.installations(app)` untuk mengakses layanan Penginstalan yang terkait dengan aplikasi tertentu.
instanceId(aplikasi)	Mendapatkan layanan InstanceId untuk aplikasi default atau aplikasi tertentu.`admin.instanceId()` dapat dipanggil tanpa argumen untuk mengakses layanan `InstanceId` aplikasi default, atau sebagai `admin.instanceId(app)` untuk mengakses layanan `InstanceId` yang terkait dengan aplikasi tertentu.
machineLearning(aplikasi)	Mendapatkan layanan MachineLearning untuk aplikasi default atau aplikasi tertentu.`admin.machineLearning()` dapat dipanggil tanpa argumen untuk mengakses layanan `MachineLearning` aplikasi default atau sebagai `admin.machineLearning(app)` untuk mengakses layanan `MachineLearning` yang terkait dengan aplikasi tertentu.
pesan(aplikasi)	Mendapatkan layanan Messaging untuk aplikasi default atau aplikasi tertentu.`admin.messaging()` dapat dipanggil tanpa argumen untuk mengakses layanan `Messaging` aplikasi default atau sebagai `admin.messaging(app)` untuk mengakses layanan `Messaging` yang terkait dengan aplikasi tertentu.
projectManagement(aplikasi)	Mendapatkan layanan ProjectManagement untuk aplikasi default atau aplikasi tertentu.`admin.projectManagement()` dapat dipanggil tanpa argumen untuk mengakses layanan `ProjectManagement` aplikasi default, atau sebagai `admin.projectManagement(app)` untuk mengakses layanan `ProjectManagement` yang terkait dengan aplikasi tertentu.
remoteConfig(aplikasi)	Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu.`admin.remoteConfig()` dapat dipanggil tanpa argumen untuk mengakses layanan `RemoteConfig` aplikasi default atau sebagai `admin.remoteConfig(app)` untuk mengakses layanan `RemoteConfig` yang terkait dengan aplikasi tertentu.
securityRules(aplikasi)	Mendapatkan layanan SecurityRules untuk aplikasi default atau aplikasi tertentu.`admin.securityRules()` dapat dipanggil tanpa argumen untuk mengakses layanan SecurityRules aplikasi default, atau sebagai `admin.securityRules(app)` untuk mengakses layanan SecurityRules yang terkait dengan aplikasi tertentu.
storage(aplikasi)	Mendapatkan layanan Storage untuk aplikasi default atau aplikasi tertentu.`admin.storage()` dapat dipanggil tanpa argumen untuk mengakses layanan `Storage` aplikasi default atau sebagai `admin.storage(app)` untuk mengakses layanan `Storage` yang terkait dengan aplikasi tertentu.

Antarmuka

Antarmuka	Deskripsi
AppOptions	Opsi yang tersedia untuk diteruskan ke InitializeApp().
FirebaseArrayIndexError	Jenis komposit yang mencakup objek `FirebaseError` dan indeks yang dapat digunakan untuk mendapatkan item yang mengalami error.
FirebaseError	`FirebaseError` adalah subclass dari objek `Error` JavaScript standar. Selain string pesan dan pelacakan tumpukan, kode ini juga berisi kode string.
GoogleOAuthAccessToken	Antarmuka untuk token akses Google OAuth 2.0.
AkunLayanan

Namespace

Namespace	Deskripsi
app
appCheck
autentikasi
kredensial
database
firestore
penginstalan
IDinstance
machineLearning
pesan
Manajemenproyek
remoteConfig
securityRules
penyimpanan

Variabel

Variabel	Deskripsi
aplikasi
Versi_SDK

aplikasi(nama)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
name	string

Hasil:

aplikasi.Aplikasi

appCheck(aplikasi)

Mendapatkan layanan AppCheck untuk aplikasi default atau aplikasi tertentu.

admin.appCheck() dapat dipanggil tanpa argumen untuk mengakses layanan AppCheck aplikasi default atau sebagai admin.appCheck(app) untuk mengakses layanan AppCheck yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang akan menampilkan layanan `AppCheck`. Jika tidak diberikan, layanan `AppCheck` default akan ditampilkan.

Hasil:

appCheck.AppCheck

Layanan AppCheck default jika tidak ada aplikasi yang disediakan, atau layanan AppCheck yang dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

auth(aplikasi)

Mendapatkan layanan Auth untuk aplikasi default atau aplikasi tertentu.

admin.auth() dapat dipanggil tanpa argumen untuk mengakses layanan Auth aplikasi default atau sebagai admin.auth(app) untuk mengakses layanan Auth yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi

Hasil:

auth.Auth

Contoh 1

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

Contoh 2

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

database(aplikasi)

Mendapatkan layanan Database untuk aplikasi default atau aplikasi tertentu.

admin.database() dapat dipanggil tanpa argumen untuk mengakses layanan Database aplikasi default atau sebagai admin.database(app) untuk mengakses layanan Database yang terkait dengan aplikasi tertentu.

admin.database juga merupakan namespace yang dapat digunakan untuk mengakses konstanta dan metode global yang terkait dengan layanan Database.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi

Hasil:

database.Database

Layanan Database default jika tidak ada aplikasi yang disediakan atau layanan Database dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

firestore(aplikasi)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi

Hasil:

_firestore.Firestore

inisialisasiApp(opsi, nama)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
opsi	AppOptions
name	string

Hasil:

aplikasi.Aplikasi

penginstalan(aplikasi)

Mendapatkan layanan Penginstalan untuk aplikasi default atau aplikasi tertentu.

admin.installations() dapat dipanggil tanpa argumen untuk mengakses layanan Penginstalan aplikasi default atau sebagai admin.installations(app) untuk mengakses layanan Penginstalan yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang layanan `Installations`-nya akan ditampilkan. Jika tidak diberikan, layanan `Installations` default akan ditampilkan.

Hasil:

penginstalan.Penginstalan

Layanan Installations default jika tidak ada aplikasi yang disediakan atau layanan Installations dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

instanceId(aplikasi)

Mendapatkan layanan InstanceId untuk aplikasi default atau aplikasi tertentu.

admin.instanceId() dapat dipanggil tanpa argumen untuk mengakses layanan InstanceId aplikasi default atau sebagai admin.instanceId(app) untuk mengakses layanan InstanceId yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang layanan `InstanceId`-nya akan ditampilkan. Jika tidak diberikan, layanan `InstanceId` default akan ditampilkan.

Hasil:

instanceId.InstanceId

Layanan InstanceId default jika tidak ada aplikasi yang disediakan atau layanan InstanceId dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

machineLearning(aplikasi)

Mendapatkan layanan MachineLearning untuk aplikasi default atau aplikasi tertentu.

admin.machineLearning() dapat dipanggil tanpa argumen untuk mengakses layanan MachineLearning aplikasi default atau sebagai admin.machineLearning(app) untuk mengakses layanan MachineLearning yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang layanan `MachineLearning`-nya akan ditampilkan. Jika tidak diberikan, layanan `MachineLearning` default akan ditampilkan.

Hasil:

machineLearning.MachineLearning

Layanan MachineLearning default jika tidak ada aplikasi yang disediakan atau layanan MachineLearning dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

pesan(aplikasi)

Mendapatkan layanan Messaging untuk aplikasi default atau aplikasi tertentu.

admin.messaging() dapat dipanggil tanpa argumen untuk mengakses layanan Messaging aplikasi default atau sebagai admin.messaging(app) untuk mengakses layanan Messaging yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang layanan `Messaging`-nya akan ditampilkan. Jika tidak diberikan, layanan `Messaging` default akan ditampilkan.

Hasil:

Messaging.Messaging

Layanan Messaging default jika tidak ada aplikasi yang disediakan atau layanan Messaging dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

projectManagement(aplikasi)

Mendapatkan layanan ProjectManagement untuk aplikasi default atau aplikasi tertentu.

admin.projectManagement() dapat dipanggil tanpa argumen untuk mengakses layanan ProjectManagement aplikasi default, atau sebagai admin.projectManagement(app) untuk mengakses layanan ProjectManagement yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang layanan `ProjectManagement`-nya akan ditampilkan. Jika tidak diberikan, layanan `ProjectManagement` default akan ditampilkan. *

Hasil:

projectManagement.ProjectManagement

Layanan ProjectManagement default jika tidak ada aplikasi yang disediakan atau layanan ProjectManagement dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

remoteConfig(aplikasi)

Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu.

admin.remoteConfig() dapat dipanggil tanpa argumen untuk mengakses layanan RemoteConfig aplikasi default atau sebagai admin.remoteConfig(app) untuk mengakses layanan RemoteConfig yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional yang akan menampilkan layanan `RemoteConfig`. Jika tidak diberikan, layanan `RemoteConfig` default akan ditampilkan.

Hasil:

remoteConfig.RemoteConfig

Layanan RemoteConfig default jika tidak ada aplikasi yang disediakan, atau layanan RemoteConfig yang dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

securityRules(aplikasi)

Mendapatkan layanan SecurityRules untuk aplikasi default atau aplikasi tertentu.

admin.securityRules() dapat dipanggil tanpa argumen untuk mengakses layanan SecurityRules aplikasi default, atau sebagai admin.securityRules(app) untuk mengakses layanan SecurityRules yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi	Aplikasi opsional tempat layanan `SecurityRules` ditampilkan. Jika tidak diberikan, layanan `SecurityRules` default akan ditampilkan.

Hasil:

securityRules.SecurityRules

Layanan SecurityRules default jika tidak ada aplikasi yang disediakan, atau layanan SecurityRules yang dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

penyimpanan(aplikasi)

Mendapatkan layanan Storage untuk aplikasi default atau aplikasi tertentu.

admin.storage() dapat dipanggil tanpa argumen untuk mengakses layanan Storage aplikasi default atau sebagai admin.storage(app) untuk mengakses layanan Storage yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
aplikasi	Aplikasi

Hasil:

storage.Storage

Contoh 1

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

Contoh 2

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

aplikasi

Tanda Tangan:

apps: (app.App | null)[]

SDK_VERSION

Tanda Tangan:

SDK_VERSION: string