Google Docs API – Übersicht

Mit der Google Docs API können Sie Dokumente in Google Docs erstellen und ändern.

Anwendungen können in die Docs API eingebunden werden, um ausgefeilte Dokumente sowohl aus Nutzer- als auch aus Systemdaten zu erstellen. Mit der Docs API können Sie:

  • Prozesse automatisieren
  • Dokumentation im Bulk erstellen
  • Dokumente formatieren
  • Rechnungen oder Verträge erstellen
  • Bestimmte Attribute von Objekten abrufen

Im Folgenden finden Sie eine Liste gebräuchlicher Begriffe, die in der Docs API verwendet werden:

Dokument-ID

Die eindeutige ID für ein Dokument. Es handelt sich dabei um einen bestimmten String, der Buchstaben, Ziffern und einige Sonderzeichen enthält, die auf ein Dokument verweisen und von der URL des Dokuments abgeleitet werden kann. Dokument-IDs sind stabil, auch wenn sich der Dokumentname ändert. Weitere Informationen zum Ermitteln der ID finden Sie unter Dokument-ID.

https://docs.google.com/document/d/DOCUMENT_ID/edit
Element

Die Struktur, aus der ein Dokument besteht. Zu den Elementen der obersten Ebene eines Dokuments gehören Body, DocumentStyle und List.

Google Workspace-Dokument

Eine Datei, die von einer Google Workspace-Anwendung wie Google Docs erstellt wird. Das MIME-Typ-Format für Docs ist application/vnd.google-apps.document. Eine Liste der MIME-Typen finden Sie unter Von Google Workspace und Google Drive unterstützte MIME-Typen.

Index

Die meisten Elemente im Inhaltstext haben die Eigenschaften startIndex und endIndex. Sie geben den Abstand zwischen Anfang und Ende eines Elements bezogen auf den Anfang des einschließenden Segments an.

Inline-Bild

Ein Bild, das im Textfluss in einem Dokument angezeigt wird. Es ist kein Anhang.

Benannter Bereich

Ein zusammenhängender Textbereich. Ein NamedRange ist eine Sammlung von Bereichen mit derselben namedRangeId. Mit benannten Bereichen können Entwickler Teile eines Dokuments mit einem beliebigen benutzerdefinierten Label verknüpfen, damit ihr Inhalt später programmatisch gelesen oder bearbeitet werden kann. Ein Dokument kann mehrere benannte Bereiche mit demselben Namen enthalten, aber jeder benannte Bereich hat eine eindeutige ID.

Segment

Body, Header, Footer oder Footnote mit strukturellen oder inhaltlichen Elementen. Die Indexe der Elemente in einem Segment beziehen sich auf den Anfang des Segments.

Vorschlag

Änderungen an einem Dokument, ohne den Originaltext zu ändern. Wenn der Inhaber die Vorschläge annimmt, wird der ursprüngliche Text durch diese ersetzt.

  • Weitere Informationen zur Entwicklung mit Google Workspace APIs, einschließlich der Authentifizierung und Autorisierung, finden Sie unter In Google Workspace entwickeln.

  • Eine konzeptionelle Übersicht über ein Dokument finden Sie unter Dokument.

  • Informationen zum Konfigurieren und Ausführen einer Docs API-Anwendung finden Sie in der JavaScript-Kurzanleitung.