Google Docs API를 효과적으로 사용하려면 Google Docs 문서의 아키텍처와 문서를 구성하는 요소 및 이들 간의 관계를 이해해야 합니다. 이 페이지에서는 이러한 주제에 대해 자세히 설명합니다.
- 문서 요소의 개념적 모델
- Docs API가 이러한 요소를 나타내는 방법
- 요소의 스타일 지정 속성
최상위 요소
Google Docs에서 가장 바깥에 있는 컨테이너 요소는 문서입니다. 이 단위는 Google Drive에 저장하고 다른 사용자와 공유하고 텍스트 및 이미지로 업데이트할 수 있습니다.
documents 리소스의 최상위 요소에는 Body, Header, Footer 및 여러 다른 속성이 포함됩니다.
document: {
body: ... ,
documentStyle: ... ,
lists: ... ,
documentId: ... ,
namedStyles: ... ,
revisionId: ... ,
title: ...
}
Body 콘텐츠 외부의 전역 문서 기능을 조작하려면 거의 항상 하나 이상의 문서 템플릿을 사용하는 것이 좋습니다. 문서 템플릿을 프로그래매틱 방식으로 새 문서를 생성하기 위한 기반으로 사용할 수 있습니다. 자세한 내용은 문서에 텍스트 병합을 참고하세요.
본문 콘텐츠
Body에는 일반적으로 전체 문서 콘텐츠가 포함됩니다. 프로그래매틱 방식으로 사용할 수 있거나 사용할 가능성이 높은 대부분의 항목은 Body 콘텐츠 내의 요소입니다.
구조 요소
StructuralElement는 문서에 구조를 제공하는 콘텐츠를 설명합니다. Body 콘텐츠는 StructuralElement 객체의 시퀀스입니다. 콘텐츠 요소는 다음 다이어그램과 같이 각 StructuralElement 객체를 맞춤설정합니다.
구조적 요소와 요소의 콘텐츠 객체에는 문서 내의 모든 시각적 구성요소가 포함됩니다. 여기에는 텍스트, 인라인 이미지, 서식이 포함됩니다.
단락 구조
Paragraph는 단락을 나타내는 StructuralElement입니다. 줄바꿈 문자로 끝나는 범위의 콘텐츠가 있습니다. 다음과 같은 객체로 구성됩니다.
ParagraphElement: 단락 내의 콘텐츠를 설명합니다.ParagraphStyle: 단락의 스타일 속성을 명시적으로 설정하는 선택적 요소입니다.Bullet: 단락이 목록의 일부인 경우 글머리 기호 사양을 제공하는 선택적 요소입니다.
ParagraphElement는 StructuralElement와 비슷하게 작동합니다. 콘텐츠 요소 유형 세트 (예: ColumnBreak 및 Equation)는 다음 다이어그램과 같이 자체 ParagraphElement를 맞춤설정합니다.
전체 문서 구조의 예는 JSON 형식의 문서 예를 참고하세요. 출력에서 여러 주요 구조 및 콘텐츠 요소를 확인할 수 있으며 다음 섹션에 설명된 대로 시작 색인과 끝 색인의 사용도 확인할 수 있습니다.
텍스트 실행
TextRun는 텍스트 스타일이 모두 동일한 연속된 텍스트 문자열을 나타내는 ParagraphElement입니다. 한 단락에 여러 텍스트 실행이 포함될 수 있지만 텍스트는 단락 경계를 넘지 않습니다. 줄바꿈 문자 뒤에 콘텐츠가 분할되어 별도의 텍스트 실행을 형성합니다. 예를 들어 다음과 같은 작은 문서를 살펴보겠습니다.
다음 다이어그램은 이전 문서의 단락 시퀀스를 시각화하는 방법을 보여줍니다(각각 고유한 TextRun 및 선택적 Bullet 설정).
AutoText
AutoText는 시간이 지남에 따라 변할 수 있는 콘텐츠로 동적으로 대체되는 텍스트의 한 지점을 나타내는 ParagraphElement입니다. Docs에서는 페이지 번호에 사용됩니다.
시작 및 종료 색인
문서의 내용을 업데이트할 때 각 업데이트는 문서 내 한 위치 또는 범위에서 실행됩니다. 이러한 위치와 범위는 포함된 문서 세그먼트 내의 오프셋을 나타내는 색인을 사용하여 지정됩니다. 세그먼트는 구조 또는 콘텐츠 요소를 포함하는 본문, 머리글, 바닥글 또는 각주입니다. 세그먼트 내 요소의 색인은 해당 세그먼트의 시작 부분을 기준으로 합니다.
본문 콘텐츠 내 대부분의 요소에는 0부터 시작하는 startIndex 및 endIndex 속성이 있습니다. 이는 둘러싸는 세그먼트의 시작을 기준으로 요소의 시작과 끝의 오프셋을 나타냅니다. Docs API 일괄 호출을 정렬하는 방법에 관한 자세한 내용은 일괄 업데이트를 참고하세요.
색인은 UTF-16 코드 단위로 측정됩니다. 즉, 서로게이트 쌍은 두 색인을 사용합니다. 예를 들어 'GRINNING FACE' 이모티콘은 \uD83D\uDE00로 표시되고 두 개의 색인을 사용합니다.
문서 본문 내의 요소의 경우 색인은 '루트' 요소인 본문 콘텐츠의 시작 부분의 오프셋을 나타냅니다.
구조적 요소의 '맞춤설정' 유형(SectionBreak, TableOfContents, Table, Paragraph)에는 인클로징된 StructuralElement에 이러한 필드가 있으므로 이러한 색인이 없습니다. 이는 TextRun, AutoText, PageBreak와 같은 ParagraphElement에 포함된 맞춤설정 유형에도 적용됩니다.
액세스 요소
많은 요소를 documents.batchUpdate 메서드로 수정할 수 있습니다. 예를 들어 InsertTextRequest를 사용하면 텍스트가 포함된 요소의 콘텐츠를 변경할 수 있습니다. 마찬가지로 UpdateTextStyleRequest를 사용하여 하나 이상의 요소에 포함된 텍스트 범위에 서식을 적용할 수 있습니다.
문서 요소를 읽으려면 documents.get 메서드를 사용하여 전체 문서의 JSON 덤프를 가져옵니다. 그런 다음 결과 JSON을 파싱하여 개별 요소의 값을 찾을 수 있습니다. 자세한 내용은 문서 콘텐츠를 JSON으로 출력을 참조하세요.
콘텐츠를 파싱하는 것은 다양한 사용 사례에서 유용할 수 있습니다. 예를 들어 찾은 문서를 나열하는 문서 카탈로그 애플리케이션을 생각해 보세요. 이 앱은 다음 다이어그램과 같이 문서의 제목, 버전 ID, 시작 페이지 번호를 추출할 수 있습니다.
이러한 설정을 명시적으로 읽는 메서드가 없으므로 앱은 문서 전체를 가져온 후 JSON을 파싱하여 이러한 값을 추출해야 합니다.
속성 상속
StructuralElement는 상위 객체의 속성을 상속할 수 있습니다. 정의한 속성과 상속된 속성을 비롯한 객체의 속성은 최종 시각적 모양을 결정합니다.
텍스트 문자 서식은 굵게, 기울임꼴, 밑줄 등 문서에서 텍스트가 렌더링되는 방식을 결정합니다. 적용하는 서식은 기본 단락의 TextStyle에서 상속된 기본 서식을 재정의합니다. 반대로 서식을 설정하지 않은 문자는 계속해서 단락의 스타일을 상속합니다.
단락 서식은 정렬, 테두리, 들여쓰기 등 문서에서 텍스트 블록이 렌더링되는 방식을 결정합니다. 적용하는 서식은 기본 ParagraphStyle에서 상속된 기본 형식을 재정의합니다.
반대로 설정하지 않은 모든 서식 지정 기능은 계속해서 단락 스타일에서 상속합니다.