Diese Seite wurde von der Cloud Translation API übersetzt.

Cloud Firestore API

Greift auf die NoSQL-Dokumentdatenbank zu, die auf Autoscaling, hohe Leistung und einfache Anwendungsentwicklung ausgelegt ist.

Dienst: Firestore.googleapis.com

Um diesen Dienst aufzurufen, empfehlen wir Ihnen, die von Google bereitgestellten Clientbibliotheken zu verwenden. Wenn Ihre Anwendung zum Aufrufen dieses Dienstes eigene Bibliotheken verwenden muss, verwenden Sie für die API-Anfragen die folgenden Informationen.

Discovery-Dokument

Ein Discovery-Dokument ist eine maschinenlesbare Spezifikation zum Beschreiben und Nutzen von REST APIs. Sie wird verwendet, um Clientbibliotheken, IDE-Plug-ins und andere Tools zu erstellen, die mit Google APIs interagieren. Ein Dienst kann mehrere Discovery-Dokumente haben. Der Dienst bietet die folgenden Discovery-Dokumente:

Dienstendpunkt

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Ein Dienst kann mehrere Dienstendpunkte haben. Dieser Dienst hat den folgenden Dienstendpunkt und alle nachstehenden URIs beziehen sich auf ihn:

https://firestore.googleapis.com

REST-Ressource: v1beta2.projects.databases

Methoden
`exportDocuments`	`POST /v1beta2/{name=projects//databases/}:exportDocuments` Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage.
`importDocuments`	`POST /v1beta2/{name=projects//databases/}:importDocuments` Importiert Dokumente in Google Cloud Firestore.

REST-Ressource: v1beta2.projects.databases.collectionGroups.fields

Methoden
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//fields/}` Ruft die Metadaten und die Konfiguration für ein Feld ab.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/fields` Listet die Feldkonfiguration und Metadaten für diese Datenbank auf.
`patch`	`PATCH /v1beta2/{field.name=projects//databases//collectionGroups//fields/}` Aktualisiert eine Feldkonfiguration.

REST-Ressource: v1beta2.projects.databases.collectionGroups.indexes

Methoden
`create`	`POST /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Erstellt einen zusammengesetzten Index.
`delete`	`DELETE /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Löscht einen zusammengesetzten Index.
`get`	`GET /v1beta2/{name=projects//databases//collectionGroups//indexes/}` Ruft einen zusammengesetzten Index ab.
`list`	`GET /v1beta2/{parent=projects//databases//collectionGroups/*}/indexes` Listet zusammengesetzte Indexe auf.

REST-Ressource: v1beta1.projects.databases

Methoden
`exportDocuments`	`POST /v1beta1/{name=projects//databases/}:exportDocuments` Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage.
`importDocuments`	`POST /v1beta1/{name=projects//databases/}:importDocuments` Importiert Dokumente in Google Cloud Firestore.

REST-Ressource: v1beta1.projects.databases.documents

