Omówienie interfejsu API Dokumentów Google

Interfejs Google Docs API umożliwia tworzenie i modyfikowanie dokumentów w Dokumentach Google.

Aplikacje mogą integrować się z interfejsem Docs API, aby tworzyć dopracowane dokumenty na podstawie danych dostarczonych przez użytkownika i system. Interfejs Docs API umożliwia:

  • automatyzację procesów;
  • zbiorcze tworzenie dokumentacji;
  • formatowanie dokumentów;
  • generowanie faktur lub umów;
  • pobieranie określonych atrybutów obiektów.

Oto lista najczęstszych terminów używanych w interfejsie Docs API:

Identyfikator dokumentu

Unikalny identyfikator dokumentu. Jest to określony ciąg znaków zawierający litery, cyfry i niektóre znaki specjalne, które odwołują się do dokumentu. Można go uzyskać z adresu URL dokumentu. Identyfikatory dokumentów są stałe, nawet jeśli nazwa dokumentu ulegnie zmianie. Więcej informacji o tym, jak znaleźć identyfikator, znajdziesz w artykule Identyfikator dokumentu.

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

Struktura, która tworzy dokument. Elementy najwyższego poziomu dokumentu to Body, DocumentStyle i List.

Dokument Google Workspace

Plik utworzony przez aplikację Google Workspace, np. Dokumenty Google. Format typu MIME dla Dokumentów to application/vnd.google-apps.document. Listę typów MIME znajdziesz w artykule Obsługiwane typy MIME w Google Workspace i na Dysku Google.

Indeks

Większość elementów w treści dokumentu ma właściwości startIndex i endIndex. Wskazują one przesunięcie początku i końca elementu względem początku otaczającego go segmentu.

Obraz w treści

Obraz, który pojawia się w tekście dokumentu. Nie jest to załącznik.

Zakres nazwany

Ciągły zakres tekstu. A NamedRange to zbiór zakresów o tym samym namedRangeId. Zakresy nazwane umożliwiają deweloperom powiązanie części dokumentu z dowolną etykietą zdefiniowaną przez użytkownika, dzięki czemu ich zawartość można później odczytać lub edytować automatycznie. Dokument może zawierać wiele zakresów nazwanych o tej samej nazwie, ale każdy zakres nazwany ma unikalny identyfikator.

Segment

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

Sugestia

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

  • Więcej informacji o tworzeniu aplikacji za pomocą interfejsów Google Workspace API, w tym o obsłudze uwierzytelniania i autoryzacji, znajdziesz w artykule Tworzenie aplikacji w Google Workspace.

  • Aby uzyskać ogólny opis dokumentu, przeczytaj artykuł Dokument.

  • Aby dowiedzieć się, jak skonfigurować i uruchomić aplikację korzystającą z interfejsu Docs API, zapoznaj się z przewodnikiem Szybki start w JavaScript.