Method: documents.batchUpdate

Stosuje w dokumencie co najmniej 1 aktualizację.

Każda request jest weryfikowana przed zastosowaniem. Jeśli którekolwiek żądanie jest nieprawidłowe, całe żądanie zakończy się niepowodzeniem i nic nie zostanie zastosowane.

Niektóre prośby mają ikonę replies, która zawiera informacje o sposobie ich zastosowania. Inne żądania nie muszą zwracać informacji. Każde z nich zwraca pustą odpowiedź. Kolejność odpowiedzi jest zgodna z kolejnością żądań.

Załóżmy na przykład, że wywołujesz batchUpdate z 4 aktualizacjami, a tylko trzecia z nich zwraca informacje. Odpowiedź będzie zawierać 2 puste odpowiedzi, odpowiedź na trzecie żądanie i kolejną pustą odpowiedź w tej kolejności.

Ponieważ inni użytkownicy mogą edytować dokument, może on nie odzwierciedlać dokładnie Twoich zmian. Mogą one zostać zmodyfikowane w odniesieniu do zmian wprowadzonych przez współpracowników. Jeśli nie ma współpracowników, dokument powinien odzwierciedlać Twoje zmiany. W każdym przypadku zmiany w Twoim żądaniu zostaną zastosowane razem w sposób niepodzielny.

Żądanie HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
documentId

string

Identyfikator dokumentu do zaktualizowania.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Pola
requests[]

object (Request)

Lista aktualizacji, które mają zostać zastosowane w dokumencie.
writeControl

object (WriteControl)

Umożliwia kontrolowanie sposobu wykonywania żądań zapisu.

Treść odpowiedzi

Wiadomość z odpowiedzią na żądanie documents.batchUpdate.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Pola
documentId

string

Identyfikator dokumentu, do którego zastosowano aktualizacje.
replies[]

object (Response)

Odpowiedź na aktualizacje. Jest to mapowanie 1:1 z aktualizacjami, chociaż odpowiedzi na niektóre żądania mogą być puste.
writeControl

object (WriteControl)

Zaktualizowana kontrola zapisu 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.

WriteControl

Umożliwia kontrolowanie sposobu wykonywania żądań zapisu.

Zapis JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Pola
Pole zbiorcze control. Określa wersję dokumentu, do której mają zostać zapisane zmiany, oraz sposób, w jaki żądanie powinno się zachowywać, jeśli ta wersja nie jest bieżącą wersją dokumentu. Jeśli nie podasz żadnego z tych pól, aktualizacje zostaną zastosowane do najnowszej wersji. control może mieć tylko jedną z tych wartości:
requiredRevisionId

string

Opcjonalny revision ID dokumentu, do którego stosowane jest żądanie zapisu. Jeśli nie jest to najnowsza wersja dokumentu, żądanie nie jest przetwarzane i zwraca błąd 400 (Nieprawidłowe żądanie).

Gdy w odpowiedzi zostanie zwrócony wymagany identyfikator wersji, oznacza to identyfikator wersji dokumentu po zastosowaniu żądania.
targetRevisionId

string

Opcjonalny cel revision ID dokumentu, do którego stosowane jest żądanie zapisu.

Jeśli po odczytaniu dokumentu za pomocą interfejsu API współpracownik wprowadził zmiany, zmiany wynikające z tej prośby o zapisanie zostaną zastosowane do zmian wprowadzonych przez współpracownika. W wyniku tego powstaje nowa wersja dokumentu, która zawiera zarówno zmiany wprowadzone przez współpracownika, jak i zmiany w prośbie. Serwer Dokumentów rozwiązuje konflikty. Gdy używasz docelowego identyfikatora wersji, klienta interfejsu API można traktować jako kolejnego współpracownika dokumentu.

Identyfikator wersji docelowej można używać tylko do zapisywania w najnowszych wersjach dokumentu. Jeśli wersja docelowa jest zbyt daleko w tyle za najnowszą wersją, żądanie nie jest przetwarzane i zwracany jest błąd 400 (Nieprawidłowe żądanie). Po pobraniu najnowszej wersji dokumentu należy ponownie wysłać prośbę. Zwykle identyfikator wersji pozostaje ważny jako wersja docelowa przez kilka minut po odczytaniu, ale w przypadku często edytowanych dokumentów ten okres może być krótszy.