- Żądanie HTTP
- Parametry ścieżki
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Prośba
- ReplaceAllTextRequest
- SubstringMATCHCriteria
- InsertTextRequest
- Lokalizacja
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletsRequest
- BulletGlyphPreset
- DeleteParagraphBulletsRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- RequestTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplaceMethod
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- Typ stopki nagłówka
- CreatefooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeletefooterRequest
- PinTableHeaderRowsRequest
- WriteControl
- Odpowiedź
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetChartResponse
- CreateHeaderResponse
- CreatefooterResponse
- CreateFootnoteResponse
- Wypróbuj
Stosuje co najmniej jedną aktualizację do dokumentu.
Każdy request
jest sprawdzany przed zastosowaniem. Jeśli któreś z żądań jest nieprawidłowe, nie powiedzie się żadne żądanie.
Niektóre żądania zawierają dane replies
, które zawierają informacje o tym, jak je stosujemy. Inne żądania nie muszą zwracać informacji. Każde takie żądanie zwraca pustą odpowiedź. Kolejność odpowiedzi jest zgodna z kolejnością.
Załóżmy na przykład, że wywołujesz funkcję updateUpdate z 4 aktualizacjami i tylko 3 z nich zwraca informacje. Odpowiedź miałaby dwie puste odpowiedzi, odpowiedź na trzecie żądanie i kolejną pustą odpowiedź w tej kolejności.
Ponieważ inni użytkownicy mogą edytować ten dokument, dokument może nie odzwierciedlać dokładnie Twoich zmian: modyfikacje mogą dotyczyć tylko zmian współpracowników. Jeśli nie ma współpracowników, dokument powinien odzwierciedlać Twoje zmiany. W każdym przypadku aktualizacje w żądaniu są gwarantowane razem.
Żądanie HTTP
POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
documentId |
Identyfikator dokumentu do aktualizacji. |
Treść żądania
Treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "requests": [ { object ( |
Pola | |
---|---|
requests[] |
Lista aktualizacji, które mają być zastosowane w dokumencie. |
writeControl |
Zapewnia kontrolę nad sposobem wykonywania żądań zapisu. |
Treść odpowiedzi
Odpowiedź z żądania documents.batchUpdate
.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{ "documentId": string, "replies": [ { object ( |
Pola | |
---|---|
documentId |
Identyfikator dokumentu, do którego zostały zastosowane aktualizacje. |
replies[] |
Odpowiedź na aktualizacje. Odpowiada on mapom 1:1 zawierającym aktualizacje, chociaż odpowiedzi na niektóre żądania mogą być puste. |
writeControl |
Zaktualizowany element sterujący zapisem po zastosowaniu żądania. |
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
Więcej informacji znajdziesz w przewodniku po autoryzacji.
Element sterujący zapisu
Zapewnia kontrolę nad sposobem wykonywania żądań zapisu.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy control . Określa wersję dokumentu, w którym zostanie zapisany dokument, oraz sposób, w jaki powinno zachowywać się żądanie, jeśli nie jest to bieżąca wersja dokumentu. Jeśli żadne z tych pól nie jest określone, aktualizacje są stosowane do najnowszej wersji. control może mieć tylko jedną z tych wartości: |
|
requiredRevisionId |
Opcjonalny Zwrócony w odpowiedzi wymagany identyfikator wersji wskazuje identyfikator wersji dokumentu po zastosowaniu żądania. |
targetRevisionId |
Opcjonalny element docelowy Jeśli po odczytaniu dokumentu przy użyciu interfejsu API zaszły zmiany wprowadzone przez współpracownika, zmiany wygenerowane w wyniku tego żądania zapisu są stosowane względem zmian współpracowników. Spowoduje to utworzenie nowej wersji dokumentu, która będzie zawierać zarówno zmiany wprowadzone przez współpracownika, jak i zmiany w żądaniu. Serwer Dokumentów rozstrzyga zmiany w konflikcie. Gdy korzystasz z identyfikatora wersji docelowej, klienta API można traktować jako kolejnego współpracownika dokumentu. Identyfikatora wersji docelowej można używać tylko do zapisywania w ostatnich wersjach dokumentu. Jeśli wersja docelowa jest za daleko od najnowszej wersji, żądanie nie jest przetwarzane i zwraca błąd 400 (nieprawidłowe żądanie). Po pobraniu najnowszej wersji dokumentu spróbuj ponownie przesłać żądanie. Identyfikator wersji pozostaje zwykle ważny jako wersja docelowa przez kilka minut po odczytaniu, ale w przypadku często edytowanych dokumentów to okno może być krótsze. |