Methoden
`batchGet`	`POST /v1beta1/{database=projects//databases/}/documents:batchGet` Ruft mehrere Dokumente ab.
`batchWrite`	`POST /v1beta1/{database=projects//databases/}/documents:batchWrite` Führt einen Batch von Schreibvorgängen an.
`beginTransaction`	`POST /v1beta1/{database=projects//databases/}/documents:beginTransaction` Startet eine neue Transaktion.
`commit`	`POST /v1beta1/{database=projects//databases/}/documents:commit` Commitiert eine Transaktion und aktualisiert optional Dokumente.
`createDocument`	`POST /v1beta1/{parent=projects//databases//documents/**}/{collectionId}` Erstellt ein neues Dokument.
`delete`	`DELETE /v1beta1/{name=projects//databases//documents//*}` Löscht ein Dokument.
`get`	`GET /v1beta1/{name=projects//databases//documents//*}` Ruft ein einzelnes Dokument ab.
`list`	`GET /v1beta1/{parent=projects//databases//documents//*}/{collectionId}` Listet Dokumente auf.
`listCollectionIds`	`POST /v1beta1/{parent=projects//databases//documents}:listCollectionIds` Listet alle Sammlungs-IDs unter einem Dokument auf.
`listDocuments`	`GET /v1beta1/{parent=projects//databases//documents}/{collectionId}` Listet Dokumente auf.
`partitionQuery`	`POST /v1beta1/{parent=projects//databases//documents}:partitionQuery` Partitioniert eine Abfrage, indem Partitions-Cursors zurückgegeben werden, mit denen die Abfrage parallel ausgeführt werden kann.
`patch`	`PATCH /v1beta1/{document.name=projects//databases//documents//*}` Aktualisiert oder fügt ein Dokument ein.
`rollback`	`POST /v1beta1/{database=projects//databases/}/documents:rollback` Macht eine Transaktion rückgängig.
`runAggregationQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runAggregationQuery` Führt eine Aggregationsabfrage aus.
`runQuery`	`POST /v1beta1/{parent=projects//databases//documents}:runQuery` Führt eine Abfrage aus.

REST-Ressource: v1beta1.projects.databases.indexes

Methoden
`create`	`POST /v1beta1/{parent=projects//databases/}/indexes` Erstellt den angegebenen Index.
`delete`	`DELETE /v1beta1/{name=projects//databases//indexes/*}` Löscht einen Index.
`get`	`GET /v1beta1/{name=projects//databases//indexes/*}` Ruft einen Index ab.
`list`	`GET /v1beta1/{parent=projects//databases/}/indexes` Listet die Indexe auf, die den angegebenen Filtern entsprechen.

REST-Ressource: v1.projects.databases

Methoden
`create`	`POST /v1/{parent=projects/*}/databases` Datenbank erstellen
`delete`	`DELETE /v1/{name=projects//databases/}` Löscht eine Datenbank.
`exportDocuments`	`POST /v1/{name=projects//databases/}:exportDocuments` Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage.
`get`	`GET /v1/{name=projects//databases/}` Ruft Informationen zu einer Datenbank ab.
`importDocuments`	`POST /v1/{name=projects//databases/}:importDocuments` Importiert Dokumente in Google Cloud Firestore.
`list`	`GET /v1/{parent=projects/*}/databases` Listet alle Datenbanken im Projekt auf.
`patch`	`PATCH /v1/{database.name=projects//databases/}` Aktualisiert eine Datenbank.
`restore`	`POST /v1/{parent=projects/*}/databases:restore` Erstellt eine neue Datenbank durch Wiederherstellung aus einer vorhandenen Sicherung.

REST-Ressource: v1.projects.databases.backupSchedules

Methoden
`create`	`POST /v1/{parent=projects//databases/}/backupSchedules` Erstellt einen Sicherungszeitplan für eine Datenbank.
`delete`	`DELETE /v1/{name=projects//databases//backupSchedules/*}` Löscht einen Sicherungszeitplan.
`get`	`GET /v1/{name=projects//databases//backupSchedules/*}` Ruft Informationen zu einem Sicherungszeitplan ab.
`list`	`GET /v1/{parent=projects//databases/}/backupSchedules` Sicherungspläne auflisten.
`patch`	`PATCH /v1/{backupSchedule.name=projects//databases//backupSchedules/*}` Aktualisiert einen Zeitplan für die Sicherung.

REST-Ressource: v1.projects.databases.collectionGroups.fields

