Method: documents.batchUpdate

Powoduje zastosowanie do dokumentu co najmniej jednej aktualizacji.

Każdy element typu 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.

W przypadku niektórych żądań replies informuje o sposobie ich stosowania. W przypadku innych żądań nie trzeba zwracać informacji. Każdy z nich zwraca pustą odpowiedź. Kolejność odpowiedzi jest zgodna z kolejnością żądań.

Załóżmy na przykład, że wywołujesz funkcję wsad do aktualizacji z czterema aktualizacjami, a tylko trzecia zwraca informacje. Odpowiedź składa się z 2 pustych odpowiedzi: w tej kolejności: na 3 prośbę i drugiej pustej odpowiedzi.

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, wprowadzone 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 aktualizacji, które mają zostać zastosowane do dokumentu.
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 zostały zastosowane zmiany.
replies[]

object (Response)

Odpowiedź na aktualizacje. Wynika to z tego 1:1 na podstawie aktualizacji, chociaż odpowiedzi na niektóre prośby mogą być puste.
writeControl

object (WriteControl)

Zaktualizowany element sterujący zapisem 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 na temat 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 sumy control. Określa wersję dokumentu do zapisania i sposób zachowania żądania, jeśli ta wersja nie jest bieżącą wersją 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

string

Opcjonalny revision ID dokumentu, do którego zastosowano żądanie zapisu. Jeśli nie jest to najnowsza wersja dokumentu, żądanie nie zostanie przetworzone i zwróci błąd 400.

Jeśli w odpowiedzi zostanie zwrócony wymagany identyfikator wersji, wskazuje on identyfikator wersji dokumentu po zastosowaniu żądania.
targetRevisionId

string

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

Jeśli po odczytaniu dokumentu za pomocą interfejsu API nastąpiły zmiany dotyczące współpracowników, zostaną one zastosowane do zmian wprowadzonych przez współpracowników. 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.

Identyfikatora wersji docelowej można używać tylko do zapisywania najnowszych wersji 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 ponowić próbę. Zwykle identyfikator wersji pozostaje ważny i może być używany jako wersja docelowa przez kilka minut po jej odczytaniu, ale w przypadku często edytowanych dokumentów to okno może być krótsze.