W tym przewodniku omawiamy główne metody żądań i odpowiedzi, które składają się na interfejs API Dokumentów Google, oraz sposoby aktualizowania dokumentu w partiach.
Interfejs API Dokumentów Google można wywołać przy użyciu żądania HTTP lub za pomocą metody w bibliotece klienta dla określonego języka. Te dwa typy reklam są do siebie podobne.
Interfejs Google Docs API zwraca odpowiedź HTTP, która zwykle zawiera wynik wywołania żądania. Jeśli do wysyłania żądań używasz biblioteki klienta, odpowiedzi są zwracane w sposób zależny od języka.
Metody żądania
Interfejs Docs API obsługuje te metody:
documents.create: utwórz pusty dokument w Dokumentach Google.documents.get: zwraca pełną instancję wskazanego dokumentu. Możesz przeanalizować zwrócony plik JSON, aby wyodrębnić treść dokumentu, formatowanie i inne funkcje.documents.batchUpdate: prześlij listę próśb o edycję, które mają być stosowane w dokumentach w postaci atomów, i zwróć listę wyników.
Metody documents.get i documents.batchUpdate wymagają parametru documentId, aby określić dokument docelowy. Metoda documents.create zwraca instancję utworzonego dokumentu, z którego możesz odczytać wartość documentId. Więcej informacji o documentId znajdziesz w sekcji Identyfikator dokumentu.
Aktualizacje zbiorcze
Metoda documents.batchUpdate pobiera listę obiektów request, z których każdy określa jedno żądanie do wykonania. Możesz na przykład sformatować akapit, a następnie dodać obraz w tekście. Każde żądanie jest weryfikowane przed zastosowaniem, a żądania są przetwarzane zgodnie z kolejnością, w jakiej występują w prośbie zbiorczej.
Wszystkie żądania w aktualizacji zbiorczej są stosowane pojedynczo. Oznacza to, że jeśli żądanie nie jest prawidłowe, cała aktualizacja kończy się niepowodzeniem i żadne z (potencjalnie zależnych) zmian nie zostaną zastosowane.
Niektóre metody documents.batchUpdate udostępniają odpowiedzi z informacjami o zastosowanych żądaniach. Te metody zwracają treść odpowiedzi, która zawiera listę obiektów response. Inne żądania nie muszą zwracać informacji i wyświetlają pustą odpowiedź. Obiekty na liście odpowiedzi zajmują tę samą kolejność indeksu co odpowiednie żądanie.
Popularny wzorzec przesyłania żądań zbiorczych:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Szczegółowe informacje o tym, jak grupować wywołania interfejsu API Dokumentów Google, znajdziesz w artykule Sprawdzone metody dotyczące żądań zbiorczych oraz w dokumentacji referencyjnej documents.batchUpdate dotyczącej typów żądań i odpowiedzi.
Operacje zbiorczej aktualizacji
Istnieją różne typy próśb o aktualizację zbiorczą. Oto podział typów żądań na różne kategorie.