Methoden
`get`	`GET /v1/{name=projects//databases//collectionGroups//fields/}` Ruft die Metadaten und die Konfiguration für ein Feld ab.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/fields` Listet die Feldkonfiguration und Metadaten für diese Datenbank auf.
`patch`	`PATCH /v1/{field.name=projects//databases//collectionGroups//fields/}` Aktualisiert eine Feldkonfiguration.

REST-Ressource: v1.projects.databases.collectionGroups.indexes

Methoden
`create`	`POST /v1/{parent=projects//databases//collectionGroups/*}/indexes` Erstellt einen zusammengesetzten Index.
`delete`	`DELETE /v1/{name=projects//databases//collectionGroups//indexes/}` Löscht einen zusammengesetzten Index.
`get`	`GET /v1/{name=projects//databases//collectionGroups//indexes/}` Ruft einen zusammengesetzten Index ab.
`list`	`GET /v1/{parent=projects//databases//collectionGroups/*}/indexes` Listet zusammengesetzte Indexe auf.

REST-Ressource: v1.projects.databases.documents

Methoden
`batchGet`	`POST /v1/{database=projects//databases/}/documents:batchGet` Ruft mehrere Dokumente ab.
`batchWrite`	`POST /v1/{database=projects//databases/}/documents:batchWrite` Führt einen Batch von Schreibvorgängen an.
`beginTransaction`	`POST /v1/{database=projects//databases/}/documents:beginTransaction` Startet eine neue Transaktion.
`commit`	`POST /v1/{database=projects//databases/}/documents:commit` Commitiert eine Transaktion und aktualisiert optional Dokumente.
`createDocument`	`POST /v1/{parent=projects//databases//documents/**}/{collectionId}` Erstellt ein neues Dokument.
`delete`	`DELETE /v1/{name=projects//databases//documents//*}` Löscht ein Dokument.
`get`	`GET /v1/{name=projects//databases//documents//*}` Ruft ein einzelnes Dokument ab.
`list`	`GET /v1/{parent=projects//databases//documents//*}/{collectionId}` Listet Dokumente auf.
`listCollectionIds`	`POST /v1/{parent=projects//databases//documents}:listCollectionIds` Listet alle Sammlungs-IDs unter einem Dokument auf.
`listDocuments`	`GET /v1/{parent=projects//databases//documents}/{collectionId}` Listet Dokumente auf.
`partitionQuery`	`POST /v1/{parent=projects//databases//documents}:partitionQuery` Partitioniert eine Abfrage, indem Partitions-Cursors zurückgegeben werden, mit denen die Abfrage parallel ausgeführt werden kann.
`patch`	`PATCH /v1/{document.name=projects//databases//documents//*}` Aktualisiert oder fügt ein Dokument ein.
`rollback`	`POST /v1/{database=projects//databases/}/documents:rollback` Macht eine Transaktion rückgängig.
`runAggregationQuery`	`POST /v1/{parent=projects//databases//documents}:runAggregationQuery` Führt eine Aggregationsabfrage aus.
`runQuery`	`POST /v1/{parent=projects//databases//documents}:runQuery` Führt eine Abfrage aus.

REST-Ressource: v1.projects.databases.operations

Methoden
`cancel`	`POST /v1/{name=projects//databases//operations/*}:cancel` Startet den asynchronen Abbruch eines lang andauernden Vorgangs.
`delete`	`DELETE /v1/{name=projects//databases//operations/*}` Löscht einen Vorgang mit langer Ausführungszeit.
`get`	`GET /v1/{name=projects//databases//operations/*}` Ruft den letzten Status eines lang andauernden Vorgangs ab.
`list`	`GET /v1/{name=projects//databases/}/operations` Listet Vorgänge auf, die zum angegebenen Filter in der Anfrage passen.

REST-Ressource: v1.projects.locations

Methoden
`get`	`GET /v1/{name=projects//locations/}` Ruft Informationen zu einem Standort ab.
`list`	`GET /v1/{name=projects/*}/locations` Listet Informationen zu den unterstützten Standorten für diesen Dienst auf.

REST-Ressource: v1.projects.locations.backups

Methoden
`delete`	`DELETE /v1/{name=projects//locations//backups/*}` Löscht eine Sicherung.
`get`	`GET /v1/{name=projects//locations//backups/*}` Ruft Informationen zu einer Sicherung ab.
`list`	`GET /v1/{parent=projects//locations/}/backups` Listet alle Sicherungen auf.