Anfragen und Antworten

In diesem Leitfaden werden die primären Anfrage- und Antwortmethoden vorgestellt, aus denen die Google Docs API und wie Sie Dokumente stapelweise aktualisieren können.

Sie können die Google Docs API mit einer HTTP-Anfrage oder mithilfe einer Methode aufrufen. in einer sprachspezifischen Clientbibliothek aufgerufen. Diese sind weitgehend äquivalent.

Die Google Docs API gibt eine HTTP-Antwort zurück, die im Allgemeinen das Ergebnis des Anfrageaufrufs. Wenn Sie eine Clientbibliothek für Anfragen verwenden, werden die Antworten sprachspezifisch 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. Sie können den zurückgegebenen JSON-Code zum Extrahieren des Dokumentinhalts, der Formatierung und anderer Funktionen.
  • documents.batchUpdate: Sie senden eine Liste mit Bearbeitungsanfragen, die in kleinstmöglichen Schritten auf das Dokument angewendet werden sollen. eine Liste mit Ergebnissen zurückgeben.

Für die Methoden documents.get und documents.batchUpdate ist ein documentId erforderlich als Parameter zum Angeben des Zieldokuments an. Die Methode documents.create gibt eine Instanz des erstellten Dokuments zurück, aus der das documentId. Weitere Informationen zu documentId finden Sie unter Document ID fest.

Batch-Updates

Die documents.batchUpdate enthält eine Liste mit request Objekte, jedes einzelne und dabei eine einzelne auszuführende Anfrage angeben. Formatieren Sie z. B. einen Absatz und dann ein Inline-Bild hinzufügen. Jede Anfrage wird überprüft, bevor sie angewendet wird, und der -Anfragen werden in der Reihenfolge verarbeitet, in der sie in der Batchanfrage aufgeführt sind.

Alle Anfragen in der Batchaktualisierung werden in kleinstmöglichen Schritten angewendet. Das heißt, wenn eine Anfrage nicht gültig ist, ist das gesamte Update fehlgeschlagen und keine der Änderungen angewendet werden.

Einige documents.batchUpdate-Methoden liefern Antworten mit Informationen zu angewendeten Anfragen. Diese Methoden geben eine Antwort zurück Text enthält eine Liste mit response Objekte. Andere Anfragen müssen keine Informationen zurückgeben und eine leere Antwort zurückgeben. Die Objekte in der Antwortliste belegen dieselbe Indexreihenfolge wie die Objekte in der Antwortliste. der entsprechenden 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 finden Sie in den Best Practices für Batchanfragen. wie Sie Ihre Docs API-Aufrufe stapeln documents.batchUpdate Referenzdokumentation für Anfrage- und Antworttypen.

Batch-Aktualisierungsvorgänge

Es gibt verschiedene Arten von Batch-Aktualisierungsanfragen. Hier ist eine Aufschlüsselung der Anfragetypen gruppiert in in verschiedenen Kategorien.

Object HINZUFÜGEN / EINFÜGEN AKTUALISIEREN / ERSETZEN LÖSCHEN
Text InsertTextRequest ReplaceAllTextRequest
Stile CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
Benannte Bereiche CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
Bilder InsertInlineImageRequest ReplaceImageRequest
Tabellen InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
Seitenobjekte, einschließlich Kopfzeilen und Fußzeilen InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest