Mit der Google Docs API können Sie Dokumente erstellen und ändern.
Apps lassen sich in die Docs API einbinden. So lassen sich sowohl von Nutzern als auch vom System bereitgestellte Dokumente erstellen. Die API ermöglicht Ihnen Folgendes:
- Prozesse automatisieren
- Dokumentation im Bulk erstellen
- Rechnungen oder Verträge erstellen
Übersicht über die API
Die Ressource documents bietet Methoden, mit denen Sie die Docs API aufrufen können.
API-Methoden
Mit den folgenden Methoden können Sie Google Docs-Dokumente erstellen, lesen und aktualisieren:
- Verwenden Sie documents.create, um ein Dokument zu erstellen.
- Verwenden Sie documents.get, um den Inhalt eines angegebenen Dokuments abzurufen.
- Mit documents.batchUpdate können Sie eine Reihe von Aktualisierungen an einem bestimmten Dokument atomar ausführen.
Für die Methoden get und batchUpdate ist ein documentId (siehe unten) als Parameter erforderlich, um das Zieldokument anzugeben. Die Methode create gibt eine Instanz des erstellten Dokuments zurück, aus der Sie die ID lesen können.
Batch-Updates
Die Methode batchUpdate nimmt eine Liste von Anfrageobjekten an und aktualisiert sie entsprechend der Reihenfolge, in der sie in der Batchanfrage aufgeführt sind. Die Aktualisierungen im Batch werden automatisch angewendet. Wenn eine Anfrage ungültig ist, schlägt die gesamte Aktualisierung fehl und es werden keine (möglicherweise abhängigen) Änderungen angewendet.
Die Methode batchUpdate gibt eine Liste von Antwortobjekten zurück. Die Objekte in dieser Liste haben dieselbe Indexreihenfolge wie die entsprechende Anfrage.
Unter Best Practices für Batchanfragen wird beschrieben, wie API-Aufrufe im Batch zusammengefasst werden. Weitere Informationen zu Anfrage- und Antworttypen finden Sie in der Referenzdokumentation zu batchUpdate.
Dokument-ID
Dokument-IDs verweisen auf ein Dokument und können von der URL abgeleitet werden:
https://docs.google.com/document/d/documentId/edit
documentId ist ein eindeutiger String, der Buchstaben, Zahlen und einige Sonderzeichen enthält. Mit dem folgenden regulären Ausdruck kann die Dokument-ID aus einer Google Docs-URL extrahiert werden:
/document/d/([a-zA-Z0-9-_]+)
Wenn Sie mit der Google Drive API vertraut sind, entspricht documentId der ID der Ressource File.
Speicherorte in einem Dokument: Indexe
Wenn Sie den Inhalt eines Dokuments aktualisieren, wird jede Aktualisierung an einem Ort oder in einem Bereich des Dokuments ausgeführt. Diese Speicherorte und Bereiche werden mithilfe von Indexen angegeben, die einen Offset innerhalb eines beinhaltenden Dokumentsegments darstellen. Weitere Informationen zu Indexen und deren Verwendung finden Sie im Konzeptleitfaden Struktur eines Google Docs-Dokuments.
Workflow zur Dokumentaktualisierung
Das Erstellen und Ausfüllen eines neuen Dokuments ist unkompliziert, da es keine vorhandenen Inhalte gibt und sich keine Mitbearbeiter den Dokumentstatus ändern können. Konzeptionell funktioniert dies wie im folgenden Sequenzdiagramm:
Das Aktualisieren eines vorhandenen Dokuments ist komplexer. Bevor Sie sinnvolle Aufrufe zum Aktualisieren eines Dokuments ausführen können, müssen Sie den aktuellen Status des Dokuments kennen: die Elemente, aus denen es besteht, welcher Inhalt sich in diesen Elementen befindet und wo sich diese Elemente im Dokument befinden. Das folgende Sequenzdiagramm zeigt, wie dies funktioniert:
Dieses Diagramm berücksichtigt keine Workflows, bei denen gleichzeitige Aktualisierungen durch andere Mitbearbeiter im selben Dokument vorgenommen werden. Eine Diskussion zu diesem Thema finden Sie unter Zusammenarbeit planen.