Omówienie interfejsu API Dokumentów Google

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

Aplikacje integrują się z interfejsem API Dokumentów, aby tworzyć dopracowane dokumenty na podstawie danych przekazywanych przez użytkowników i przez system. Interfejs Dokumentów API pozwala:

  • Automatyzacja procesów
  • Zbiorcze tworzenie dokumentacji
  • Formatowanie dokumentów
  • generować faktury i umowy;
  • Pobieranie określonych atrybutów obiektów

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

Identyfikator dokumentu

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

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

Struktura dokumentu. Najwyższe elementy dokumentu to Body, DocumentStyle i List.

Dokument Google Workspace

Plik tworzony przez aplikację Google Workspace, taką jak Dokumenty Google. Format typu MIME dla Dokumentów to application/vnd.google-apps.document. Listę typów MIME znajdziesz w artykule Typy MIME obsługiwane przez Google Workspace i Dysk Google.

Indeks

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

Obraz wbudowany

Obraz wyświetlany w toku tekstu w dokumencie. To nie jest załącznik.

Zakres nazwany

sąsiadujący zakres tekstu; NamedRange to zbiór zakresów z tym samym elementem namedRangeId. Zakresy nazwane pozwalają programistom powiązać fragmenty dokumentu z dowolną etykietą definiowaną przez użytkownika, dzięki czemu można programowo odczytać lub edytować ich zawartość. Dokument może zawierać wiele nazwanych zakresów o tej samej nazwie, ale każdy zakres nazwany ma unikalny identyfikator.

Segment

Body, Header, Footer lub Footnote zawierające elementy strukturalne lub treści. Indeksy elementów wewnątrz segmentu są określone względem jego początku.

Sugestia

Wprowadzanie zmian 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ólny opis dokumentu znajdziesz w sekcji Dokument.

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