REST Resource: projects.webApps

Resource: WebApp

Detail Aplikasi Firebase untuk web.

Representasi JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
Kolom
name

string

Nama resource WebApp, dalam format:

projects/PROJECT_IDENTIFIER/webApps/APP_ID

  • PROJECT_IDENTIFIER: ProjectNumber (direkomendasikan) Project induk atau ProjectId-nya. Pelajari lebih lanjut cara menggunakan ID project dalam standar AIP 2510 Google.
    Perhatikan bahwa nilai untuk PROJECT_IDENTIFIER dalam isi respons adalah ProjectId.
  • APP_ID: ID unik global yang ditetapkan Firebase untuk Aplikasi (lihat appId).
appId

string

Hanya output. Tidak dapat diubah. ID unik global yang ditetapkan Firebase untuk WebApp.

ID ini harus diperlakukan sebagai token buram karena format data tidak ditentukan.

displayName

string

Nama tampilan yang ditetapkan pengguna untuk WebApp.

projectId

string

Hanya output. Tidak dapat diubah. ID unik yang ditetapkan pengguna dari induk FirebaseProject untuk WebApp.

appUrls[]

string

URL tempat WebApp dihosting.

webId
(deprecated)

string

Hanya output. Tidak dapat diubah. ID unik yang ditetapkan Firebase untuk WebApp.

ID ini hanya digunakan untuk mengisi nilai namespace untuk WebApp. Untuk sebagian besar kasus penggunaan, gunakan appId untuk mengidentifikasi atau mereferensikan Aplikasi. Nilai webId hanya unik dalam FirebaseProject dan Aplikasi yang terkait.

apiKeyId

string

ID unik global (UID) yang ditetapkan Google untuk kunci Firebase API yang terkait dengan WebApp.

Perlu diketahui bahwa nilai ini adalah UID kunci API, bukan keyString kunci API. keyString adalah nilai yang dapat ditemukan di artefak konfigurasi Aplikasi.

Jika apiKeyId tidak ditetapkan dalam permintaan ke webApps.Create, Firebase akan otomatis mengaitkan apiKeyId dengan WebApp. Kunci yang terkait otomatis ini mungkin merupakan kunci valid yang sudah ada atau, jika tidak ada kunci yang valid, kunci baru akan disediakan.

Dalam permintaan patch, apiKeyId tidak dapat ditetapkan ke nilai kosong, dan UID baru tidak boleh memiliki batasan atau hanya memiliki batasan yang valid untuk WebApp terkait. Sebaiknya gunakan Konsol Google Cloud untuk mengelola kunci API.

state

enum (State)

Hanya output. Status siklus proses Aplikasi.

etag

string

Checksum ini dihitung oleh server berdasarkan nilai kolom lainnya, dan dapat dikirim dengan permintaan update untuk memastikan bahwa klien memiliki nilai terbaru sebelum melanjutkan.

Pelajari etag lebih lanjut di standar AIP-154 Google.

Etag ini sangat divalidasi.

Metode

create

Meminta pembuatan WebApp baru dalam FirebaseProject yang ditentukan.

get

Mendapatkan WebApp yang ditentukan.

getConfig

Mendapatkan artefak konfigurasi yang terkait dengan WebApp yang ditentukan.

list

Menampilkan setiap WebApp yang terkait dengan FirebaseProject yang ditentukan.

patch

Memperbarui atribut WebApp yang ditentukan.

remove

Menghapus WebApp yang ditentukan dari FirebaseProject.

undelete

Memulihkan WebApp yang ditentukan ke FirebaseProject.