Żądania i odpowiedzi

Ten przewodnik przedstawia podstawowe metody żądania i odpowiedzi, które składają się na interfejs Google Docs API, oraz sposób aktualizowania dokumentu partiami.

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ą w dużej mierze równoważne.

Interfejs API Dokumentów Google zwraca odpowiedź HTTP, która zazwyczaj zawiera wynik powtórzenia żądania. Gdy do wysyłania żądań używasz biblioteki klienta, odpowiedzi są zwracane w sposób specyficzny dla języka.

Metody żądań

Interfejs API Dokumentów obsługuje następujące metody:

  • documents.create: utwórz pusty dokument Dokumentów Google.
  • documents.get: zwróć pełne wystąpienie określonego dokumentu. Możesz przeanalizować zwrócony kod JSON aby wyodrębnić zawartość dokumentu, formatowanie i inne funkcje.
  • documents.batchUpdate: Przesłać listę próśb o zmianę, które zostaną zastosowane osobno do dokumentu. wyświetli listę wyników.

Metody documents.get i documents.batchUpdate wymagają documentId jako parametr określający dokument docelowy. Metoda documents.create zwraca wystąpienie utworzonego dokumentu, z którego można odczytać documentId Więcej informacji na temat documentId znajdziesz w sekcji Dokument Identyfikator.

Aktualizacje zbiorcze

documents.batchUpdate pobiera listę request obiektów, każdy określając jedno żądanie do wykonania. Na przykład sformatuj akapit, a następnie dodaj obraz w tekście. Każda prośba jest weryfikowana przed zastosowaniem. są przetwarzane według kolejności, w jakiej występują w żądaniu zbiorczym.

Wszystkie żądania w aktualizacji zbiorczej są stosowane pojedynczo. Oznacza to, że jeśli jakaś prośba jest nieprawidłowa, cała aktualizacja się nie powiedzie i żadne (potencjalnie zależne).

Niektóre metody funkcji documents.batchUpdate podają w odpowiedziach informacje na temat: i zastosowanych żądań. Te metody zwracają odpowiedź ciało, które zawiera listę response obiektów. Inne żądania nie muszą zwracać informacji ani wyświetlać pustego pola odpowiedz. Obiekty na liście odpowiedzi zajmują tę samą kolejność indeksu co obiekt odpowiednie żądanie.

Popularny wzorzec tworzenia żądań zbiorczych wygląda tak:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Szczegółowe informacje znajdziesz w artykule Sprawdzone metody dotyczące żądań zbiorczych. jak grupować wywołania interfejsu API Dokumentów documents.batchUpdate. dokumentacji dotyczącej typów żądań i odpowiedzi.

Operacje zbiorczej aktualizacji

Istnieją różne typy zbiorczych żądań aktualizacji. Oto zestawienie typy żądań pogrupowane w różnych kategorii.

Obiekt DODAJ / WSTAW ZAKTUALIZUJ / ZASTĄP USUŃ
Tekst InsertTextRequest ReplaceAllTextRequest
Style CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
Zakresy nazwane CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
Obrazy InsertInlineImageRequest ReplaceImageRequest
Tabele InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
Obiekty strony (w tym nagłówki i stopki) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest