Class Document

Документ

Документ, содержащий один или несколько объектов Tab , каждый из которых содержит форматированный текст и такие элементы, как таблицы и списки.

Документы можно открывать или создавать с помощью Document App .

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

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

Методы класса Document , которые напрямую обращаются к содержимому текста и изменяют его, работают либо с активной вкладкой (в скриптах, привязанных к конкретному документу), либо с первой вкладкой (если активная вкладка недоступна). Скрипты, использующие эти методы (например, get Body() ), могут быть переведены на поддержку вкладок с помощью get Tabs() и Tab.asDocumentTab() .

Методы

Метод Тип возвращаемого значения Краткое описание
add Bookmark(position) Bookmark Adds a Bookmark at the given Position to the first tab or, for scripts that are bound to a document, the active tab.
add Editor(emailAddress) Document Добавляет указанного пользователя в список редакторов Document .
add Editor(user) Document Добавляет указанного пользователя в список редакторов Document .
add Editors(emailAddresses) Document Добавляет указанный массив пользователей в список редакторов Document .
add Footer() Footer Section Добавляет раздел нижнего колонтитула, если таковой отсутствует, на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Header() Header Section Добавляет раздел заголовка, если таковой отсутствует, на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Named Range(name, range) Named Range Добавляет Named Range ( Range , имеющий имя и идентификатор для последующего извлечения) на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку.
add Viewer(emailAddress) Document Добавляет указанного пользователя в список пользователей, просматривающих Document .
add Viewer(user) Document Adds the given user to the list of viewers for the Document .
add Viewers(emailAddresses) Document Добавляет указанный массив пользователей в список пользователей, просматривающих Document .
get Active Tab() Tab |null Получает текущую активную Tab пользователя в документе.
get As(contentType) Blob Retrieves the current Document contents as a blob of the specified type.
get Blob() Blob Извлекает содержимое текущего Document в виде двоичного объекта (blob).
get Body() Body Извлекает Body первой вкладки или, для скриптов, связанных с документом, Document Body Section " активной вкладки.
get Bookmark(id) Bookmark |null Получает Bookmark с заданным ID на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Cursor() Position |null Перемещает курсор пользователя в активную вкладку.
get Editors() User[] Получает список редакторов для этого Document .
get Footer() Footer Section |null Извлекает нижний колонтитул первой вкладки или, для скриптов, привязанных к документу, нижний колонтитул активной вкладки.
get Footnotes() Footnote[] Извлекает все элементы Footnote из тела первой вкладки или, для скриптов, привязанных к документу, из тела активной вкладки.
get Header() Header Section |null Извлекает заголовок первой вкладки или, для скриптов, привязанных к документу, заголовок активной вкладки.
get Id() String Получает уникальный идентификатор документа.
get Language() String|null Получает код языка документа.
get Name() String Извлекает заголовок документа.
get Named Range By Id(id) Named Range |null Получает Named Range с заданным идентификатором на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Named Ranges() Named Range[] Получает все объекты Named Range на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
get Named Ranges(name) Named Range[] Gets all Named Range objects with the given name in the first tab or, for scripts that are bound to a document, the active tab.
get Selection() Range |null Получает выбранный пользователем элемент на активной вкладке.
get Supported Language Codes() String[] Получает все коды языков, поддерживаемые в файлах Google Docs.
get Tab(tabId) Tab |null Получает Tab с указанным ID.
get Tabs() Tab[] Получает все невложенные Tab , являющиеся частью документа.
get Url() String Получает URL-адрес для доступа к текущему документу.
get Viewers() User[] Получает список зрителей и комментаторов для этого Document .
new Position(element, offset) Position Создает новую Position , которая представляет собой ссылку на местоположение на вкладке относительно определенного элемента на первой вкладке или, для скриптов, привязанных к документу, активной вкладки.
new Range() Range Builder Создает конструктор, используемый для построения объектов Range из элементов вкладок на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке.
remove Editor(emailAddress) Document Удаляет указанного пользователя из списка редакторов Document .
remove Editor(user) Document Удаляет указанного пользователя из списка редакторов Document .
remove Viewer(emailAddress) Document Удаляет указанного пользователя из списка пользователей, просматривающих Document и оставляющих комментарии.
remove Viewer(user) Document Удаляет указанного пользователя из списка пользователей, просматривающих Document и оставляющих комментарии.
save And Close() void Сохраняет текущий Document .
set Active Tab(tabId) void Устанавливает Tab , выбранную пользователем в текущем документе, на вкладку с указанным идентификатором.
set Cursor(position) Document Устанавливает курсор пользователя, задав его Position .
set Language(languageCode) Document Устанавливает языковой код документа.
set Name(name) Document Задает заголовок документа.
set Selection(range) Document Устанавливает выбранный пользователем элемент на активной вкладке, задав Range .

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

