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 Добавляет Bookmark в указанной Position на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку.
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 Добавляет данного пользователя в список читателей Document .
add Viewers(emailAddresses) Document Добавляет заданный массив пользователей в список читателей Document .
get Active Tab() Tab Получает активную Tab пользователя в документе.
get As(contentType) Blob Извлекает текущее содержимое Document в виде большого двоичного объекта указанного типа.
get Blob() Blob Извлекает текущее содержимое Document в виде большого двоичного объекта.
get Body() Body Извлекает Body первой вкладки или, для сценариев, привязанных к документу, Document Body Section активной вкладки.
get Bookmark(id) Bookmark Получает Bookmark с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Bookmarks() Bookmark[] Получает все объекты Bookmark на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Cursor() Position Получает курсор пользователя на активной вкладке.
get Editors() User[] Получает список редакторов этого Document .
get Footer() Footer Section Извлекает раздел нижнего колонтитула первой вкладки или, для сценариев, привязанных к документу, раздел нижнего колонтитула активной вкладки.
get Footnotes() Footnote[] Извлекает все элементы Footnote в теле первой вкладки или, для сценариев, привязанных к документу, в теле активной вкладки.
get Header() Header Section Извлекает раздел заголовка первой вкладки или, для сценариев, привязанных к документу, раздел заголовка активной вкладки.
get Id() String Получает уникальный идентификатор документа.
get Language() String Получает код языка документа.
get Name() String Получает заголовок документа.
get Named Range By Id(id) Named Range Получает Named Range с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Named Ranges() Named Range[] Получает все объекты Named Range на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Named Ranges(name) Named Range[] Получает все объекты Named Range с заданным именем на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке.
get Selection() Range Получает выбор пользователя на активной вкладке.
get Supported Language Codes() String[] Получает все коды языков, которые поддерживаются в файлах Документов Google.
get Tab(tabId) Tab Получает Tab с указанным идентификатором.
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)

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

Параметры

Имя Тип Описание
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 — заголовок вкладки.

Авторизация

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

  • 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 в документ его нельзя изменить, а можно только удалить.

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

// 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 — This Document для связывания.

Авторизация

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

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

add Viewer(user)

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

Параметры

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

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

Document — This 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 — активная в данный момент 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 — текущий документ в виде большого двоичного объекта.

get Blob()

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

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

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

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 с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить закладку на любой вкладке, используйте метод 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 — Bookmark с заданным идентификатором или 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[] — Массив объектов Bookmark на вкладке.

Авторизация

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

  • 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 , если у пользователя нет курсора, размещенного на вкладке, или если сценарий не привязан к документу.

Авторизация

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

  • 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 — нижний колонтитул вкладки.

Авторизация

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

  • 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 — заголовок вкладки.

Авторизация

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

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

Получает код языка документа. Это язык, показанный в меню «Файл» > «Язык» редактора документов, который может не совпадать с фактическим языком, содержащимся в документе.

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

String — язык документа или null , если оно не определено.

Авторизация

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

  • 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 с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить Named Range с заданным идентификатором на любой вкладке, используйте метод Document Tab.getNamedRangeById(id) . Этот метод возвращает null , если на вкладке не существует такого Named Range . Имена не обязательно уникальны, даже на разных вкладках; несколько разных диапазонов на одной вкладке могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри вкладки, как идентификатор в HTML.

Параметры

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

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

Named Range — 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 , если у пользователя ничего не выбрано на вкладке, если выбран только конец абзаца, если выбран только конец абзаца и новая строка или если скрипт не привязан к документу.

Авторизация

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

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

get Supported Language Codes()

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

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

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

Авторизация

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

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

get Tab(tabId)

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

Параметры

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

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

Tab — Tab с указанным идентификатором или 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 находится на общем диске, который пользователь может получить доступ.

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

Параметры

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

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

Document — Этот Document для связывания.

Авторизация

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

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

remove Editor(user)

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

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

Параметры

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

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

Document — Этот Document для связывания.

Авторизация

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

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

remove Viewer(emailAddress)

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

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

Параметры

Имя Тип Описание
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 находится на общем диске, который пользователь может получить доступ.

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

Параметры

Имя Тип Описание
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 — This 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 — Этот Document для связывания.

Авторизация

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

  • 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