Google Docs API를 사용하면 문서를 만들고 수정할 수 있습니다.
앱은 Docs API와 통합하여 사용자 제공 데이터와 시스템 제공 데이터 모두에서 세련된 문서를 만들 수 있습니다. 이 API를 사용하면 다음 작업을 할 수 있습니다.
- 프로세스 자동화
- 문서 일괄 만들기
- 인보이스 또는 계약 생성
API 개요
documents 리소스는 Docs API를 호출하는 데 사용하는 메서드를 제공합니다.
API 메서드
다음 방법을 사용하면 Google Docs 문서를 만들고, 읽고, 업데이트할 수 있습니다.
- documents.create를 사용하여 문서를 만듭니다.
- documents.get을 사용하여 지정된 문서의 콘텐츠를 검색합니다.
- documents.batchUpdate를 사용하여 지정된 문서에 대한 업데이트를 원자적으로 수행합니다.
get 및 batchUpdate 메서드의 경우 documentId (아래 참고)를 참고하여 대상 문서를 지정해야 합니다. create 메서드는 생성된 문서의 인스턴스를 반환하여 ID를 읽을 수 있습니다.
일괄 업데이트
batchUpdate 메서드는 요청 객체 목록을 가져오고 일괄 요청에 표시되는 순서와 동일하게 업데이트합니다. 일괄 업데이트의 업데이트는 원자적으로 적용됩니다. 즉, 유효하지 않은 요청이 있으면 전체 업데이트가 실패하고 (잠재적으로 종속된) 변경사항이 적용되지 않습니다.
batchUpdate 메서드는 응답 객체 목록을 반환합니다. 이 목록의 객체는 해당 요청과 동일한 색인 순서를 따릅니다.
API 호출을 일괄 처리하는 방법은 일괄 요청 권장사항을, 요청 및 응답 유형은 batchUpdate 참조 문서를 확인하세요.
문서 ID
문서 ID는 문서를 참조하며 다음 URL에서 파생될 수 있습니다.
https://docs.google.com/document/d/documentId/edit
documentId는 문자, 숫자 및 일부 특수문자가 포함된 고유한 문자열입니다. 다음 정규 표현식을 사용하여 Google Docs URL에서 문서 ID를 추출할 수 있습니다.
/document/d/([a-zA-Z0-9-_]+)
Google Drive API에 익숙한 경우 documentId는 파일 리소스의 ID에 해당합니다.
문서 내 위치: 색인
문서의 콘텐츠를 업데이트하면 각 업데이트는 문서 내 특정 위치 또는 범위의 범위에서 이루어집니다. 이러한 위치와 범위는 포함하는 문서 세그먼트 내 오프셋을 나타내는 색인을 사용하여 지정됩니다. 색인과 그 사용 방법에 대한 자세한 내용은 Google Docs의 구조 문서 개념 가이드를 참조하세요.
문서 업데이트 워크플로
걱정할 기존 콘텐츠가 없고 문서 상태를 변경할 수 있는 공동작업자가 없으므로 새 문서를 만들고 채우는 방법은 간단합니다. 개념적으로 다음 시퀀스 다이어그램과 같이 작동합니다.
기존 문서를 업데이트하는 작업은 더 복잡합니다. 문서를 업데이트하기 위해 의미 있는 호출을 하려면 먼저 문서의 현재 상태, 즉 문서를 구성하는 요소, 이러한 요소에 포함된 콘텐츠, 문서 내에서 이러한 모든 항목의 위치를 알아야 합니다. 다음 시퀀스 다이어그램은 작동 방식을 보여줍니다.
이 다이어그램은 다른 문서에서 동시에 다른 공동작업자가 수행하는 워크플로는 고려하지 않습니다. 이 주제에 대한 설명은 공동작업 계획을 참조하세요.