Method: spreadsheets.batchUpdate

스프레드시트에 하나 이상의 업데이트를 적용합니다.

request는 적용 전에 검증됩니다. 유효하지 않은 요청이 있으면 전체 요청이 실패하고 아무 것도 적용되지 않습니다.

일부 요청에는 적용 방식에 관한 정보를 제공하는 replies가 있습니다. 응답은 요청을 미러링합니다. 예를 들어 업데이트를 4번 적용했고 세 번째 업데이트에 답장이 있는 경우 응답에 비어 있는 답장 2개(실제 답장, 다른 빈 답장)가 순서대로 표시됩니다.

스프레드시트의 공동작업 특성으로 인해 이 작업이 완료된 후 스프레드시트에 변경사항이 정확하게 반영되지 않을 수 있지만 요청의 업데이트는 원자적으로 함께 적용됩니다. 내 변경사항은 공동작업자 변경사항과 관련하여 변경될 수 있습니다. 공동작업자가 없는 경우 스프레드시트에 변경사항이 반영됩니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
spreadsheetId

string

업데이트를 적용할 스프레드시트입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
필드
requests[]

object (Request)

스프레드시트에 적용할 업데이트 목록입니다. 요청은 지정된 순서대로 적용됩니다. 유효하지 않은 요청이 있으면 요청이 적용되지 않습니다.

includeSpreadsheetInResponse

boolean

업데이트 응답에 스프레드시트 리소스를 포함해야 하는지 결정합니다.

responseRanges[]

string

응답 스프레드시트에 포함되는 범위를 제한합니다. includeSpreadsheetInResponse가 'true'인 경우에만 의미가 있습니다.

responseIncludeGridData

boolean

그리드 데이터를 반환해야 하는 경우 true입니다. includeSpreadsheetInResponse가 'true'인 경우에만 의미가 있습니다. 요청에 필드 마스크가 설정된 경우 이 매개변수는 무시됩니다.

응답 본문

스프레드시트 일괄 업데이트에 대한 답변입니다.

성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.

JSON 표현
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
필드
spreadsheetId

string

업데이트가 적용된 스프레드시트입니다.

replies[]

object (Response)

업데이트의 답장입니다. 이렇게 하면 업데이트와 1:1로 매핑되지만 일부 요청에 대한 응답은 비어 있을 수 있습니다.

updatedSpreadsheet

object (Spreadsheet)

업데이트가 적용된 후의 스프레드시트입니다. BatchUpdateSpreadsheetRequest.include_spreadsheet_in_responsetrue인 경우에만 설정됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참조하세요.