하나 이상의 Tab
객체를 포함하는 문서. 각 객체에는 서식 있는 텍스트와
요소(예: 표, 목록)가
포함되어 있습니다.
DocumentApp
을(를) 사용하여 문서를 열거나 만들 수 있습니다.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
텍스트 콘텐츠에 직접 액세스하고 수정하는 Document
클래스의 메서드는 작동합니다.
(스크립트에서 바인드된
특정 문서) 또는 첫 번째 탭 (활성 탭을 사용할 수 없는 경우)으로 이동할 수 있습니다. 기반 스크립트
이러한 메서드 (예: getBody()
)는
getTabs()
이후 Tab.asDocumentTab()
.
메서드
메서드 | 반환 유형 | 간략한 설명 |
---|---|---|
addBookmark(position) | Bookmark | 지정된 Position 의 Bookmark 를 첫 번째 탭에 추가합니다. 또는 스크립트에
바인딩된 문서, 활성 탭에 있을 수 있습니다. |
addEditor(emailAddress) | Document | 지정된 사용자를 Document 의 편집자 목록에 추가합니다. |
addEditor(user) | Document | 지정된 사용자를 Document 의 편집자 목록에 추가합니다. |
addEditors(emailAddresses) | Document | 지정된 사용자 배열을 Document 의 편집자 목록에 추가합니다. |
addFooter() | FooterSection | 바닥글 섹션이 없는 경우 첫 번째 탭에 추가합니다. 문서에 바인딩된 스크립트의 경우에는 활성 탭에 추가합니다. |
addHeader() | HeaderSection | 헤더 섹션이 없는 경우 첫 번째 탭에 추가합니다. 문서에 바인딩된 스크립트의 경우에는 활성 탭에 추가합니다. |
addNamedRange(name, range) | NamedRange | 다음에 사용할 이름과 ID가 있는 Range 인 NamedRange 를 추가합니다.
첫 번째 탭(문서에 바인딩된 스크립트의 경우 활성 탭)에서 확인할 수 있습니다. |
addViewer(emailAddress) | Document | 지정된 사용자를 Document 의 뷰어 목록에 추가합니다. |
addViewer(user) | Document | 지정된 사용자를 Document 의 뷰어 목록에 추가합니다. |
addViewers(emailAddresses) | Document | 지정된 사용자 배열을 Document 의 뷰어 목록에 추가합니다. |
getActiveTab() | Tab | 문서에서 사용자의 현재 활성 Tab 를 가져옵니다. |
getAs(contentType) | Blob | 현재 Document 콘텐츠를 지정된 유형의 blob으로 검색합니다. |
getBlob() | Blob | 현재 Document 콘텐츠를 blob으로 검색합니다. |
getBody() | Body | 첫 번째 탭의 Body 를 검색합니다. 문서에 바인딩된 스크립트의 경우 활성 탭의 DocumentBodySection 를 검색합니다. |
getBookmark(id) | Bookmark | 첫 번째 탭에서 지정된 ID로 Bookmark 를 가져오거나 문서(문서에 바인딩된 스크립트의 경우) 활성 탭에서 가져옵니다. |
getBookmarks() | Bookmark[] | 첫 번째 탭에서 모든 Bookmark 객체를 가져오거나, 문서에 바인딩된 스크립트의 경우 활성 탭을 가져옵니다. |
getCursor() | Position | 활성 탭에서 사용자의 커서를 가져옵니다. |
getEditors() | User[] | 이 Document 의 편집자 목록을 가져옵니다. |
getFooter() | FooterSection | 첫 번째 탭의 바닥글 섹션 또는 문서에 바인딩된 스크립트의 경우 활성 탭의 바닥글을 검색합니다. 섹션으로 이동합니다. |
getFootnotes() | Footnote[] | 첫 번째 탭의 본문에 있는 모든 Footnote 요소를 검색합니다. 문서에 바인딩된 스크립트의 경우 활성 탭 본문에 있는 모든 요소를 검색합니다. |
getHeader() | HeaderSection | 첫 번째 탭의 헤더 섹션 또는 문서에 바인딩된 스크립트의 경우 활성 탭의 헤더를 검색합니다. 섹션으로 이동합니다. |
getId() | String | 문서의 고유 식별자를 검색합니다. |
getLanguage() | String | 문서의 언어 코드를 가져옵니다. |
getName() | String | 문서의 제목을 검색합니다. |
getNamedRangeById(id) | NamedRange | 첫 번째 탭에서 지정된 ID로 NamedRange 를 가져오거나 문서(문서에 바인딩된 스크립트의 경우) 활성 탭에서 가져옵니다. |
getNamedRanges() | NamedRange[] | 첫 번째 탭에서 모든 NamedRange 객체를 가져오거나, 문서에 바인딩된 스크립트의 경우 활성 탭을 가져옵니다. |
getNamedRanges(name) | NamedRange[] | 첫 번째 탭에서 지정된 이름을 가진 모든 NamedRange 객체를 가져옵니다.
문서, 활성 탭에 바인딩됩니다. |
getSelection() | Range | 활성 탭에서 사용자의 선택사항을 가져옵니다. |
getSupportedLanguageCodes() | String[] | Google Docs 파일에서 지원되는 모든 언어 코드를 가져옵니다. |
getTab(tabId) | Tab | 지정된 ID가 있는 Tab 를 가져옵니다. |
getTabs() | Tab[] | 문서의 일부인 중첩되지 않은 모든 Tab 를 가져옵니다. |
getUrl() | String | 현재 문서에 액세스할 수 있는 URL을 검색합니다. |
getViewers() | User[] | 이 Document 의 뷰어 및 댓글 작성자 목록을 가져옵니다. |
newPosition(element, offset) | Position | 탭의 위치를 가리키는 새 Position 를 만듭니다. 이 객체는
특정 요소(문서에 바인딩된 스크립트의 경우 활성 탭)에 있어야 합니다. |
newRange() | RangeBuilder | 다음의 탭 요소에서 Range 객체를 구성하는 데 사용되는 빌더를 만듭니다.
첫 번째 탭 또는
활성 탭으로 이동합니다 |
removeEditor(emailAddress) | Document | Document 의 편집자 목록에서 지정된 사용자를 삭제합니다. |
removeEditor(user) | Document | Document 의 편집자 목록에서 지정된 사용자를 삭제합니다. |
removeViewer(emailAddress) | Document | Document 의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. |
removeViewer(user) | Document | Document 의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. |
saveAndClose() | void | 현재 Document 를 저장합니다. |
setActiveTab(tabId) | void | 현재 문서에서 사용자가 선택한 Tab 를 지정된 ID가 있는 탭으로 설정합니다. |
setCursor(position) | Document | Position 가 지정된 경우 사용자의 커서를 설정합니다. |
setLanguage(languageCode) | Document | 문서의 언어 코드를 설정합니다. |
setName(name) | Document | 문서 제목을 설정합니다. |
setSelection(range) | Document | Range 가 지정된 경우 활성 탭에서 사용자의 선택을 설정합니다. |
자세한 문서
addBookmark(position)
지정된 Position
의 Bookmark
를 첫 번째 탭에 추가합니다. 또는 스크립트에
바인딩된 문서, 활성 탭에 있을 수 있습니다. 광고 소재에
북마크를 추가하려면 DocumentTab.addBookmark(position)
메서드를 사용합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the active or first tab's body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
position | Position | 새 북마크의 위치입니다. |
리턴
Bookmark
- 새 북마크입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
지정된 사용자를 Document
의 편집자 목록에 추가합니다. 사용자가 이미
를 지정하면 뷰어 목록에서 사용자를 벗어나게 됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
emailAddress | String | 추가할 사용자의 이메일 주소입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
addEditors(emailAddresses)
지정된 사용자 배열을 Document
의 편집자 목록에 추가합니다. 만약
사용자가 이미 뷰어 목록에 있는 경우 이 방법을 사용하면
시청자
매개변수
이름 | 유형 | 설명 |
---|---|---|
emailAddresses | String[] | 추가할 사용자의 이메일 주소 배열입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
헤더 섹션이 없는 경우 첫 번째 탭에 추가합니다. 문서에 바인딩된 스크립트의 경우에는 활성 탭에 추가합니다. 머리글 추가하기
섹션을 탭에 추가하려면 DocumentTab.addHeader()
메서드를 사용합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Adds a header to the document's active or first tab. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
리턴
HeaderSection
- 탭 헤더입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
다음에 사용할 이름과 ID가 있는 Range
인 NamedRange
를 추가합니다.
첫 번째 탭(문서에 바인딩된 스크립트의 경우 활성 탭)에서 확인할 수 있습니다. 탭에 NamedRange
를 추가하려면 DocumentTab.addNamedRange(name, range)
메서드를 사용합니다. 이름은
고유합니다. 같은 문서에 있는 여러 다른 범위는 같은 이름을 공유할 수 있지만,
HTML의 클래스처럼 말이죠 반대로 ID는 HTML의 ID처럼 문서 내에서 고유합니다.
문서에 NamedRange
를 추가하면 수정할 수 없고 삭제만 할 수 있습니다.
문서에 액세스하는 모든 스크립트는 NamedRange
에 액세스할 수 있습니다. 의도치 않은 상황을 방지하기 위해
충돌하지 않는 경우 범위 이름 앞에 고유한 문자열을 사용하는 것이 좋습니다.
// Creates a named range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
매개변수
이름 | 유형 | 설명 |
---|---|---|
name | String | 범위의 이름으로, 고유하지 않아도 됩니다. 범위 이름은 입력할 수 있습니다. |
range | Range | 이름과 연결할 요소의 범위입니다. 범위는 활성 선택 항목, 검색 결과이거나 newRange() 를 사용하여 수동으로 구성될 수 있습니다. |
리턴
NamedRange
- NamedRange
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
addViewer(user)
addViewers(emailAddresses)
지정된 사용자 배열을 Document
의 뷰어 목록에 추가합니다. 만약
사용자가 이미 편집자 목록에 있으면 이 방법은 아무런 영향을 미치지 않습니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
emailAddresses | String[] | 추가할 사용자의 이메일 주소 배열입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getActiveTab()
문서에서 사용자의 현재 활성 Tab
를 가져옵니다. 스크립트는
활성 탭을 선택합니다. 스크립트가 문서에 바인딩된 경우에만 표시됩니다.
// Display a dialog box that shows the title of the tab that the // user is currently viewing. const tab = DocumentApp.getActiveDocument().getActiveTab(); DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());
리턴
Tab
: 사용자의 현재 활성 Tab
또는 null
(스크립트가 결합되지 않은 경우)
할 수 있습니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
현재 Document
콘텐츠를 지정된 유형의 blob으로 검색합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
매개변수
이름 | 유형 | 설명 |
---|---|---|
contentType | String | 변환할 MIME 유형입니다. 'application/pdf' 및 'text/markdown' 가 지원됩니다. |
리턴
Blob
- blob 형식의 현재 문서입니다.
getBlob()
현재 Document
콘텐츠를 blob으로 검색합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
리턴
Blob
- blob 형식의 현재 문서입니다.
getBody()
첫 번째 탭의 Body
를 검색합니다. 문서에 바인딩된 스크립트의 경우 활성 탭의 DocumentBodySection
를 검색합니다. 탭의 DocumentBodySection
를 가져오려면 DocumentTab.getBody()
메서드를 사용합니다.
탭에는 다양한 유형의 섹션이 포함될 수 있습니다 (예: HeaderSection
, FooterSection
). 탭의 활성 섹션은 Body
입니다.
Document
의 요소 메서드는 활성 Body
에 위임됩니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the active or first tab's body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
리턴
Body
- 탭 본문 섹션입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
첫 번째 탭에서 지정된 ID로 Bookmark
를 가져오거나 문서(문서에 바인딩된 스크립트의 경우) 활성 탭에서 가져옵니다. 다음을 얻는 방법은 다음과 같습니다.
북마크를 사용하려면 DocumentTab.getBookmark(id)
메서드를 사용하세요. 탭에 이러한 Bookmark
가 없으면 이 메서드는 null
를 반환합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the bookmark by its ID in the document's active or first tab. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the console. // otherwise, logs 'No bookmark exists with the given ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
매개변수
이름 | 유형 | 설명 |
---|---|---|
id | String | Bookmark 의 ID입니다. |
리턴
Bookmark
: 지정된 ID가 있는 Bookmark
, 또는 없는 경우 null
입니다. Bookmark
탭 내에 존재하는지 확인합니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
첫 번째 탭에서 모든 Bookmark
객체를 가져오거나, 문서에 바인딩된 스크립트의 경우 활성 탭을 가져옵니다. 모두
북마크에 추가하려면 DocumentTab.getBookmarks()
메서드를 사용합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets all of the bookmarks in the document's active or first tab. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the tab to the console. console.log(bookmarks.length);
리턴
Bookmark[]
- 탭에 있는 Bookmark
객체의 배열입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
활성 탭에서 사용자의 커서를 가져옵니다. 스크립트는 스크립트가 문서에 바인딩된 경우에만 실행됩니다.
// Insert some text at the cursor position and make it bold. var cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's // containing element doesn't allow insertions, so show the user an error message. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
리턴
Position
— 사용자 커서의 표시 또는 null
사용자에게
커서가 탭에 배치되거나 스크립트가 문서에 바인딩되어 있지 않을 수 있습니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEditors()
getFootnotes()
첫 번째 탭의 본문에 있는 모든 Footnote
요소를 검색합니다. 문서에 바인딩된 스크립트의 경우 활성 탭 본문에 있는 모든 요소를 검색합니다. 얻기 위해
모든 각주를 삭제하려면 DocumentTab.getFootnotes()
메서드를 사용합니다.
getFootnotes
를 호출하면 탭의 요소가 반복됩니다. 큰 탭의 경우
이 메서드에 대한 불필요한 호출을 피하세요.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
리턴
Footnote[]
- 탭의 각주입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeader()
첫 번째 탭의 헤더 섹션 또는 문서에 바인딩된 스크립트의 경우 활성 탭의 헤더를 검색합니다.
섹션으로 이동합니다. 탭의 헤더 섹션을 가져오려면 DocumentTab.getHeader()
메서드를 사용합니다.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the text of the active or first tab's header and logs it to the console. console.log(doc.getHeader().getText());
리턴
HeaderSection
- 탭의 헤더입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
문서의 고유 식별자를 검색합니다. 문서 ID는 DocumentApp.openById()
와 함께 특정 문서 인스턴스를 여는 데 사용됩니다.
리턴
String
- 문서의 ID입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
문서의 언어 코드를 가져옵니다. 문서 편집기의 파일 > Language). 이는 문서에 포함된 실제 언어가 아닐 수도 있습니다.
리턴
String
: 문서 언어 또는 정의되지 않은 경우 null
입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
문서의 제목을 검색합니다.
리턴
String
- 문서 제목
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
첫 번째 탭에서 지정된 ID로 NamedRange
를 가져오거나 문서(문서에 바인딩된 스크립트의 경우) 활성 탭에서 가져옵니다. 이
모든 탭에서 지정된 ID가 있는 NamedRange
이면 DocumentTab.getNamedRangeById(id)
를 사용합니다.
메서드를 사용하여 축소하도록 요청합니다. 탭에 이러한 NamedRange
가 없으면 이 메서드는 null
를 반환합니다. 이름
탭에서도 고유하지는 않습니다. 같은 탭에 있는 여러 다른 범위가
HTML의 클래스와 마찬가지로 동일한 이름을 공유합니다. 반면에 ID는 탭 내에서 고유하므로
HTML의 ID처럼 말이죠.
매개변수
이름 | 유형 | 설명 |
---|---|---|
id | String | 범위 ID로, 탭 내에서 고유합니다. |
리턴
NamedRange
- 지정된 ID가 있는 NamedRange
, 또는 이러한 범위가 없는 경우 null
탭
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
첫 번째 탭에서 모든 NamedRange
객체를 가져오거나, 문서에 바인딩된 스크립트의 경우 활성 탭을 가져옵니다. 모두
NamedRange
객체가 있으면 DocumentTab.getNamedRanges()
메서드를 사용합니다.
NamedRange
는 탭에 액세스하는 모든 스크립트에서 액세스할 수 있습니다. 피해야 할 사항
스크립트 간에 의도하지 않은 충돌이 발생하면 고유한 문자열로 범위 이름 접두사를 사용해 보세요.
리턴
NamedRange[]
- 탭에 있는 NamedRange
객체의 배열로, 여러 객체를 포함할 수 있습니다.
동일한 이름을 가진 범위들로 구성되어 있습니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
첫 번째 탭에서 지정된 이름을 가진 모든 NamedRange
객체를 가져옵니다.
문서, 활성 탭에 바인딩됩니다. 얻기 위해
탭에서 모든 NamedRange
객체를 가져오려면 DocumentTab.getNamedRanges(name)
메서드를 사용합니다. 탭 간에도 이름이 반드시 고유하지는 않습니다. 여러 다양한 범위로
HTML의 클래스와 마찬가지로 같은 탭이 같은 이름을 공유할 수 있습니다. 반면에 ID는 고유합니다.
을 입력합니다.
NamedRange
는 문서에 액세스하는 모든 스크립트에서 액세스할 수 있습니다. 피해야 할 사항
스크립트 간에 의도하지 않은 충돌이 발생하면 고유한 문자열로 범위 이름 접두사를 사용해 보세요.
매개변수
이름 | 유형 | 설명 |
---|---|---|
name | String | 범위의 이름으로, 반드시 고유하지는 않습니다. |
리턴
NamedRange[]
- 지정된 이름을 가진 탭의 NamedRange
객체의 배열입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
활성 탭에서 사용자의 선택사항을 가져옵니다. 스크립트는 사용자 선택에만 액세스할 수 있습니다. 스크립트가 문서에 바인딩된 경우에만 표시됩니다.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var elements = selection.getRangeElements(); DocumentApp.getUi().alert('Number of selected elements: ' + elements.length); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
리턴
Range
- 사용자가 선택한 항목을 표현하거나 사용자에게 선택 항목이 없는 경우 null
단락의 끝부분만 선택한 경우 탭에서 선택한 항목, 단락의 끝부분만 선택된 경우
또는 스크립트가 문서에 바인딩되어 있지 않은 경우에 발생합니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
Google Docs 파일에서 지원되는 모든 언어 코드를 가져옵니다.
리턴
String[]
- 언어 코드의 배열입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTab(tabId)
지정된 ID가 있는 Tab
를 가져옵니다. 이러한 Tab
가 없으면 이 메서드는 null
를 반환합니다. 모든 중첩 수준에서 탭에 액세스할 수 있습니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
tabId | String | 가져올 탭의 ID입니다. |
리턴
Tab
- 지정된 ID를 가진 Tab
이거나 이러한 Tab
가 없는 경우 null
입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTabs()
문서의 일부인 중첩되지 않은 모든 Tab
를 가져옵니다.
탭에는 하위 탭, 즉 다른 탭 내에 중첩된 탭이 포함될 수 있습니다. 하위 탭에 액세스할 수 있음
Tab.getChildTabs()
사용.
리턴
Tab[]
- 문서에 포함된 모든 Tab
의 목록입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
현재 문서에 액세스할 수 있는 URL을 검색합니다.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
리턴
String
- 현재 문서에 액세스하는 URL입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
newPosition(element, offset)
탭의 위치를 가리키는 새 Position
를 만듭니다. 이 객체는
특정 요소(문서에 바인딩된 스크립트의 경우 활성 탭)에 있어야 합니다. 생성 시
Position
를 모든 탭의 위치를 기준으로 하려면 DocumentTab.newPosition(element, offset)
를 사용합니다.
메서드를 사용하여 축소하도록 요청합니다. 사용자의 커서는 다양한 용도 중에서 Position
로 표시됩니다.
// Append a paragraph to the active tab, then place the user's cursor after the first word of // the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
매개변수
이름 | 유형 | 설명 |
---|---|---|
element | Element | 새 Position 를 포함해야 하는 요소입니다. 이 값은
Text 요소 또는 컨테이너 요소(예: Paragraph ) |
offset | Integer | Text 요소의 경우 Position 앞의 문자 수
다른 요소의 경우Position
동일한 컨테이너 요소를 사용합니다 |
리턴
Position
- 새 Position
입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
다음의 탭 요소에서 Range
객체를 구성하는 데 사용되는 빌더를 만듭니다.
첫 번째 탭 또는
활성 탭으로 이동합니다 DocumentRange
객체를 구성하는 데 사용되는 빌더 만들기
탭의 탭 요소에서 DocumentTab.newRange()
메서드를 사용합니다.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
리턴
RangeBuilder
- 새 빌더입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Document
의 편집자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는
다음과 같은 사용자 클래스에 속하는 경우 사용자가 Document
에 액세스하지 못하도록 차단합니다.
일반 액세스 권한(예: Document
이 사용자의 전체 계정과 공유되는 경우)
또는 Document
이(가) 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우입니다.
Drive 파일의 경우 뷰어 목록에서도 사용자가 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
emailAddress | String | 삭제할 사용자의 이메일 주소입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Document
의 편집자 목록에서 지정된 사용자를 삭제합니다. 이 메서드는
다음과 같은 사용자 클래스에 속하는 경우 사용자가 Document
에 액세스하지 못하도록 차단합니다.
일반 액세스 권한(예: Document
이 사용자의 전체 계정과 공유되는 경우)
또는 Document
이(가) 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우입니다.
Drive 파일의 경우 뷰어 목록에서도 사용자가 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
user | User | 삭제할 사용자를 나타냅니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Document
의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이
사용자가 뷰어나 댓글 작성자가 아닌 편집자인 경우에는 아무런 영향을 미치지 않습니다. 또한 이 메서드는
사용자가 다음 사용자 클래스에 속한 경우 Document
에 액세스하는 것을 차단하지 않음
일반 액세스 권한이 있어야 합니다. 예를 들어 Document
가 사용자의
전체 도메인 또는 Document
이(가) 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우
Drive 파일의 경우 편집자 목록에서도 사용자가 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
emailAddress | String | 삭제할 사용자의 이메일 주소입니다. |
리턴
Document
: 체이닝을 위한 Document
입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Document
의 뷰어 및 댓글 작성자 목록에서 지정된 사용자를 삭제합니다. 이
사용자가 뷰어가 아닌 편집자인 경우에는 아무런 영향을 미치지 않습니다. 또한 이 메서드는
사용자가 일반 액세스 권한 요청을 가진 사용자 클래스에 속하는 경우 Document
에 액세스할 수 없습니다.
액세스 권한(예: Document
이 사용자의 전체 도메인과 공유되는 경우)
Document
가 사용자가 액세스할 수 있는 공유 드라이브에 있는 경우
Drive 파일의 경우 편집자 목록에서도 사용자가 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
user | User | 삭제할 사용자를 나타냅니다. |
리턴
Document
: 체이닝을 위한 Document
입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
현재 Document
를 저장합니다. 대기 중인 업데이트가 플러시되고 적용됩니다.
saveAndClose()
메서드는 스크립트 실행이 끝날 때 자동으로 호출됩니다.
열려 있는 각 수정 가능한 Document
에 대해
닫힌 Document
은(는) 수정할 수 없습니다. DocumentApp.openById()
을(를) 사용하여
수정할 수 있습니다
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setActiveTab(tabId)
현재 문서에서 사용자가 선택한 Tab
를 지정된 ID가 있는 탭으로 설정합니다.
const doc = DocumentApp.getActiveDocument() // Sets the user's selected tab by its ID. // TODO(developer): Replace the ID with your own. const tab = doc.setActiveTab(TAB_ID);
매개변수
이름 | 유형 | 설명 |
---|---|---|
tabId | String | 활성으로 설정할 탭의 ID입니다. |
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Position
가 지정된 경우 사용자의 커서를 설정합니다. 스크립트는
스크립트가 문서에 바인딩된 경우에만 사용할 수 있습니다.
비활성 Tab
에서 Position
를 제공하면 사용자의 활성 탭이 전환됩니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
매개변수
이름 | 유형 | 설명 |
---|---|---|
position | Position | 새 커서 위치입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
문서의 언어 코드를 설정합니다. 문서 편집기의 파일
> Language). 이는 문서에 포함된 실제 언어가 아닐 수도 있습니다. getSupportedLanguageCodes()
를 사용하여 유효한 언어 코드를 모두 가져옵니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
languageCode | String | 언어 코드입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
setSelection(range)
Range
가 지정된 경우 활성 탭에서 사용자의 선택을 설정합니다. 스크립트는
스크립트가 문서에 바인딩된 경우에만 스크립트를 실행 중인 사용자가 선택한 항목에 액세스할 수 있습니다.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
매개변수
이름 | 유형 | 설명 |
---|---|---|
range | Range | 선택할 새 요소의 범위입니다. |
리턴
Document
: 이 Document
는 체이닝을 위한 것입니다.
승인
이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상으로 승인이 필요합니다.
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents