Method: spreadsheets.batchUpdate

Stosuje co najmniej jedną aktualizację arkusza kalkulacyjnego.

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. Odpowiedzi będą odzwierciedlać prośby. Jeśli na przykład zastosujesz 4 aktualizacje, a 3 z nich będzie zawierać odpowiedź, w odpowiedzi znajdą się 2 puste odpowiedzi, rzeczywista odpowiedź i kolejna pusta odpowiedź w tej kolejności.

Ze względu na to, że arkusze kalkulacyjne są tworzone wspólnie, nie ma gwarancji, że po zakończeniu operacji arkusz będzie odzwierciedlał dokładnie Twoje zmiany. Masz jednak pewność, że aktualizacje w żądaniu zostaną zastosowane razem w sposób niepodzielny. Twoje zmiany mogą zostać zmodyfikowane w zależności od zmian wprowadzonych przez współpracowników. Jeśli nie ma współpracowników, arkusz kalkulacyjny powinien odzwierciedlać Twoje zmiany.

Żądanie HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
spreadsheetId

string

Arkusz kalkulacyjny, w którym mają zostać zastosowane aktualizacje.

Treść żądania

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

Zapis JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Pola
requests[]

object (Request)

Lista aktualizacji do zastosowania w arkuszu kalkulacyjnym. Żądania będą stosowane w kolejności, w jakiej zostały określone. Jeśli którekolwiek żądanie jest nieprawidłowe, żadne z nich nie zostanie zastosowane.
includeSpreadsheetInResponse

boolean

Określa, czy odpowiedź na aktualizację powinna zawierać zasób arkusza kalkulacyjnego.
responseRanges[]

string

Ogranicza zakresy uwzględnione w arkuszu kalkulacyjnym odpowiedzi. Ma znaczenie tylko wtedy, gdy pole includeSpreadsheetInResponse ma wartość „true” (prawda).
responseIncludeGridData

boolean

Wartość „prawda”, jeśli mają zostać zwrócone dane siatki. Ma znaczenie tylko wtedy, gdy pole includeSpreadsheetInResponse ma wartość „true” (prawda). Ten parametr jest ignorowany, jeśli w żądaniu ustawiono maskę pola.
commentsViewMode

enum (CommentsViewMode)

Tryb wyświetlania komentarzy, który ma być zastosowany w arkuszu kalkulacyjnym. Dzięki temu możesz wyświetlać arkusz kalkulacyjny z pominiętymi lub uwzględnionymi komentarzami. Jeśli nie zostanie określony, użyta zostanie wartość COMMENTS_VIEW_MODE_OMITTED. Ma znaczenie tylko wtedy, gdy pole includeSpreadsheetInResponse ma wartość „true” (prawda).

Treść odpowiedzi

Odpowiedź na zbiorczą aktualizację arkusza kalkulacyjnego.

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

Zapis JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Pola
spreadsheetId

string

Arkusz kalkulacyjny, w którym zastosowano zmiany.
replies[]

object (Response)

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

object (Spreadsheet)

Arkusz kalkulacyjny po zastosowaniu aktualizacji. Jest to ustawiane tylko wtedy, gdy BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response ma wartość true.
commentUpdateState

enum (CommentUpdateState)

Informacja o tym, czy w żądaniu zbiorczym zastosowano aktualizacje komentarzy.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Więcej informacji znajdziesz w przewodniku po autoryzacji.

CommentUpdateState

Stan aktualizacji komentarzy w żądaniu zbiorczym.

Wartości w polu enum
COMMENT_UPDATE_STATE_UNSPECIFIED Stan aktualizacji komentarzy jest nieokreślony.
NO_UPDATES_REQUESTED W żądaniu zbiorczym nie zażądano żadnych aktualizacji komentarzy.
ALL_SAVED W żądaniu zbiorczym zastosowano wszystkie żądane aktualizacje komentarzy.
ALL_FAILED_UNKNOWN_REASON Nie udało się zaktualizować wszystkich komentarzy.