REST Resource: projects

Resource: FirebaseProject

FirebaseProject adalah entity Firebase tingkat teratas. Ini adalah container untuk Aplikasi Firebase, situs Firebase Hosting, sistem penyimpanan (Firebase Realtime Database, Cloud Firestore, bucket Cloud Storage), serta resource Firebase dan Google Cloud Platform (GCP) lainnya.

Anda membuat FirebaseProject dengan memanggil projects.addFirebase dan menentukan GCP Project yang sudah ada. Tindakan ini akan menambahkan resource Firebase ke Project GCP yang ada.

Karena FirebaseProject sebenarnya juga merupakan Project GCP, FirebaseProject memiliki ID GCP pokok yang sama (projectNumber dan projectId). Hal ini memudahkan interop dengan Google API.

Representasi JSON 
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Kolom
name

string

Nama resource Project, dalam format:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: ProjectNumber (direkomendasikan) Project atau ProjectId project.
Pelajari lebih lanjut cara menggunakan ID project dalam standar AIP 2510 Google.
Perhatikan bahwa nilai untuk PROJECT_IDENTIFIER dalam isi respons adalah ProjectId.
projectId

string

Hanya output. Tidak dapat diubah. ID unik yang ditetapkan pengguna untuk Project.

ID ini dapat muncul di URL atau nama beberapa resource Firebase yang terkait dengan Project, tetapi secara umum harus diperlakukan sebagai alias praktis untuk merujuk Project.
projectNumber

string (int64 format)

Hanya output. Tidak dapat diubah. ID kanonis unik global yang ditetapkan Google untuk Project. Gunakan ID ini saat mengonfigurasi integrasi dan/atau melakukan panggilan API ke Firebase atau layanan pihak ketiga.
displayName

string

Nama tampilan Project yang ditetapkan oleh pengguna.
resources

object (DefaultResources)

Hanya output. Resource Firebase default yang terkait dengan Project.
state

enum (State)

Hanya output. Status siklus proses Project.
annotations

map (key: string, value: string)

Kumpulan anotasi yang ditentukan pengguna untuk FirebaseProject.
Pelajari lebih lanjut anotasi di standar AIP-128 Google.

Anotasi ini hanya ditujukan untuk developer dan alat sisi klien. Layanan Firebase tidak akan mengubah kumpulan anotasi ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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.

DefaultResources

Resource default yang terkait dengan Project.

Representasi JSON 
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Kolom
hostingSite

string

Hanya output. Nama situs Firebase Hosting default, dalam format:

PROJECT_ID

Meskipun jarang terjadi, projectId mungkin sudah digunakan sebagai nama untuk situs Hosting yang ada di project lain (pelajari lebih lanjut cara membuat situs tambahan non-default). Dalam kasus ini, projectId Anda ditambahkan dengan tanda hubung, lalu lima karakter alfanumerik untuk membuat nama situs Hosting default Anda. Misalnya, jika projectId adalah myproject123, nama situs Hosting default Anda adalah: myproject123-a5c16
realtimeDatabaseInstance

string

Hanya output. Nama instance Firebase Realtime Database default, dalam format:

PROJECT_ID

Meskipun jarang terjadi, projectId mungkin sudah digunakan sebagai nama untuk instance Realtime Database yang ada di project lain (pelajari sharding database lebih lanjut). Dalam kasus ini, projectId Anda akan ditambahi tanda hubung, lalu lima karakter alfanumerik untuk membuat nama instance Realtime Database default Anda. Misalnya, jika projectId adalah myproject123, nama instance database default Anda adalah: myproject123-a5c16
storageBucket

string

Hanya output. Bucket penyimpanan Cloud Storage for Firebase default, dalam format:

PROJECT_ID.appspot.com
locationId

string

Hanya output. ID lokasi resource GCP default Project. Lokasi adalah salah satu lokasi resource GCP yang tersedia.

Kolom ini dihilangkan jika lokasi resource GCP default belum diselesaikan. Untuk menetapkan lokasi resource GCP default Project, panggil defaultLocation.finalize setelah Anda menambahkan resource Firebase ke Project.

Negara Bagian

Kemungkinan status siklus proses Project. Pelajari lebih lanjut status dalam standar AIP-216 Google.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
ACTIVE Project aktif.
DELETED Project ini telah dihapus untuk sementara.

Metode

addFirebase

 Menambahkan resource Firebase ke Google Cloud Platform (GCP) Project yang ditentukan.

addGoogleAnalytics

 Menautkan FirebaseProject yang ditentukan dengan akun Google Analytics yang ada.

get

 Mendapatkan FirebaseProject yang ditentukan.

getAdminSdkConfig

 Mengambil artefak konfigurasi yang terkait dengan FirebaseProject yang ditentukan, yang dapat digunakan oleh server untuk menyederhanakan inisialisasi.

getAnalyticsDetails

 Mendapatkan detail Google Analytics yang saat ini terkait dengan FirebaseProject yang ditentukan.

list

 Mencantumkan setiap FirebaseProject yang dapat diakses oleh pemanggil.

patch

 Memperbarui atribut FirebaseProject yang ditentukan.

removeAnalytics

 Membatalkan tautan FirebaseProject yang ditentukan dari akun Google Analytics-nya.

searchApps

 Mencantumkan semua Aplikasi yang tersedia untuk FirebaseProject yang ditentukan.