Cloud Firestore API

Uzyskuje dostęp do bazy danych dokumentów NoSQL utworzonej pod kątem automatycznego skalowania, wysokiej wydajności i łatwego tworzenia aplikacji.

Usługa: Firestore.googleapis.com

Do wywołania tej usługi zalecamy użycie dostarczonych przez Google bibliotek klienta. Jeśli do wywoływania tej usługi aplikacja musi używać Twoich własnych bibliotek, podczas tworzenia żądań do interfejsu API użyj podanych niżej informacji.

Dokument opisujący

Dokument opisujący to czytelna dla komputera specyfikacja opisująca interfejsy API REST i ich używanie. Służy do tworzenia bibliotek klienta, wtyczek IDE i innych narzędzi, które współdziałają z interfejsami API Google. Jedna usługa może dostarczać wiele dokumentów opisujących. Ta usługa dostarcza następujące dokumenty wykrywania:

Punkt końcowy usługi

Punkt końcowy usługi to podstawowy adres URL, który określa adres sieciowy usługi interfejsu API. Jedna usługa może mieć wiele punktów końcowych. Ta usługa ma następujący punkt końcowy i wszystkie poniższe identyfikatory URI są względne wobec tego punktu końcowego:

  • https://firestore.googleapis.com

Zasób REST: v1beta2.projects.databases

