이 가이드에서는 Google Docs API를 구성하는 기본 요청 및 응답 메서드와 문서를 일괄적으로 업데이트하는 방법을 소개합니다.
HTTP 요청을 사용하거나 언어별 클라이언트 라이브러리의 메서드 호출을 사용하여 Google Docs API를 호출할 수 있습니다. 이는 대체로 동일합니다.
Google Docs API가 일반적으로 요청 호출의 결과를 포함하는 HTTP 응답을 반환합니다. 클라이언트 라이브러리를 사용하여 요청할 경우 응답이 언어별로 반환됩니다.
요청 메서드
Docs API는 다음 메서드를 지원합니다.
documents.create
: 빈 Google Docs 문서를 만듭니다.documents.get
: 지정된 문서의 전체 인스턴스를 반환합니다. 반환된 JSON을 파싱하여 문서 콘텐츠, 서식, 기타 기능을 추출할 수 있습니다.documents.batchUpdate
: 문서에 원자적으로 적용할 수정 요청 목록을 제출하고 결과 목록을 반환합니다.
documents.get
및 documents.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)
Docs API 호출을 일괄 처리하는 방법에 대한 자세한 내용은 일괄 요청 권장사항을, 요청 및 응답 유형에 대한 documents.batchUpdate
참조 문서를 확인하세요.
일괄 업데이트 작업
일괄 업데이트 요청에는 다양한 유형이 있습니다. 다음은 여러 카테고리로 분류되는 요청 유형의 세부정보입니다.