Class DocumentApp

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 .
Element Type Element Type Перечисление Element Type .
Font Family Font Family Перечень шрифтов Font Family .
Glyph Type Glyph Type Перечисление Glyph Type .
Horizontal Alignment Horizontal Alignment Перечисление Horizontal Alignment .
Paragraph Heading Paragraph Heading Перечень Paragraph Heading .
Positioned Layout Positioned Layout Перечисление Positioned Layout .
Text Alignment Text Alignment Перечисление Text Alignment .
Vertical Alignment Vertical Alignment Перечисление Vertical Alignment .

Методы

Метод Тип возвращаемого значения Краткое описание
create(name) Document Создает и возвращает новый документ.
get Active Document() Document Возвращает документ, к которому привязан скрипт в качестве контейнера .
get Ui() Ui Возвращает экземпляр пользовательского интерфейса документа, позволяющий скрипту добавлять такие элементы, как меню, диалоговые окна и боковые панели.
open By Id(id) Document Возвращает документ с указанным идентификатором.
open By Url(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)

Возвращает документ с указанным 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