Class DocumentApp

문서앱

문서 서비스는 수정할 수 있는 Documents를 만들고 엽니다. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

속성

속성유형설명
AttributeAttributeAttribute 열거형
ElementTypeElementTypeElementType 열거형
FontFamilyFontFamilyFontFamily 열거형
GlyphTypeGlyphTypeGlyphType 열거형
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 열거형
ParagraphHeadingParagraphHeadingParagraphHeading 열거형
PositionedLayoutPositionedLayoutPositionedLayout 열거형
TextAlignmentTextAlignmentTextAlignment 열거형
VerticalAlignmentVerticalAlignmentVerticalAlignment 열거형

메서드

메서드반환 유형간략한 설명
create(name)Document새 문서를 만들고 반환합니다.
getActiveDocument()Document스크립트가 컨테이너에 연결된 문서를 반환합니다.
getUi()Ui스크립트가 메뉴, 대화상자, 사이드바와 같은 기능을 추가할 수 있는 문서의 사용자 인터페이스 환경 인스턴스를 반환합니다.
openById(id)Document지정된 ID가 있는 문서를 반환합니다.
openByUrl(url)Document지정된 URL이 포함된 문서를 열고 반환합니다.

자세한 문서

create(name)

새 문서를 만들고 반환합니다. 

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

매개변수

이름유형설명
nameString새 문서의 이름입니다.

리턴

Document: 새 문서 인스턴스입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents

getActiveDocument()

스크립트가 컨테이너에 연결된 문서를 반환합니다. 스크립트가 컨테이너에 바인딩되지 않은 문서와 상호작용하려면 openById(id) 또는 openByUrl(url)을 대신 사용하세요. 

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

리턴

Document: 문서 인스턴스

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUi()

스크립트가 메뉴, 대화상자, 사이드바와 같은 기능을 추가할 수 있는 문서의 사용자 인터페이스 환경 인스턴스를 반환합니다. 스크립트는 열려 있는 문서의 현재 인스턴스에 대한 UI와만 상호작용할 수 있으며, 스크립트가 문서에 바인딩된 경우에만 상호작용할 수 있습니다. 자세한 내용은 메뉴 및 대화상자 및 사이드바 가이드를 참고하세요. 

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

리턴

Ui: 이 문서의 사용자 인터페이스 환경 인스턴스

openById(id)

지정된 ID가 있는 문서를 반환합니다. 스크립트가 문서에 컨테이너로 바인딩된 경우 getActiveDocument()를 대신 사용하세요. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

매개변수

이름유형설명
idString열려는 문서의 ID입니다.

리턴

Document: 문서 인스턴스입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents

openByUrl(url)

지정된 URL이 포함된 문서를 열고 반환합니다. 스크립트가 문서에 컨테이너 결합된 경우 getActiveDocument()를 대신 사용하세요. 

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

매개변수

이름유형설명
urlString열려는 문서의 URL

리턴

Document: 문서 인스턴스

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/documents