In dieser Anleitung werden die primären Anfrage- und Antwortmethoden vorgestellt, aus denen die Google Docs API besteht. Außerdem erfahren Sie, wie Sie ein Dokument stapelweise aktualisieren können.
Sie können die Google Docs API mit einer HTTP-Anfrage oder mit einem Methodenaufruf in einer sprachspezifischen Clientbibliothek aufrufen. Diese sind weitgehend äquivalent.
Die Google Docs API gibt eine HTTP-Antwort zurück, die im Allgemeinen das Ergebnis des Anfrageaufrufs enthält. Wenn Sie eine Clientbibliothek für Anfragen verwenden, werden die Antworten in einer sprachspezifischen Weise zurückgegeben.
Anfragemethoden
Die Docs API unterstützt die folgenden Methoden:
documents.create: Erstellen Sie ein leeres Google Docs-Dokument.documents.get: Gibt eine vollständige Instanz des angegebenen Dokuments zurück. Sie können den zurückgegebenen JSON-Code parsen, um den Dokumentinhalt, die Formatierung und andere Funktionen zu extrahieren.documents.batchUpdate: Senden Sie eine Liste von Bearbeitungsanfragen, die in kleinstmöglichen Schritten auf das Dokument angewendet werden sollen, und geben Sie eine Liste der Ergebnisse zurück.
Die Methoden documents.get und documents.batchUpdate erfordern einen documentId als Parameter, um das Zieldokument anzugeben. Die Methode documents.create gibt eine Instanz des erstellten Dokuments zurück, aus der Sie das documentId lesen können. Weitere Informationen zu documentId finden Sie unter Dokument-ID.
Batch-Updates
Die Methode documents.batchUpdate verwendet eine Liste von request-Objekten, von denen jedes eine einzelne auszuführende Anfrage angibt. Formatieren Sie z. B. einen Absatz
und fügen Sie dann ein Inline-Bild hinzu. Jede Anfrage wird vor dem Anwenden überprüft und gemäß der Reihenfolge verarbeitet, in der sie in der Batchanfrage angezeigt werden.
Alle Anfragen in der Batchaktualisierung werden in kleinstmöglichen Schritten angewendet. Wenn also eine Anfrage ungültig ist, schlägt die gesamte Aktualisierung fehl und keine der (möglicherweise abhängigen) Änderungen wird angewendet.
Einige documents.batchUpdate-Methoden liefern Antworten mit Informationen zu den angewendeten Anfragen. Diese Methoden geben einen Antworttext mit einer Liste von response-Objekten zurück. Bei anderen Anfragen müssen keine Informationen zurückgegeben und keine leere Antwort angezeigt werden. Die Objekte in der Antwortliste belegen die gleiche Indexreihenfolge wie die entsprechende Anfrage.
Ein beliebtes Muster zum Stellen von Batchanfragen sieht so aus:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Ausführliche Informationen zum Batch-Modus von Docs API-Aufrufen finden Sie unter Best Practices für Batchanfragen. Die Referenzdokumentation zu documents.batchUpdate für Anfrage- und Antworttypen ist ebenfalls verfügbar.
Batch-Aktualisierungsvorgänge
Es gibt verschiedene Arten von Batch-Aktualisierungsanfragen. Hier sehen Sie eine Übersicht der Anfragetypen, gruppiert in verschiedene Kategorien.
Weitere Informationen
- Struktur eines Google Docs-Dokuments
- Regeln und Funktionsweise der Strukturbearbeitung
- Batchanfragen