Cloud Firestore API

Mengakses database dokumen NoSQL yang dibangun untuk penskalaan otomatis, performa tinggi, dan kemudahan pengembangan aplikasi.

Layanan: firestore.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan library sendiri untuk memanggil layanan ini, gunakan informasi berikut saat Anda membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen discovery berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan mungkin memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah berhubungan dengan endpoint layanan ini:

  • https://firestore.googleapis.com

Resource REST: v1beta2.projects.databases

Metode
exportDocuments POST /v1beta2/{name=projects/*/databases/*}:exportDocuments
Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage.
importDocuments POST /v1beta2/{name=projects/*/databases/*}:importDocuments
Mengimpor dokumen ke Google Cloud Firestore.

Resource REST: v1beta2.projects.databases.collectionGroups.fields

Metode
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Mendapatkan metadata dan konfigurasi untuk Kolom.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields
Mencantumkan konfigurasi kolom dan metadata untuk database ini.
patch PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Memperbarui konfigurasi kolom.

Resource REST: v1beta2.projects.databases.collectionGroups.indexes

Metode
create POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Membuat indeks komposit.
delete DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Menghapus indeks komposit.
get GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Mendapatkan indeks komposit.
list GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Mencantumkan indeks komposit.

Resource REST: v1beta1.projects.databases

Metode
exportDocuments POST /v1beta1/{name=projects/*/databases/*}:exportDocuments
Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage.
importDocuments POST /v1beta1/{name=projects/*/databases/*}:importDocuments
Mengimpor dokumen ke Google Cloud Firestore.

Resource REST: v1beta1.projects.databases.documents

Metode
batchGet POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet
Mendapatkan beberapa dokumen.
batchWrite POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite
Menerapkan sekumpulan operasi tulis.
beginTransaction POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction
Memulai transaksi baru.
commit POST /v1beta1/{database=projects/*/databases/*}/documents:commit
Melakukan transaksi, sekaligus memperbarui dokumen secara opsional.
createDocument POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Membuat dokumen baru.
delete DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}
Menghapus dokumen.
get GET /v1beta1/{name=projects/*/databases/*/documents/*/**}
Mendapatkan satu dokumen.
list GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Mencantumkan dokumen.
listCollectionIds POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
Mencantumkan semua ID koleksi di bawah dokumen.
listDocuments GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}
Mencantumkan dokumen.
partitionQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery
Mempartisi kueri dengan menampilkan kursor partisi yang dapat digunakan untuk menjalankan kueri secara paralel.
patch PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}
Memperbarui atau menyisipkan dokumen.
rollback POST /v1beta1/{database=projects/*/databases/*}/documents:rollback
Me-roll back transaksi.
runAggregationQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Menjalankan kueri agregasi.
runQuery POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery
Menjalankan kueri.

Resource REST: v1beta1.projects.databases.indexes

Metode
create POST /v1beta1/{parent=projects/*/databases/*}/indexes
Membuat indeks yang ditentukan.
delete DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}
Menghapus indeks.
get GET /v1beta1/{name=projects/*/databases/*/indexes/*}
Mendapatkan indeks.
list GET /v1beta1/{parent=projects/*/databases/*}/indexes
Mencantumkan indeks yang cocok dengan filter yang ditentukan.

Resource REST: v1.projects.databases

Metode
create POST /v1/{parent=projects/*}/databases
Buat database.
delete DELETE /v1/{name=projects/*/databases/*}
Menghapus database.
exportDocuments POST /v1/{name=projects/*/databases/*}:exportDocuments
Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage.
get GET /v1/{name=projects/*/databases/*}
Mendapatkan informasi tentang database.
importDocuments POST /v1/{name=projects/*/databases/*}:importDocuments
Mengimpor dokumen ke Google Cloud Firestore.
list GET /v1/{parent=projects/*}/databases
Menampilkan daftar semua database di project.
patch PATCH /v1/{database.name=projects/*/databases/*}
Memperbarui database.
restore POST /v1/{parent=projects/*}/databases:restore
Membuat database baru dengan memulihkan dari cadangan yang ada.

Resource REST: v1.projects.databases.backupSchedules

Metode
create POST /v1/{parent=projects/*/databases/*}/backupSchedules
Membuat jadwal pencadangan di database.
delete DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}
Menghapus jadwal pencadangan.
get GET /v1/{name=projects/*/databases/*/backupSchedules/*}
Mendapatkan informasi tentang jadwal pencadangan.
list GET /v1/{parent=projects/*/databases/*}/backupSchedules
Mencantumkan jadwal pencadangan.
patch PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}
Memperbarui jadwal pencadangan.

Resource REST: v1.projects.databases.collectionGroups.fields

Metode
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}
Mendapatkan metadata dan konfigurasi untuk Kolom.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields
Mencantumkan konfigurasi kolom dan metadata untuk database ini.
patch PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Memperbarui konfigurasi kolom.

Resource REST: v1.projects.databases.collectionGroups.indexes

Metode
create POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Membuat indeks komposit.
delete DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Menghapus indeks komposit.
get GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}
Mendapatkan indeks komposit.
list GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes
Mencantumkan indeks komposit.

Resource REST: v1.projects.databases.documents

Metode
batchGet POST /v1/{database=projects/*/databases/*}/documents:batchGet
Mendapatkan beberapa dokumen.
batchWrite POST /v1/{database=projects/*/databases/*}/documents:batchWrite
Menerapkan sekumpulan operasi tulis.
beginTransaction POST /v1/{database=projects/*/databases/*}/documents:beginTransaction
Memulai transaksi baru.
commit POST /v1/{database=projects/*/databases/*}/documents:commit
Melakukan transaksi, sekaligus memperbarui dokumen secara opsional.
createDocument POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}
Membuat dokumen baru.
delete DELETE /v1/{name=projects/*/databases/*/documents/*/**}
Menghapus dokumen.
get GET /v1/{name=projects/*/databases/*/documents/*/**}
Mendapatkan satu dokumen.
list GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}
Mencantumkan dokumen.
listCollectionIds POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds
Mencantumkan semua ID koleksi di bawah dokumen.
listDocuments GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}
Mencantumkan dokumen.
partitionQuery POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery
Mempartisi kueri dengan menampilkan kursor partisi yang dapat digunakan untuk menjalankan kueri secara paralel.
patch PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}
Memperbarui atau menyisipkan dokumen.
rollback POST /v1/{database=projects/*/databases/*}/documents:rollback
Me-roll back transaksi.
runAggregationQuery POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery
Menjalankan kueri agregasi.
runQuery POST /v1/{parent=projects/*/databases/*/documents}:runQuery
Menjalankan kueri.

Resource REST: v1.projects.databases.operations

Metode
cancel POST /v1/{name=projects/*/databases/*/operations/*}:cancel
Memulai pembatalan asinkron pada operasi yang berjalan lama.
delete DELETE /v1/{name=projects/*/databases/*/operations/*}
Menghapus operasi yang berjalan lama.
get GET /v1/{name=projects/*/databases/*/operations/*}
Mendapatkan status terbaru dari operasi yang berjalan lama.
list GET /v1/{name=projects/*/databases/*}/operations
Mencantumkan operasi yang cocok dengan filter yang ditentukan dalam permintaan.

Resource REST: v1.projects.locations

Metode
get GET /v1/{name=projects/*/locations/*}
Mendapatkan informasi tentang lokasi.
list GET /v1/{name=projects/*}/locations
Mencantumkan informasi tentang lokasi yang didukung untuk layanan ini.

Resource REST: v1.projects.locations.backups

Metode
delete DELETE /v1/{name=projects/*/locations/*/backups/*}
Menghapus cadangan.
get GET /v1/{name=projects/*/locations/*/backups/*}
Mendapatkan informasi tentang pencadangan.
list GET /v1/{parent=projects/*/locations/*}/backups
Mencantumkan semua cadangan.