Omówienie interfejsu API Dokumentów Google

Interfejs API Dokumentów Google pozwala tworzyć i modyfikować dokumenty w Dokumentach Google.

Aplikacje można zintegrować z interfejsem API Dokumentów, aby tworzyć dopracowane dokumenty na podstawie danych przekazywanych przez użytkowników i system. Interfejs Dokumenty API umożliwia:

  • Automatyzowanie procesów
  • Zbiorcze tworzenie dokumentacji
  • Formatowanie dokumentów
  • Generowanie faktur i umów
  • Pobieranie określonych atrybutów obiektów

Poniżej znajduje się lista typowych terminów używanych w interfejsie API Dokumentów:

Identyfikator dokumentu

Unikalny identyfikator dokumentu. Jest to konkretny ciąg zawierający litery, cyfry i niektóre znaki specjalne, które odwołują się do dokumentu. Może on pochodzić z adresu URL dokumentu. Identyfikatory dokumentów są stabilne, nawet jeśli zmieni się nazwa dokumentu. Więcej informacji o tym, jak znaleźć identyfikator dokumentu, znajdziesz w artykule Identyfikator dokumentu.

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

Struktura składająca się na dokument. Do elementów najwyższego poziomu dokumentu należą Body, DocumentStyle i List.

Dokument Google Workspace

Plik utworzony przez aplikację Google Workspace, na przykład Dokumenty Google. Format MIME w Dokumentach to application/vnd.google-apps.document. Listę typów MIME znajdziesz w artykule na temat obsługiwanych typów MIME w Google Workspace i na Dysku Google.

Indeks

Większość elementów w treści treści ma właściwości startIndex i endIndex. Określają one przesunięcie początku i końca elementu względem początku jego segmentu.

Obraz wbudowany

Obraz, który pojawia się w ciągu tekstu w dokumencie. To nie jest załącznik.

Zakres nazwany

Przylegający zakres tekstu. NamedRange to zbiór zakresów z takim samym atrybutem namedRangeId. Zakresy nazwane pozwalają programistom powiązać części dokumentu z dowolną etykietą zdefiniowaną przez użytkownika. Dzięki temu ich zawartość może być później automatycznie odczytywana lub edytowana. Dokument może zawierać wiele zakresów nazwanych o tej samej nazwie, ale każdy nazwany zakres ma unikalny identyfikator.

Segment

Body, Header, Footer lub Footnote zawierające elementy strukturalne lub treści. Indeksy elementów w segmencie są przedstawiane względem jego początku.

Sugestia

zmiany w dokumencie bez zmiany oryginalnego tekstu. Jeśli właściciel zatwierdzi Twoje sugestie, zastąpią one oryginalny tekst.

  • Więcej informacji o programowaniu z użyciem interfejsów Google Workspace API, w tym o obsłudze uwierzytelniania i autoryzacji, znajdziesz w artykule Programowanie w Google Workspace.

  • Ogólne omówienie dokumentu znajdziesz w sekcji Dokument.

  • Aby dowiedzieć się, jak skonfigurować i uruchomić aplikację interfejsu API Dokumentów, zapoznaj się z krótkim wprowadzeniem do JavaScriptu.