REST Resource: projects

Sumber daya: FirebaseProject

FirebaseProject adalah entitas Firebase tingkat atas. Ini adalah wadah untuk Aplikasi Firebase, situs Firebase Hosting, sistem penyimpanan (Firebase Realtime Database, Cloud Firestore, bucket Cloud Storage), dan sumber daya Firebase dan Google Cloud Platform (GCP) lainnya.

Anda membuat FirebaseProject dengan memanggil projects.addFirebase dan menentukan Project GCP yang ada . Tindakan ini menambahkan sumber daya Firebase ke Project GCP yang ada.

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

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

string

Nama sumber daya Proyek, dalam format:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : ProjectNumber Proyek (disarankan) atau ProjectId -nya.
Pelajari lebih lanjut cara menggunakan ID proyek dalam standar AIP 2510 Google.
Perhatikan bahwa nilai PROJECT_IDENTIFIER di isi respons mana pun adalah ProjectId .

projectId

string

Hanya keluaran. Kekal. Pengidentifikasi unik yang ditetapkan pengguna untuk Proyek.

Pengenal ini mungkin muncul di URL atau nama beberapa sumber daya Firebase yang terkait dengan Proyek, namun secara umum harus diperlakukan sebagai alias kemudahan untuk mereferensikan Proyek.

projectNumber

string ( int64 format)

Hanya keluaran. Kekal. Pengidentifikasi kanonis yang unik secara global dan ditetapkan oleh Google untuk Proyek. Gunakan ID ini saat mengonfigurasi integrasi dan/atau melakukan panggilan API ke Firebase atau layanan pihak ketiga.

displayName

string

Nama tampilan Proyek yang ditetapkan pengguna.

resources

object ( DefaultResources )

Hanya keluaran. Sumber daya Firebase default yang terkait dengan Proyek.

state

enum ( State )

Hanya keluaran. Status siklus hidup Proyek.

annotations

map (key: string, value: string)

Serangkaian anotasi yang ditentukan pengguna untuk FirebaseProject .
Pelajari lebih lanjut tentang anotasi dalam standar AIP-128 Google.

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

Sebuah objek yang berisi daftar "key": value . Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

Checksum ini dihitung oleh server berdasarkan nilai bidang lain, dan dapat dikirim bersama permintaan pembaruan untuk memastikan klien memiliki nilai terkini sebelum melanjutkan.

Pelajari lebih lanjut tentang etag dalam standar AIP-154 Google.

Etag ini sangat divalidasi.

Sumber Daya Default

Sumber daya default yang terkait dengan Proyek.

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

string

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

PROJECT_ID

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

realtimeDatabaseInstance

string

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

PROJECT_ID

Meskipun jarang, projectId Anda mungkin sudah digunakan sebagai nama untuk instance Realtime Database yang ada di proyek lain (pelajari lebih lanjut tentang database sharding ). Dalam kasus ini, projectId Anda ditambahkan dengan tanda hubung dan lima karakter alfanumerik untuk membuat nama instans Realtime Database default Anda. Misalnya, jika projectId Anda adalah myproject123 , nama instance database default Anda mungkin: myproject123-a5c16

storageBucket

string

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

PROJECT_ID .appspot.com

locationId

string

Hanya keluaran. ID lokasi sumber daya GCP default Proyek. Lokasi tersebut merupakan salah satu lokasi resource GCP yang tersedia.

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

Negara

Kemungkinan status siklus hidup Proyek. Pelajari lebih lanjut tentang status dalam standar AIP-216 Google.

Enum
STATE_UNSPECIFIED Keadaan tidak ditentukan.
ACTIVE Proyek ini aktif.
DELETED Proyek telah dihapus sementara.

Metode

addFirebase

Menambahkan sumber daya Firebase ke Project Google Cloud Platform (GCP) tertentu yang sudah ada.

addGoogleAnalytics

Tautkan FirebaseProject yang ditentukan dengan akun Google Analytics yang ada .

get

Mendapatkan FirebaseProject yang ditentukan.

getAdminSdkConfig

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

getAnalyticsDetails

Mendapatkan detail Google Analytics yang saat ini dikaitkan 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.