Metody
exportDocuments
(POST /v1beta2/{name=projects/*/databases/*}:exportDocuments) Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage.
importDocuments
(POST /v1beta2/{name=projects/*/databases/*}:importDocuments) Importuje dokumenty do Google Cloud Firestore.

Zasób REST: v1beta2.projects.databases.collectionGroups.fields

Metody
get
(GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/fields/*}) Pobiera metadane i konfigurację pola.
list
(GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/fields) Zawiera konfigurację pól i metadane tej bazy danych.
patch
(PATCH /v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}) Aktualizuje konfigurację pola.

Zasób REST: v1beta2.projects.databases.collectionGroups.indexes

Metody
create
(POST /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes) Tworzy indeks złożony.
delete
(DELETE /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}) Usuwa indeks złożony.
get
(GET /v1beta2/{name=projects/*/databases/*/collectionGroups/*/indexes/*}) Pobiera indeks złożony.
list
(GET /v1beta2/{parent=projects/*/databases/*/collectionGroups/*}/indexes) Wyświetla listę indeksów złożonych.

Zasób REST: v1beta1.projects.databases

Metody
exportDocuments
(POST /v1beta1/{name=projects/*/databases/*}:exportDocuments) Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage.
importDocuments
(POST /v1beta1/{name=projects/*/databases/*}:importDocuments) Importuje dokumenty do Google Cloud Firestore.

Zasób REST: v1beta1.projects.databases.documents

Metody
batchGet
(POST /v1beta1/{database=projects/*/databases/*}/documents:batchGet) Pobiera wiele dokumentów.
batchWrite
(POST /v1beta1/{database=projects/*/databases/*}/documents:batchWrite) Stosuje grupę operacji zapisu.
beginTransaction
(POST /v1beta1/{database=projects/*/databases/*}/documents:beginTransaction) rozpoczyna nową transakcję;
commit
(POST /v1beta1/{database=projects/*/databases/*}/documents:commit) Potwierdza transakcję i opcjonalnie aktualizują dokumenty.
createDocument
(POST /v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}) Tworzy nowy dokument.
delete
(DELETE /v1beta1/{name=projects/*/databases/*/documents/*/**}) Usuwa dokument.
get
(GET /v1beta1/{name=projects/*/databases/*/documents/*/**}) Pobiera jeden dokument.
list
(GET /v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}) Wyświetla listę dokumentów.
listCollectionIds
(POST /v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds) Zawiera listę wszystkich identyfikatorów kolekcji pod dokumentem.
listDocuments
(GET /v1beta1/{parent=projects/*/databases/*/documents}/{collectionId}) Wyświetla listę dokumentów.
partitionQuery
(POST /v1beta1/{parent=projects/*/databases/*/documents}:partitionQuery) Partycjonuje zapytanie, zwracając kursory partycji, których można używać do równoległego uruchamiania zapytania.
patch
(PATCH /v1beta1/{document.name=projects/*/databases/*/documents/*/**}) Aktualizuje lub wstawia dokument.
rollback
(POST /v1beta1/{database=projects/*/databases/*}/documents:rollback) Wycofuje transakcję.
runAggregationQuery
(POST /v1beta1/{parent=projects/*/databases/*/documents}:runAggregationQuery) Uruchamia zapytanie agregacji.
runQuery
(POST /v1beta1/{parent=projects/*/databases/*/documents}:runQuery) Uruchamia zapytanie.

Zasób REST: v1beta1.projects.databases.indexes

Metody
create
(POST /v1beta1/{parent=projects/*/databases/*}/indexes) Tworzy określony indeks.
delete
(DELETE /v1beta1/{name=projects/*/databases/*/indexes/*}) Usuwa indeks.
get
(GET /v1beta1/{name=projects/*/databases/*/indexes/*}) Pobiera indeks.
list
(GET /v1beta1/{parent=projects/*/databases/*}/indexes) Zawiera listę indeksów pasujących do określonych filtrów.

Zasób REST: v1.projects.databases

Metody
create
(POST /v1/{parent=projects/*}/databases) Utworzenie bazy danych.
delete
(DELETE /v1/{name=projects/*/databases/*}) Usuwa bazę danych.
exportDocuments
(POST /v1/{name=projects/*/databases/*}:exportDocuments) Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage.
get
(GET /v1/{name=projects/*/databases/*}) Pobiera informacje o bazie danych.
importDocuments
(POST /v1/{name=projects/*/databases/*}:importDocuments) Importuje dokumenty do Google Cloud Firestore.
list
(GET /v1/{parent=projects/*}/databases) Wyświetl wszystkie bazy danych w projekcie.
patch
(PATCH /v1/{database.name=projects/*/databases/*}) Aktualizuje bazę danych.
restore
(POST /v1/{parent=projects/*}/databases:restore) Tworzy nową bazę danych przez przywrócenie danych z istniejącej kopii zapasowej.

Zasób REST: v1.projects.databases.backupSchedules

Metody
create
(POST /v1/{parent=projects/*/databases/*}/backupSchedules) Tworzy harmonogram tworzenia kopii zapasowych w bazie danych.
delete
(DELETE /v1/{name=projects/*/databases/*/backupSchedules/*}) Usuwa harmonogram tworzenia kopii zapasowych.
get
(GET /v1/{name=projects/*/databases/*/backupSchedules/*}) Pobiera informacje o harmonogramie tworzenia kopii zapasowych.
list
(GET /v1/{parent=projects/*/databases/*}/backupSchedules) Wyświetl harmonogramy tworzenia kopii zapasowych.
patch
(PATCH /v1/{backupSchedule.name=projects/*/databases/*/backupSchedules/*}) Aktualizuje harmonogram tworzenia kopii zapasowych.

Zasób REST: v1.projects.databases.collectionGroups.fields

Metody
get
(GET /v1/{name=projects/*/databases/*/collectionGroups/*/fields/*}) Pobiera metadane i konfigurację pola.
list
(GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/fields) Zawiera konfigurację pól i metadane tej bazy danych.
patch
(PATCH /v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}) Aktualizuje konfigurację pola.

Zasób REST: v1.projects.databases.collectionGroups.indexes

Metody
create
(POST /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes) Tworzy indeks złożony.
delete
(DELETE /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}) Usuwa indeks złożony.
get
(GET /v1/{name=projects/*/databases/*/collectionGroups/*/indexes/*}) Pobiera indeks złożony.
list
(GET /v1/{parent=projects/*/databases/*/collectionGroups/*}/indexes) Wyświetla listę indeksów złożonych.

Zasób REST: v1.projects.databases.documents

Metody
batchGet
(POST /v1/{database=projects/*/databases/*}/documents:batchGet) Pobiera wiele dokumentów.
batchWrite
(POST /v1/{database=projects/*/databases/*}/documents:batchWrite) Stosuje grupę operacji zapisu.
beginTransaction
(POST /v1/{database=projects/*/databases/*}/documents:beginTransaction) rozpoczyna nową transakcję;
commit
(POST /v1/{database=projects/*/databases/*}/documents:commit) Potwierdza transakcję i opcjonalnie aktualizują dokumenty.
createDocument
(POST /v1/{parent=projects/*/databases/*/documents/**}/{collectionId}) Tworzy nowy dokument.
delete
(DELETE /v1/{name=projects/*/databases/*/documents/*/**}) Usuwa dokument.
get
(GET /v1/{name=projects/*/databases/*/documents/*/**}) Pobiera jeden dokument.
list
(GET /v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}) Wyświetla listę dokumentów.
listCollectionIds
(POST /v1/{parent=projects/*/databases/*/documents}:listCollectionIds) Zawiera listę wszystkich identyfikatorów kolekcji pod dokumentem.
listDocuments
(GET /v1/{parent=projects/*/databases/*/documents}/{collectionId}) Wyświetla listę dokumentów.
partitionQuery
(POST /v1/{parent=projects/*/databases/*/documents}:partitionQuery) Partycjonuje zapytanie, zwracając kursory partycji, których można używać do równoległego uruchamiania zapytania.
patch
(PATCH /v1/{document.name=projects/*/databases/*/documents/*/**}) Aktualizuje lub wstawia dokument.
rollback
(POST /v1/{database=projects/*/databases/*}/documents:rollback) Wycofuje transakcję.
runAggregationQuery
(POST /v1/{parent=projects/*/databases/*/documents}:runAggregationQuery) Uruchamia zapytanie agregacji.
runQuery
(POST /v1/{parent=projects/*/databases/*/documents}:runQuery) Uruchamia zapytanie.

Zasób REST: v1.projects.databases.operations

Metody
cancel
(POST /v1/{name=projects/*/databases/*/operations/*}:cancel) Rozpoczyna anulowanie asynchronicznej długo trwającej operacji.
delete
(DELETE /v1/{name=projects/*/databases/*/operations/*}) Usuwa długo trwającą operację.
get
(GET /v1/{name=projects/*/databases/*/operations/*}) Pobiera najnowszy stan długo trwającej operacji.
list
(GET /v1/{name=projects/*/databases/*}/operations) Wyświetla listę operacji, które pasują do określonego filtra w żądaniu.

Zasób REST: v1.projects.locations

Metody
get
(GET /v1/{name=projects/*/locations/*}) Pobiera informacje o lokalizacji.
list
(GET /v1/{name=projects/*}/locations) Lista informacji o obsługiwanych lokalizacjach dla tej usługi.

Zasób REST: v1.projects.locations.backups

Metody
delete
(DELETE /v1/{name=projects/*/locations/*/backups/*}) Usuwa kopię zapasową.
get
(GET /v1/{name=projects/*/locations/*/backups/*}) Pobiera informacje o kopii zapasowej.
list
(GET /v1/{parent=projects/*/locations/*}/backups) Zawiera listę wszystkich kopii zapasowych.