add Bookmark(position)

Добавляет Bookmark в указанную Position на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку. Чтобы добавить закладку на любую вкладку, используйте метод Document Tab.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('123abc');

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

add Editor(emailAddress)

Adds the given user to the list of editors for the Document . If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, который необходимо добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

add Editor(user)

Добавляет указанного пользователя в список редакторов Document . Если пользователь уже был в списке зрителей, этот метод перемещает его из списка зрителей в список редакторов.

Параметры

Имя Тип Описание
user User Изображение пользователя, которого нужно добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

add Editors(emailAddresses)

Добавляет заданный массив пользователей в список редакторов Document . Если какой-либо из пользователей уже был в списке зрителей, этот метод перемещает его из списка зрителей.

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

add Footer()

Добавляет раздел нижнего колонтитула, если таковой отсутствует, на первую вкладку или, для скриптов, связанных с документом, на активную вкладку. Чтобы добавить раздел нижнего колонтитула на любую вкладку, используйте метод Document Tab.addFooter() .

// 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('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

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

Footer Section — Нижний колонтитул вкладок.

Авторизация

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

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

add Header()

Добавляет раздел заголовка, если таковой отсутствует, на первую вкладку или, для скриптов, привязанных к документу, на активную вкладку. Чтобы добавить раздел заголовка на любую вкладку, используйте метод Document Tab.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('123abc');

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

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

Header Section — The tab header.

Авторизация

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

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

add Named Range(name, range)

Добавляет Named Range Range имеющий имя и идентификатор для последующего поиска, на первую вкладку или, для скриптов, связанных с документом, на активную вкладку. Чтобы добавить Named Range на любую вкладку, используйте метод Document Tab.addNamedRange(name, range) . Имена не обязательно уникальны; несколько разных диапазонов в одном документе могут иметь одно и то же имя, подобно классу в HTML. В отличие от них, идентификаторы уникальны в пределах документа, как идентификатор в HTML. После добавления Named Range в документ его нельзя изменить, можно только удалить.

Any script that accesses the document can access a Named Range . To avoid unintended conflicts between scripts, consider prefixing range names with a unique string.

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let 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 Название диапазона, которое не обязательно должно быть уникальным; названия диапазонов должны содержать от 1 до 256 символов.
range Range Диапазон элементов, которые будут связаны с именем; диапазон может представлять собой активный выбор , результат поиска или быть создан вручную с помощью new Range() .

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

Named Range — Named Range .

Авторизация

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

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

add Viewer(emailAddress)

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

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, который необходимо добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

add Viewer(user)

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

Параметры

Имя Тип Описание
user User Изображение пользователя, которого нужно добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

add Viewers(emailAddresses)

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

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

get Active Tab()

Получает текущую активную 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 |null — Текущая активная Tab пользователя, или null если скрипт не привязан к документу.

Авторизация

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

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

get As(contentType)

Извлекает содержимое текущего Document в виде двоичного объекта указанного типа.

// 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('123abc');

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

Параметры

Имя Тип Описание
content Type String Тип MIME для преобразования: поддерживаются 'application/pdf' и 'text/markdown' .

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

Blob — Текущий документ в виде объекта типа "blob".

get Blob()

