Interfejs API Dokumentów Google umożliwia tworzenie i modyfikowanie dokumentów.
Aplikacje można integrować z interfejsem API Dokumentów, aby tworzyć dopracowane dokumenty na podstawie danych dostarczonych przez użytkownika i system. Interfejs API umożliwia:
- Automatyzacja procesów
- Zbiorcze tworzenie dokumentacji
- Generowanie faktur i umów
Omówienie interfejsu API
Zasób documents udostępnia metody, których używasz do wywoływania interfejsu API Dokumentów.
Metody API
Poniższe metody umożliwiają tworzenie, odczytywanie i aktualizowanie dokumentów Google:
- Utwórz dokument, korzystając z pliku documents.create.
- Użyj pliku documents.get, aby pobrać zawartość określonego dokumentu.
- Użyj metody documents.batchUpdate, aby uzyskać atomowy zestaw aktualizacji określonego dokumentu.
Metody get i batchUpdate wymagają parametru documentId (patrz niżej) jako parametru określającego dokument docelowy. Metoda create zwraca instancję utworzonego dokumentu, z której możesz odczytać identyfikator.
Aktualizacje zbiorcze
Metoda batchUpdate pobiera listę obiektów żądań i aktualizuje je w tej samej kolejności co żądanie zbiorcze. Aktualizacje w aktualizacji zbiorczej są stosowane atomowo. Oznacza to, że jeśli któreś z żądań jest nieprawidłowe, cała aktualizacja się nie powiedzie i nie zostaną zastosowane żadne zmiany (potencjalnie zależne).
Metoda batchUpdate zwraca listę obiektów odpowiedzi. Obiekty na tej liście zajmują tę samą kolejność indeksowania co odpowiednie żądanie.
Zapoznaj się ze sprawdzonymi metodami dotyczącymi żądań zbiorczych, aby dowiedzieć się, jak zbiorczo wywoływać wywołania interfejsu API. Zapoznaj się też z dokumentacją batchUpdate dotyczącą typów żądań i odpowiedzi.
Identyfikator dokumentu
Identyfikatory dokumentów odwołują się do dokumentów i można je uzyskać z adresu URL:
https://docs.google.com/document/d/documentId/edit
documentId to unikalny ciąg zawierający litery, cyfry i znaki specjalne. Aby wyodrębnić identyfikator dokumentu z adresu URL Dokumentów Google, możesz użyć tego wyrażenia regularnego:
/document/d/([a-zA-Z0-9-_]+)
Jeśli znasz interfejs Google Drive API, documentId odpowiada identyfikatorowi zasobu File.
Lokalizacje w dokumencie: indeksy
Gdy aktualizujesz treść dokumentu, każda zmiana następuje w lokalizacji lub w całym zakresie dokumentu. Te lokalizacje i zakresy określa się za pomocą indeksów, które reprezentują przesunięcie w obrębie segmentu zawierającego dokument. Więcej informacji o indeksach i sposobach ich używania znajdziesz w przewodniku po strukturze Dokumentów Google.
Przepływ pracy przy aktualizacji dokumentów
Tworzenie i zapełnianie nowych dokumentów jest proste, ponieważ nie trzeba się nimi przejmować. Nie ma też współpracowników, którzy mogliby zmienić stan dokumentu. Zasadniczo działa to w następujący sposób:
Aktualizowanie istniejącego dokumentu jest bardziej złożone. Przed wywołaniem funkcji aktualizacji w celu zaktualizowania dokumentu musisz poznać jego bieżący stan: jakie elementy się w nim znajdują, jakie treści się w nich znajdują i gdzie się znajdują. Ten diagram sekwencji pokazuje, jak to działa:
Ten diagram nie uwzględnia przepływów pracy, w których wykonywane są jednocześnie aktualizacje przez innych współpracowników w tym samym dokumencie. Więcej informacji na ten temat znajdziesz w artykule Planowanie współpracy.