문서

이 가이드에서는 API를 구성하는 주요 방법, Google Docs API, 문서에 액세스하는 방법, 문서를 만들 때 문서를 참조하세요.

API 메서드

documents 리소스는 다음과 같은 기능을 제공합니다. 문서 API를 호출하는 데 사용하는 메서드를 제공합니다. 다음 메서드를 사용하면 Docs 문서를 만들고, 읽고, 업데이트할 수 있습니다.

  • documents.create 사용 메서드를 사용하여 문서를 만들 수 있습니다.
  • documents.get 메서드 사용 지정된 문서의 콘텐츠를 검색합니다.
  • documents.batchUpdate 사용 메서드를 사용하여 지정된 문서에 대한 업데이트 집합을 원자적으로 수행할 수 있습니다.

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

문서 ID

documentId는 문서의 고유 식별자이며 파생될 수 있습니다. 추출해야 합니다. 문자와 숫자, 인코더-디코더 아키텍처를 특수 문자를 사용할 수 있습니다. 문서 ID는 문서 이름이 있습니다.

https://docs.google.com/document/d/DOCUMENT_ID/edit

다음 정규식을 사용하여 documentId Google Docs도구 URL:

/document/d/([a-zA-Z0-9-_]+)

Google Drive API에 익숙하다면 documentId은 id에 해당합니다. files 리소스에서 찾을 수 있습니다.

Google Drive에서 문서를 관리

Docs 파일은 Google의 클라우드 기반 저장소인 Google Drive에 저장됩니다. 있습니다. Docs API에는 자체 독립형 메서드가 있지만 Google Drive API 메서드를 사용하여 사용자의 문서 파일. 예를 들어 문서 파일을 복사하려면 다음을 사용하세요. Drive API의 files.copy 메서드를 사용하여 축소하도록 요청합니다. 자세한 내용은 기존 문서를 참조하세요.

기본적으로 Docs API를 사용하면 새 문서가 사용자의 드라이브 루트 폴더를 찾습니다. 파일 저장을 위한 옵션 Drive 폴더로 이동합니다. 자세한 내용은 Google Drive 폴더

Docs 파일로 작업하기

사용자의 내 드라이브에서 문서를 검색할 때 먼저 Drive의 files.list 메서드를 사용하여 파일의 ID입니다. 매개변수 없이 메서드를 호출하면 파일 및 폴더(ID 포함)를 삭제할 수 있습니다.

문서의 MIME 유형은 데이터 유형과 형식을 나타냅니다. MIME 유형 형식 문서 버전은 application/vnd.google-apps.document입니다. 목록의 MIME 유형(Google Workspace 및 Google Drive 지원 MIME 참고) 유형이 있습니다.

내 문서 내에서 문서 파일만 MIME 유형별로 검색하려면 다음 단계를 따르세요. Drive에 다음 쿼리 문자열 필터를 추가합니다.

q: mimeType = 'application/vnd.google-apps.document'

쿼리 문자열 필터에 대한 자세한 내용은 파일 및 검색 결과 폴더를 참조하세요.

documentId를 알게 되면 다음을 사용합니다. 가져올 documents.get 메서드 지정된 문서의 전체 인스턴스입니다. 자세한 내용은 요청 및 응답.

Google Workspace 문서 바이트 콘텐츠를 내보내려면 Drive의 files.export 메서드를 내보낼 파일의 documentId 및 올바른 내보내기 MIME 유형을 사용합니다. 자세한 내용은 내보내기 Google Workspace 문서 콘텐츠를 참조하세요.

Get 메서드와 List 메서드 비교

다음 표는 Drive 간의 차이점을 설명합니다. 및 Docs 메서드, 그리고 각 메서드와 함께 반환되는 데이터가 포함됩니다.

연산자 설명 사용
drive.files.get ID별로 파일의 메타데이터를 가져옵니다. files 리소스의 인스턴스를 반환합니다. 특정 파일의 메타데이터를 가져옵니다.
drive.files.list 사용자의 파일을 가져옵니다. 파일 목록을 반환합니다. 어떤 파일을 수정해야 하는지 잘 모르는 경우 사용자 파일 목록을 가져옵니다.
docs.documents.get 모든 서식 및 텍스트를 포함하여 지정된 문서의 최신 버전을 가져옵니다. documents 리소스의 인스턴스를 반환합니다. 특정 문서 ID의 문서를 가져옵니다.

문서 생성 워크플로

새 문서를 만들고 채우는 것은 간단합니다. 걱정해야 하고 문서 상태입니다. 개념적으로는 다음 순서와 같이 작동합니다. 다이어그램:

Google Cloud에서 제공하는 새 문서를 채웁니다
그림 1. 새 문서를 만들고 채우는 워크플로

그림 1에서 사용자는 documents 리소스에는 다음이 포함됩니다. 정보의 흐름이 있습니다.

  1. 앱에서 documents.create 메서드 사용 웹 서버입니다
  2. 웹 서버는 문서를 documents 리소스로 만들었습니다.
  3. 선택적으로 앱에서 documents.batchUpdate를 호출합니다. 메서드를 사용하여 일련의 수정 요청을 원자적으로 수행하여 문서를 채웁니다. 데이터를 얻을 수 있습니다.
  4. 웹 서버가 HTTP 응답을 보냅니다. 일부 documents.batchUpdate 메서드 적용된 요청에 대한 정보가 포함된 응답 본문을 제공하는 반면, 빈 응답이 표시되는 경우도 있습니다

문서 업데이트 워크플로

기존 문서를 업데이트하는 것은 더 복잡합니다. 의미 있는 결과를 얻기 전에 호출 시 현재 상태를 알아야 합니다. 즉, 어떤 요소가 해당 요소에 어떤 콘텐츠가 있는지, 요소 내 요소의 순서는 할 수 있습니다. 다음 시퀀스 다이어그램은 작동 방식을 보여줍니다.

배포를 업데이트하는 워크플로 문서를 참조하세요.
그림 2. 문서를 업데이트하는 워크플로입니다.

그림 2에서 documents 리소스와 상호작용하는 사용자에게는 다음과 같은 특징이 있습니다. 다음과 같은 정보 흐름이 있습니다.

  1. 앱에서 웹의 documents.get 메서드 찾을 파일의 documentId와 함께 가져옵니다.
  2. 웹 서버는 지정된 문서를 documents 리소스로 지정합니다. 반환된 JSON에는 문서 콘텐츠, 서식 및 기타 기능을 지원합니다.
  3. 사용자가 JSON을 파싱하여 업데이트.
  4. 앱은 documents.batchUpdate 메서드를 호출하여 집합을 원자적으로 실행합니다. 문서를 업데이트할 수 있습니다
  5. 웹 서버가 HTTP 응답을 보냅니다. 일부 documents.batchUpdate 메서드 적용된 요청에 대한 정보가 포함된 응답 본문을 제공하는 반면, 빈 응답이 표시되는 경우도 있습니다

이 다이어그램은 다른 사람이 동시에 업데이트하는 워크플로를 고려하지 않습니다. 문서 내에서 작업합니다. 자세한 내용은 권장사항 섹션 계획하기 공동작업을 할 수 있습니다.