Google Docs API – Übersicht

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

Anwendungen können die Docs API einbinden, um aus Nutzer- und systemeigenen Daten ansprechende Dokumente zu erstellen. Mit der Docs API können Sie Folgendes tun:

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

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

Dokument-ID

Die eindeutige Kennung für ein Dokument. Es ist ein bestimmter String, der Buchstaben, Zahlen und einige Sonderzeichen enthält, die auf ein Dokument verweisen. Er kann aus der URL des Dokuments abgeleitet werden. Die Dokument-IDs bleiben gleich, auch wenn sich der Dokumentname ändert. Weitere Informationen zum Finden der ID finden Sie unter Dokument-ID.

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

Die Struktur eines Dokuments. 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. Der MIME-Typ für Google Docs lautet application/vnd.google-apps.document. Eine Liste der MIME-Typen finden Sie unter Unterstützte MIME-Typen für Google Workspace und Google Drive.

Index

Die meisten Elemente im Inhaltstext haben die Eigenschaften startIndex und endIndex. Sie geben den Versatz des Anfangs und des Endes eines Elements relativ zum Anfang des umschließenden Segments an.

Inline-Bild

Ein Bild, das im Textfluss eines Dokuments erscheint. 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 einem beliebigen benutzerdefinierten Label zuordnen, damit deren Inhalt später programmatisch gelesen oder bearbeitet werden kann. Ein Dokument kann mehrere benannte Bereiche mit demselben Namen enthalten. Jeder benannte Bereich hat jedoch eine eindeutige ID.

Segment

Body, Header, Footer oder Footnote mit Elementen für Struktur oder Inhalt Die Indexe der Elemente innerhalb eines Segments beziehen sich auf den Beginn dieses Segments.

Vorschlag

Änderungen an einem Dokument, ohne den ursprünglichen Text zu verändern. Wenn der Eigentümer des Dokuments die Änderungen annimmt, ersetzen diese den ursprünglichen Text an den entsprechenden Stellen.

  • Informationen zum Entwickeln mit Google Workspace APIs, einschließlich der Authentifizierung und Autorisierung, finden Sie unter Mit 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.