Google Docs API를 효과적으로 사용하려면 Google Docs의 아키텍처와 문서를 구성하는 요소들을 이들 간의 관계를 이해하는 데 도움이 됩니다. 이 페이지에서는 자세한 내용은
- 문서 요소의 개념적 모델
- Docs API가 이러한 요소를 나타내는 방법
- 요소의 스타일 속성
최상위 요소
Google 문서에서 가장 바깥쪽에 있는 컨테이너 요소는 문서입니다. 이것은 Google Drive에 저장하고, 다른 사용자와 공유하고, 업데이트할 수 있는 파일 단위입니다. 텍스트 및 이미지로 구성됩니다.
documents
의 최상위 요소
리소스에는 Tab
가 포함됩니다.
SuggestionsViewMode
,
기타 속성:
document: { title: ... , revisionId: ... , documentId: ... , suggestionsViewMode: ... , tabs: ... }
탭
단일 문서는 여러 탭을 포함할 수 있습니다.
텍스트 수준의 콘텐츠가 다를 수 있습니다. 문서의 tabs
속성은
Tab
객체의 시퀀스입니다. Tab
는 다음 필드로 구성됩니다.
TabProperties
: ID, 제목, 색인과 같은 탭의 속성을 포함합니다.childTabs
: 탭의 하위 탭 (직접 중첩된 탭)을 노출합니다. 를 클릭합니다.DocumentTab
: 탭의 텍스트 콘텐츠를 나타냅니다.
이후 섹션에서는 문서 탭 계층 구조에 대한 간략한 개요를 제공합니다. 탭 JSON 표현도 를 참조하세요. 탭 사용을 참고하세요. 를 참조하세요.
Body
콘텐츠 외부의 전체 문서 탭 기능을 조작하려면 다음을 실행합니다.
하나 이상의 문서 템플릿을 사용하는 것이 더 좋으며,
프로그래매틱 방식으로 새 문서를 생성하기 위한 기반이 됩니다. 자세한 내용은
문서에 텍스트 병합
본문 콘텐츠
Body
에는 일반적으로 문서 탭의 전체 콘텐츠가 포함됩니다. 대부분의
사용할 수 있거나 사용할 가능성이 있는 항목은
Body
콘텐츠:
구조 요소
StructuralElement
는 문서에 구조를 제공하는 콘텐츠를 설명합니다. Body
콘텐츠:
StructuralElement
객체의 시퀀스입니다. 콘텐츠 요소로 각 콘텐츠를 맞춤설정함
StructuralElement
객체를 사용합니다.
구조적 요소와 해당 콘텐츠 객체에는 모든 시각적 구성요소가 포함됩니다. 문서 내에서 찾을 수 있습니다. 여기에는 텍스트, 인라인 이미지, 서식이 포함됩니다.
단락 구조
Paragraph
는
단락을 나타내는 StructuralElement
입니다. 이 콘텐츠에는
줄바꿈 문자로 끝납니다. 다음 객체로 구성됩니다.
ParagraphElement
: 단락 내의 콘텐츠를 설명합니다.ParagraphStyle
: 단락의 스타일 속성을 명시적으로 설정하는 선택적 요소입니다.Bullet
: 단락이 글머리기호 항목을 제공하는 선택적 요소로, 목록의 일부입니다. 지정할 수도 있습니다
ParagraphElement
는 StructuralElement
와 같이 작동합니다. 집합
콘텐츠 요소 유형 (예:
ColumnBreak
및
Equation
)은
다음 다이어그램과 같이 자체 ParagraphElement
를 사용해야 합니다.
전체 문서 구조의 예는 문서 예시 JSON 형식으로 표시됩니다. 출력에서 주요 구조 및 콘텐츠 요소뿐 아니라 종료 색인을 생성합니다.
텍스트 실행
TextRun
는
ParagraphElement
은 연속된 텍스트 문자열을 나타냅니다. 가
단락에 여러 텍스트 런이 포함될 수 있지만 텍스트 런은 단락을 가로지르지 않습니다.
경계선에 위치해 있습니다 줄바꿈 문자로 콘텐츠가 분할되어 별도의 텍스트를 만듭니다.
실행할 수도 있습니다 예를 들어 다음과 같은 작은 문서를 생각해 보세요.
![단락 및 글머리기호 목록이 포함된 작은 문서입니다.](https://developers-dot-devsite-v2-prod.appspot.com/static/docs/api/images/simpledoc.png?authuser=0000&hl=ko)
다음 다이어그램은 단락의 순서를 시각화하는 방법을 보여줍니다.
이전 문서에 각각 자체 TextRun
및 선택적 Bullet
가 있음
설정을 변경할 수 있습니다.
AutoText
AutoText
은(는)
텍스트에서 동적으로 대체되는 한 지점을 나타내는 ParagraphElement
시간이 지남에 따라 변할 수 있는
콘텐츠를 만들 수 있습니다 Docs에서
페이지 번호를 탭합니다.
시작 및 끝 색인
문서 탭의 콘텐츠를 업데이트할 때마다 위치를 지정할 수 있습니다 이러한 위치 및 범위는 범위 내의 오프셋을 나타내는 색인을 사용하여 지정됩니다. 포함 문서 세그먼트 세그먼트는 본문, 머리글, 바닥글 또는 각주에 포함할 수 있습니다. 요소의 색인 해당 세그먼트의 시작 부분을 기준으로 합니다.
본문 콘텐츠 내 대부분의 요소에는 0부터 시작하는 startIndex
가 있고
속성 endIndex
개. 요소의 시작 및 시작 위치의 오프셋을 나타냅니다.
둘러싸는 세그먼트의 시작 부분을 기준으로 합니다. 자세한 내용은
일괄 Docs API 호출을 정렬하는 방법에 대한 자세한 내용은 일괄 작업
업데이트를 참조하세요.
색인은 UTF-16 코드 단위로 측정됩니다. 즉, 서로게이트 쌍은
두 개의 색인 예: '웃는 얼굴' ⁕ 그림 이모티콘은 다음과 같이 표현됩니다.
\uD83D\uDE00
두 개의 색인을 사용합니다.
문서 본문 내 요소의 경우 색인은 '루트'인 본문 콘텐츠의 시작 요소가 포함됩니다.
'맞춤설정'은 데이터 세트는
요소: SectionBreak
,
TableOfContents
,
Table
및
Paragraph
—주변을 둘러싸고 있으므로 이러한 색인이 없습니다.
StructuralElement
에는 다음과 같은 필드가 있습니다. 이는 맞춤설정도 마찬가지입니다.
ParagraphElement
에 포함된 유형(예: TextRun
, AutoText
,
PageBreak
요소 액세스
많은 요소는
documents.batchUpdate
드림
메서드를 사용하여 축소하도록 요청합니다. 예를 들어
InsertTextRequest
님,
텍스트가 포함된 요소의 내용을 변경할 수 있습니다. 마찬가지로
사용
UpdateTextStyleRequest
드림
를 사용하면 하나 이상의 요소에 포함된 텍스트 범위에 서식을 적용할 수 있습니다.
문서의 요소를 읽으려면
documents.get
메서드를 사용하여
전체 문서의 JSON 덤프입니다. 그런 다음 결과 JSON을
개별 요소의 값을 찾을 수 있습니다. 자세한 내용은 출력
문서 콘텐츠를 JSON으로 변환할 수 있습니다.
콘텐츠를 파싱하면 다양한 사용 사례에 유용할 수 있습니다. 다음과 같은 방법을 고려해 보세요. 예를 들어 찾은 문서를 나열하는 애플리케이션이 여기에 해당합니다. 이 앱 문서에서 제목, 버전 ID, 시작 페이지 번호를 다음 다이어그램에 표시된 것과 같습니다.
이러한 설정을 명시적으로 읽는 메서드가 없으므로 앱에는 전체 문서를 가져온 다음 JSON을 파싱하여 이러한 값을 추출합니다.
속성 상속
StructuralElement
는 상위 객체에서 속성을 상속할 수 있습니다.
객체의 속성(정의된 속성 및 상속한 속성 포함)
최종 시각적 모양을 결정합니다.
텍스트 문자 형식은 문서에서 텍스트가 렌더링되는 방식을 결정합니다(예:
굵게, 기울임꼴, 밑줄을 적용할 수 있습니다 적용한 서식이 기본값보다 우선 적용됩니다.
기본 단락의
TextStyle
반대로
서식을 설정하지 않은 문자는 계속해서
스타일을 지정할 수 있습니다.
단락 서식 지정은 문서에서 텍스트 블록이 렌더링되는 방식을 결정합니다.
영향을 줄 수 있습니다. 적용하는 서식
기본 ParagraphStyle
에서 상속된 기본 형식을 재정의합니다.
반대로 설정하지 않은 모든 서식 기능은 계속 상속됩니다.
단락 스타일을 지정할 수 있습니다.