Извлекает содержимое текущего 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('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

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

Blob — Текущий документ в виде объекта типа "blob".

get Body()

Получает Body первой вкладки или, для скриптов, связанных с документом, Document Body Section активной вкладки. Чтобы получить Document Body Section любой вкладки, используйте метод Document Tab.getBody() .

Вкладки могут содержать различные типы разделов (например, Header Section , Footer Section ). Активным разделом для вкладки является 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('123abc');

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

get Bookmark(id)

Получает Bookmark с заданным ID на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы получить закладку на любой вкладке, используйте метод Document Tab.getBookmark(id) . Этот метод возвращает null , если такой Bookmark на вкладке нет. 

// 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('123abc');

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

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

Bookmark |null — Bookmark с указанным ID или null , если такой Bookmark на вкладке нет.

Авторизация

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

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

get Bookmarks()

Получает все объекты Bookmark на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы получить все закладки на любой вкладке, используйте метод Document Tab.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('123abc');

// 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[] — An array of the Bookmark objects in the tab.

Авторизация

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

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

get Cursor()

Получает курсор пользователя на активной вкладке. Скрипт может получить доступ к курсору только того пользователя, который его запускает, и только если скрипт привязан к документу. 

// Insert some text at the cursor position and make it bold.
const 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.
  const 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 — значение, отображающее курсор пользователя, или null если курсор пользователя не находится на вкладке или если скрипт не привязан к документу.

Авторизация

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

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

get Editors()

Получает список редакторов для этого Document .

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

User[] — Массив пользователей с правами на редактирование.

Авторизация

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

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

get Footer()

Получает нижний колонтитул первой вкладки или, для скриптов, связанных с документом, нижний колонтитул активной вкладки. Чтобы получить нижний колонтитул любой вкладки, используйте метод Document Tab.getFooter() . 

// 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('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

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

Footer Section |null — The tab's footer.

Авторизация

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

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

get Footnotes()

Извлекает все элементы Footnote из тела первой вкладки или, для скриптов, привязанных к документу, из тела активной вкладки. Чтобы получить все сноски на любой вкладке, используйте метод Document Tab.getFootnotes() .

Вызовы метода get Footnotes приводят к итерации по элементам вкладки. Для больших вкладок избегайте ненужных вызовов этого метода. 

// 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('123abc');

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

get Header()

Получает заголовок первой вкладки или, для скриптов, связанных с документом, заголовок активной вкладки. Чтобы получить заголовок любой вкладки, используйте метод Document Tab.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('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

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

Header Section |null — Заголовок вкладки.

Авторизация

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

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

get Id()

Получает уникальный идентификатор документа. Идентификатор документа используется с Document App.openById() для открытия конкретного экземпляра документа.

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

String — Идентификатор документа.

Авторизация

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

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

get Language()

Gets the document's language code. This is the language shown in the document editor's File > Language , which may not be the actual language that the document contains.

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

String|null — The document language, or null if not defined.

Авторизация

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

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

get Name()

Извлекает заголовок документа.

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

String — Заголовок документа.

Авторизация

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

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

get Named Range By Id(id)

Получает Named Range с заданным ID на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы получить Named Range с заданным ID на любой вкладке, используйте метод Document Tab.getNamedRangeById(id) . Этот метод возвращает null если такого Named Range на вкладке не существует. Имена не обязательно уникальны, даже между вкладками; несколько разных диапазонов на одной вкладке могут иметь одно и то же имя, подобно классу в HTML. В отличие от этого, идентификаторы уникальны внутри вкладки, как идентификатор в HTML.

Параметры

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

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

Named Range |null — Named Range с заданным идентификатором или null , если такого диапазона на вкладке нет.

Авторизация

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

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

get Named Ranges()

Получает все объекты Named Range на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы получить все объекты Named Range на любой вкладке, используйте метод Document Tab.getNamedRanges() .

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

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

Named Range[] — массив объектов Named Range на вкладке, который может включать несколько диапазонов с одинаковым именем.

Авторизация

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

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

get Named Ranges(name)

Получает все объекты Named Range с заданным именем на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы получить все объекты Named Range на любой вкладке, используйте метод Document Tab.getNamedRanges(name) . Имена не обязательно уникальны, даже между вкладками; несколько разных диапазонов на одной вкладке могут иметь одно и то же имя, подобно классу в HTML. В отличие от этого, идентификаторы уникальны внутри вкладки, как идентификатор в HTML.

Named Range доступен любому скрипту, обращающемуся к документу. Во избежание непредвиденных конфликтов между скриптами рекомендуется добавлять к именам диапазонов уникальный префикс.

Параметры

Имя Тип Описание
name String Название серии, которое не обязательно является уникальным.

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

Named Range[] — массив объектов Named Range на вкладке с заданным именем.

Авторизация

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

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

get Selection()

Получает выделение пользователя на активной вкладке. Скрипт может получить доступ к выделению только того пользователя, который его запускает, и только если скрипт привязан к документу. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

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

Range |null — A representation of the user's selection, or null if the user does not have anything selected in the tab, if only the end of a paragraph is selected, if only the end of a paragraph and a new line are selected, or if the script is not bound to the document.

Авторизация

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

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

get Supported Language Codes()

Получает все коды языков, поддерживаемые в файлах Google Docs.

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

String[] — массив кодов языков.

Авторизация

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

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

get Tab(tabId)

Получает Tab с указанным ID. Этот метод возвращает null если такой Tab не существует. Доступ к вкладкам возможен на любом уровне вложенности.

Параметры

Имя Тип Описание
tab Id String Идентификатор вкладки, которую нужно получить.

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

Tab |null — Tab с указанным ID или null , если такой Tab не существует.

Авторизация

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

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

get Tabs()

Получает все невложенные Tab , являющиеся частью документа.

Вкладки могут содержать дочерние вкладки, то есть вкладку, вложенную в другую вкладку. Доступ к дочерним вкладкам осуществляется с помощью Tab.getChildTabs() .

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

Tab[] — Список всех Tab , входящих в состав документа.

Авторизация

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

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

get Url()

Получает URL-адрес для доступа к текущему документу. 

const 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

get Viewers()

Получает список зрителей и комментаторов для этого Document .

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

User[] — Массив пользователей с правами просмотра или комментирования.

Авторизация

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

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

new Position(element, offset)

Создает новый Position , который представляет собой ссылку на местоположение во вкладке относительно определенного элемента на первой вкладке или, для скриптов, привязанных к документу, активной вкладки. Чтобы создать Position относительно местоположения в любой вкладке, используйте метод Document Tab.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.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const 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

new Range()

Создает конструктор, используемый для построения объектов Range из элементов вкладок на первой вкладке или, для скриптов, привязанных к документу, на активной вкладке. Чтобы создать конструктор, используемый для построения объектов Document Range из элементов вкладок на любой вкладке, используйте метод Document Tab.newRange() . 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

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

Range Builder — Новый производитель.

Авторизация

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

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

remove Editor(emailAddress)

Удаляет указанного пользователя из списка редакторов Document . Этот метод не блокирует доступ пользователей к Document , если они относятся к категории пользователей с общим доступом — например, если Document доступен всему домену пользователя или если Document находится на общем диске, к которому пользователь имеет доступ.

Для файлов в Google Диске это также удаляет пользователя из списка просматриваемых файлов.

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, которого нужно удалить.

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

Document — This Document , for chaining.

Авторизация

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

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

remove Editor(user)

Удаляет указанного пользователя из списка редакторов Document . Этот метод не блокирует доступ пользователей к Document , если они относятся к категории пользователей с общим доступом — например, если Document доступен всему домену пользователя или если Document находится на общем диске, к которому пользователь имеет доступ.

Для файлов в Google Диске это также удаляет пользователя из списка просматриваемых файлов.

Параметры

Имя Тип Описание
user User Изображение пользователя, которое нужно удалить.

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

Document — Этот Document предназначен для создания цепочек сообщений.

Авторизация

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

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

remove Viewer(emailAddress)

Удаляет указанного пользователя из списка пользователей, просматривающих и комментирующих Document . Этот метод не действует, если пользователь является редактором, а не пользователем, просматривающим или комментирующим документ. Этот метод также не блокирует доступ пользователей к Document , если они относятся к категории пользователей с общим доступом — например, если Document доступен всему домену пользователя или если Document находится на общем диске, к которому пользователь имеет доступ.

Для файлов в Google Диске это также удаляет пользователя из списка редакторов.

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, которого нужно удалить.

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

Document — Этот Document предназначен для создания цепочек.

Авторизация

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

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

remove Viewer(user)

Удаляет указанного пользователя из списка пользователей, просматривающих и комментирующих Document . Этот метод не действует, если пользователь является редактором, а не пользователем, просматривающим документ. Этот метод также не блокирует доступ пользователей к Document , если они относятся к категории пользователей с общим доступом — например, если Document доступен всему домену пользователя или если Document находится на общем диске, к которому пользователь имеет доступ.

Для файлов в Google Диске это также удаляет пользователя из списка редакторов.

Параметры

Имя Тип Описание
user User Изображение пользователя, которое нужно удалить.

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

Document — Этот Document предназначен для создания цепочек.

Авторизация

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

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

save And Close()

Сохраняет текущий Document . Приводит к сбросу и применению ожидающих обновлений.

Метод save And Close() автоматически вызывается в конце выполнения скрипта для каждого открытого редактируемого Document .

Закрытый Document нельзя редактировать. Используйте Document App.openById() для повторного открытия документа для редактирования.

Авторизация

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

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

set Active Tab(tabId)

Устанавливает Tab , выбранную пользователем в текущем документе, на вкладку с указанным идентификатором. 

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('123abc');

Параметры

Имя Тип Описание
tab Id String Идентификатор вкладки, которую нужно сделать активной.

Авторизация

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

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

set Cursor(position)

Устанавливает курсор пользователя, задавая его Position . Скрипт может получить доступ к курсору только того пользователя, который его запускает, и только если скрипт привязан к документу.

Указание Position в неактивной Tab переключает активную вкладку пользователя. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const 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

set Language(languageCode)

Задает языковой код документа. Это язык, отображаемый в меню «Файл» > «Язык» редактора документов, который может не совпадать с фактическим языком документа. Используйте get Supported Language Codes() , чтобы получить все допустимые языковые коды.

Параметры

Имя Тип Описание
language Code String Языковой код.

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

Document — This Document , for chaining.

Авторизация

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

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

set Name(name)

Задает заголовок документа.

Параметры

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

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

Document — Текущий документ.

Авторизация

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

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

set Selection(range)

Устанавливает выделение пользователя на активной вкладке, задавая Range . Скрипт может получить доступ к выделению только пользователя, запускающего скрипт, и только если скрипт привязан к документу. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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