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');

Характеристики

Свойство Тип Описание
Attribute Attribute Перечисление Attribute .
ElementType ElementType Перечисление ElementType .
FontFamily FontFamily Перечисление FontFamily .
GlyphType GlyphType Перечисление GlyphType .
HorizontalAlignment HorizontalAlignment Перечисление HorizontalAlignment .
ParagraphHeading ParagraphHeading Перечисление ParagraphHeading .
PositionedLayout PositionedLayout Перечисление PositionedLayout .
TextAlignment TextAlignment Перечисление TextAlignment .
VerticalAlignment VerticalAlignment Перечисление VerticalAlignment .

Методы

Метод Тип возврата Краткое описание
create(name) Document Создает и возвращает новый документ.
getActiveDocument() Document Возвращает документ, к которому привязан скрипт.
getUi() Ui Возвращает экземпляр среды пользовательского интерфейса документа, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели.
openById(id) Document Возвращает документ с указанным идентификатором.
openByUrl(url) Document Открывает и возвращает документ с указанным URL-адресом.

Подробная документация

create(name)

Создает и возвращает новый документ. 

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

Параметры

Имя Тип Описание
name String Имя нового документа.

Возвращаться

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()

Возвращает экземпляр среды пользовательского интерфейса документа, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели. Сценарий может взаимодействовать с пользовательским интерфейсом только для текущего экземпляра открытого документа и только в том случае, если сценарий привязан к документу. Дополнительную информацию см. в руководствах по меню , диалоговым окнам и боковым панелям . 

// 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)

Возвращает документ с указанным идентификатором. Если сценарий привязан к документу в контейнере, используйте вместо него getActiveDocument() . 

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

Параметры

Имя Тип Описание
id String Идентификатор документа, который нужно открыть.

Возвращаться

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',
);

Параметры

Имя Тип Описание
url String URL-адрес документа, который нужно открыть

Возвращаться

Document — экземпляр документа

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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