요청 및 응답

이 가이드에서는 Google Docs API를 구성하는 기본 요청 및 응답 메서드와 문서를 일괄 업데이트하는 방법을 소개합니다.

HTTP 요청 또는 메서드 언어별 클라이언트 라이브러리에서 호출 이는 대체로 동일합니다.

Google Docs API는 일반적으로 결과가 포함된 HTTP 응답을 반환합니다. 요청 호출의 전체 크기입니다. 클라이언트 라이브러리를 사용하여 요청을 수행할 때 언어별 방식으로 반환됩니다.

요청 메서드

Docs API는 다음 메서드를 지원합니다.

  • documents.create: 빈 Google Docs 문서를 만듭니다.
  • documents.get: 지정된 문서의 전체 인스턴스입니다. 반환된 JSON을 문서 콘텐츠, 서식 및 기타 기능을 추출합니다.
  • documents.batchUpdate: 문서에 원자적으로 적용할 수정 요청 목록을 제출합니다. 결과 목록을 반환합니다.

documents.getdocuments.batchUpdate 메서드에는 documentId가 필요합니다. 를 매개변수로 사용하여 대상 문서를 지정합니다. documents.create 메서드 는 생성된 문서의 인스턴스를 반환하며, 여기에서 documentId입니다. documentId에 대한 자세한 내용은 문서 ID를 참고하세요.

일괄 업데이트

documents.batchUpdate 메서드는 request 객체(각각 하나씩) 단일 요청을 지정하여 수행할 수 있습니다 예를 들어 단락의 서식을 지정한 다음 인라인 이미지를 추가합니다. 각 요청은 적용 전에 검증되며 요청은 일괄 요청에 나타나는 순서에 따라 처리됩니다.

일괄 업데이트의 모든 요청은 원자적으로 적용됩니다. 즉, 만약 요청이 유효하지 않은 경우 전체 업데이트가 실패하고 변경사항이 적용됩니다.

일부 documents.batchUpdate 메서드는 확인할 수 있습니다 이러한 메서드는 응답을 반환합니다. 본문response 목록 포함 객체입니다. 다른 요청은 정보를 반환할 필요가 없으며 빈 답글 달기 응답 목록의 객체는 요청을 수행합니다.

일괄 요청을 할 때 많이 사용되는 패턴은 다음과 같습니다.

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

다음에 관한 자세한 내용은 일괄 요청 권장사항을 참고하세요. 문서 API 호출을 일괄 처리하는 방법과 documents.batchUpdate 요청 및 응답 유형에 대한 참조 문서를 확인하세요.

일괄 업데이트 작업

일괄 업데이트 요청에는 다양한 유형이 있습니다. 이 분류는 다음과 같습니다. 요청 유형으로 그룹화되며 확인할 수 있습니다

객체 추가 / 삽입 업데이트 / 교체 삭제
텍스트 InsertTextRequest ReplaceAllTextRequest
스타일 CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
이름이 지정된 범위 CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
이미지 InsertInlineImageRequest ReplaceImageRequest
테이블 InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
페이지 객체 (머리글바닥글 포함) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest