Method: documents.batchUpdate

Powoduje zastosowanie do dokumentu co najmniej jednej aktualizacji.

Każdy request jest weryfikowany przed zastosowaniem. Jeśli którakolwiek prośba jest nieprawidłowa, cała prośba zostanie odrzucona i nie zostanie zastosowana.

Niektóre żądania mają przycisk replies, który zawiera informacje o sposobie ich zastosowania. Inne żądania nie muszą zwracać informacji. Zwracają one pustą odpowiedź. Kolejność odpowiedzi odpowiada 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.

Ponieważ inni użytkownicy mogą edytować dokument, może on nie odzwierciedlać dokładnie Twoich zmian: Twoje zmiany mogą zostać zmienione w stosunku do zmian wprowadzonych 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 zmian do zastosowania w dokumencie.
writeControl

object (WriteControl)

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

Treść odpowiedzi

Wiadomość z odpowiedzią na prośbę 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 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 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 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 z tych pól, zmiany zostaną zastosowane do najnowszej wersji. control może być tylko jednym z tych elementów:
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.

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

string

Opcjonalny obiekt docelowy revision ID dokumentu, do którego ma być zastosowane żą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ółautor dokumentu.

Identyfikator wersji docelowej można używać tylko do zapisywania najnowszych wersji dokumentu. Jeśli wersja docelowa jest zbyt odległa od najnowszej wersji, żądanie nie zostanie przetworzone i zwróci błąd 400 „Zła prośba”. Po pobraniu najnowszej wersji dokumentu należy ponowić próbę. Zwykle identyfikator poprawki pozostaje ważny przez kilka minut po odczytaniu, ale w przypadku często edytowanych dokumentów ten czas może być krótszy.