Method: documents.batchUpdate

Wprowadza co najmniej 1 zmianę w dokumencie.

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

Niektóre żądania zawierają repliesinformacje na temat sposobu ich wykorzystywania. Inne żądania nie muszą zwracać informacji. Zwracają one pustą odpowiedź. Kolejność odpowiedzi jest zgodna z kolejnością żądań.

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

Dokument może nie odzwierciedlać dokładnie wprowadzane przez Ciebie zmiany, ponieważ inni użytkownicy mogą go edytować, dlatego Twoje zmiany mogą zostać zmodyfikowane w związku ze zmianami wprowadzonymi przez współpracowników. Jeśli nie ma współpracowników, zmiany powinny być widoczne w dokumencie. W każdym przypadku aktualizacje w żądaniu zostaną zastosowane razem atomowo.

Żą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 zmian do zastosowania w dokumencie.
writeControl

object (WriteControl)

Zapewnia kontrolę nad sposobem wykonywania żądań zapisu.

Treść odpowiedzi

Odpowiedź 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. Wynika to z tego 1:1 na podstawie aktualizacji, chociaż odpowiedzi na niektóre żądania mogą być puste.
writeControl

object (WriteControl)

Zaktualizowany element zapisu po zastosowaniu żądania.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 dotyczącym autoryzacji.

WriteControl

Zapewnia kontrolę nad sposobem 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 unii control. Określa wersję dokumentu, do której ma być zapisywany dokument, oraz sposób działania żądania, jeśli ta wersja nie jest bieżącą wersją dokumentu. Jeśli nie podasz żadnego pola, zmiany zostaną zastosowane do najnowszej wersji. control może mieć tylko jedną z tych wartości:
requiredRevisionId

string

Opcjonalny revision ID dokumentu, do którego ma być zastosowany zapis. Jeśli nie jest to najnowsza wersja dokumentu, żądanie nie zostanie przetworzone i zwróci błąd 400 „Złe żądanie”.

Gdy wymagany identyfikator wersji jest zwracany w odpowiedzi, wskazuje identyfikator wersji dokumentu po zastosowaniu żądania.
targetRevisionId

string

Opcjonalna wartość docelowa revision ID dokumentu, do którego zastosowano żądanie zapisu.

Jeśli zmiany wprowadzone przez współpracownika nastąpiły po odczytaniu dokumentu za pomocą interfejsu API, zmiany wprowadzone przez to żądanie zapisu zostaną zastosowane do zmian wprowadzonych przez współpracownika. Spowoduje to utworzenie nowej wersji dokumentu, która będzie uwzględniała zmiany wprowadzone przez współpracowników i zmiany w żądaniu, przy czym serwer Dokumentów usunie sprzeczne zmiany. Gdy używasz identyfikatora wersji docelowej, klient interfejsu API może być traktowany jako kolejny współpracownik w dokumencie.

Identyfikator wersji docelowej można używać tylko do zapisywania w najnowszych wersjach dokumentu. Jeśli wersja docelowa jest zbyt daleko w stosunku do najnowszej wersji, żądanie nie zostanie przetworzone i zwróci błąd 400. Po pobraniu najnowszej wersji dokumentu należy ponownie przesłać prośbę. Zwykle identyfikator wersji pozostaje ważny i może być używany jako wersja docelowa przez kilka minut po odczytaniu, ale w przypadku często edytowanych dokumentów to okno może być krótsze.