- HTTP 요청
- 경로 매개변수
- 요청 본문
- 응답 본문
- 승인 범위
- 요청
- ReplaceAllTextRequest
- SubstringMatchCriteria
- InsertTextRequest
- 위치
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletRequest
- 글머리기호
- DeleteParagraphBulletRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- DeleteTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplace메서드
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- HeaderFooterType
- CreateFooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeleteFooterRequest
- PinTableHeaderRowsRequest
- WriteControl
- 응답
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- 실습
문서에 하나 이상의 업데이트를 적용합니다.
각 request
는 적용되기 전에 확인됩니다. 유효하지 않은 요청이 있으면 전체 요청이 실패하고 아무것도 적용되지 않습니다.
일부 요청에는 적용되는 방식에 관한 정보를 제공하는 replies
가 있습니다. 다른 요청은 정보를 반환할 필요가 없습니다. 이러한 요청은 모두 빈 응답을 반환합니다. 답장 순서는 요청의 순서와 일치합니다.
예를 들어, 업데이트 4개가 포함된 batchUpdate를 호출하고 세 번째 업데이트만 정보를 반환한다고 가정해 보겠습니다. 응답에 2개의 빈 응답, 즉 세 번째 요청에 대한 응답과 빈 응답이 순서대로 포함됩니다.
다른 사용자가 문서를 수정하고 있을 수 있으므로 문서에 변경사항이 정확하게 반영되지 않을 수 있습니다. 변경사항은 공동작업자 변경사항과 관련하여 변경될 수 있습니다. 공동작업자가 없는 경우 문서에는 변경사항이 반영되어야 합니다. 어떤 경우든 요청의 업데이트는 원자적으로 함께 적용됩니다.
HTTP 요청
POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
documentId |
업데이트할 문서의 ID입니다. |
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "requests": [ { object ( |
필드 | |
---|---|
requests[] |
문서에 적용할 업데이트 목록입니다. |
writeControl |
쓰기 요청이 실행되는 방식을 제어합니다. |
응답 본문
documents.batchUpdate
요청의 응답 메시지입니다.
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{ "documentId": string, "replies": [ { object ( |
필드 | |
---|---|
documentId |
업데이트가 적용된 문서의 ID입니다. |
replies[] |
업데이트의 답장입니다. 업데이트와 1:1로 매핑되지만 일부 요청에 대한 응답은 비어 있을 수 있습니다. |
writeControl |
요청을 적용한 후 업데이트된 쓰기 제어 |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/documents
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
자세한 내용은 승인 가이드를 참고하세요.
쓰기 제어
쓰기 요청이 실행되는 방식을 제어합니다.
JSON 표현 |
---|
{ // Union field |
필드 | |
---|---|
통합 필드 control . 쓸 문서의 버전과 이 버전이 문서의 현재 버전이 아닌 경우 요청이 어떻게 동작할지 결정합니다. 필드를 하나도 지정하지 않으면 업데이트가 최신 버전에 적용됩니다. control 은 다음 중 하나여야 합니다. |
|
requiredRevisionId |
쓰기 요청이 적용되는 문서의 선택적 필수 버전 ID가 응답에서 반환되면 요청이 적용된 후 문서의 버전 ID를 나타냅니다. |
targetRevisionId |
쓰기 요청이 적용되는 문서의 선택적 대상 API를 사용하여 문서를 읽은 후 공동작업자 변경사항이 발생한 경우 쓰기 요청에 의해 생성된 변경사항이 공동작업자 변경사항에 적용됩니다. 이로 인해 공동작업자의 변경사항 및 요청의 변경사항이 모두 통합된 새로운 문서가 개정되어 Docs 서버에서 충돌하는 변경사항을 해결합니다. 대상 버전 ID를 사용할 때 API 클라이언트는 문서의 다른 공동작업자로 간주될 수 있습니다. 대상 버전 ID는 문서의 최신 버전에만 쓸 수 있습니다. 대상 버전이 최신 버전보다 너무 뒤처지면 요청이 처리되지 않고 400 잘못된 요청 오류를 반환합니다. 최신 버전의 문서를 검색한 후 요청을 다시 시도해야 합니다. 일반적으로 버전 ID는 읽은 후 몇 분 동안 타겟 버전으로 사용할 수 있지만, 자주 수정되는 문서의 경우 이 기간이 더 짧을 수 있습니다. |