Документ, содержащий форматированный текст и такие элементы, как таблицы и списки.
Документы можно открывать или создавать с помощью DocumentApp
.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addBookmark(position) | Bookmark | Добавляет Bookmark в указанную Position . |
addEditor(emailAddress) | Document | Добавляет данного пользователя в список редакторов Document . |
addEditor(user) | Document | Добавляет данного пользователя в список редакторов Document . |
addEditors(emailAddresses) | Document | Добавляет заданный массив пользователей в список редакторов Document . |
addFooter() | FooterSection | Добавляет раздел нижнего колонтитула документа, если его нет. |
addHeader() | HeaderSection | Добавляет раздел заголовка документа, если его нет. |
addNamedRange(name, range) | NamedRange | Добавляет NamedRange , который представляет собой Range с именем и идентификатором, который можно использовать для последующего извлечения. |
addViewer(emailAddress) | Document | Добавляет данного пользователя в список читателей Document . |
addViewer(user) | Document | Добавляет данного пользователя в список читателей Document . |
addViewers(emailAddresses) | Document | Добавляет заданный массив пользователей в список читателей Document . |
getAs(contentType) | Blob | Извлекает текущее содержимое Document в виде большого двоичного объекта указанного типа. |
getBlob() | Blob | Извлекает текущее содержимое Document в виде большого двоичного объекта. |
getBody() | Body | Извлекает Body активного документа. |
getBookmark(id) | Bookmark | Получает Bookmark с заданным идентификатором. |
getBookmarks() | Bookmark[] | Получает все объекты Bookmark в документе. |
getCursor() | Position | Получает курсор пользователя в активном документе. |
getEditors() | User[] | Получает список редакторов этого Document . |
getFooter() | FooterSection | Извлекает нижний колонтитул документа, если он существует. |
getFootnotes() | Footnote[] | Извлекает все элементы Footnote в тексте документа. |
getHeader() | HeaderSection | Извлекает раздел заголовка документа, если он существует. |
getId() | String | Получает уникальный идентификатор документа. |
getLanguage() | String | Получает код языка документа. |
getName() | String | Получает заголовок документа. |
getNamedRangeById(id) | NamedRange | Получает NamedRange с заданным идентификатором. |
getNamedRanges() | NamedRange[] | Получает все объекты NamedRange в документе. |
getNamedRanges(name) | NamedRange[] | Получает все объекты NamedRange в документе с заданным именем. |
getSelection() | Range | Получает выбор пользователя в активном документе. |
getSupportedLanguageCodes() | String[] | Получает все коды языков, которые поддерживаются в файлах Документов Google. |
getUrl() | String | Получает URL-адрес для доступа к текущему документу. |
getViewers() | User[] | Получает список читателей и комментаторов этого Document . |
newPosition(element, offset) | Position | Создает новую Position , которая является ссылкой на местоположение в документе относительно определенного элемента. |
newRange() | RangeBuilder | Создает построитель, используемый для создания объектов Range из элементов документа. |
removeEditor(emailAddress) | Document | Удаляет данного пользователя из списка редакторов Document . |
removeEditor(user) | Document | Удаляет данного пользователя из списка редакторов Document . |
removeViewer(emailAddress) | Document | Удаляет данного пользователя из списка читателей и комментаторов Document . |
removeViewer(user) | Document | Удаляет данного пользователя из списка читателей и комментаторов Document . |
saveAndClose() | void | Сохраняет текущий Document . |
setCursor(position) | Document | Устанавливает курсор пользователя в активном документе с учетом Position . |
setLanguage(languageCode) | Document | Устанавливает код языка документа. |
setName(name) | Document | Устанавливает заголовок документа. |
setSelection(range) | Document | Устанавливает выбор пользователя в активном документе с заданным Range . |
Подробная документация
addBookmark(position)
Добавляет Bookmark
в указанную 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('abc123456'); // Gets the document 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
addEditor(emailAddress)
Добавляет данного пользователя в список редакторов Document
. Если пользователь уже был в списке зрителей, этот метод удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddress | String | Адрес электронной почты пользователя, которого требуется добавить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Добавляет данного пользователя в список редакторов Document
. Если пользователь уже был в списке зрителей, этот метод удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление добавляемого пользователя. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
Добавляет заданный массив пользователей в список редакторов Document
. Если кто-либо из пользователей уже был в списке зрителей, этот метод удаляет его из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddresses | String[] | Массив адресов электронной почты пользователей, которых нужно добавить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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('abc123456'); // Adds a header to the document. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Возвращаться
HeaderSection
— заголовок документа.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Добавляет NamedRange
, который представляет собой Range
с именем и идентификатором, который можно использовать для последующего извлечения. Имена не обязательно уникальны; несколько разных диапазонов в одном документе могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри документа, как идентификатор в HTML. После добавления NamedRange
в документ его нельзя изменить, а можно только удалить.
Любой сценарий, обращающийся к документу, может получить доступ к NamedRange
. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.
// Creates a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.addNamedRange('Document tables', rangeBuilder.build());
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | Имя диапазона, которое не обязательно должно быть уникальным; Имена диапазонов должны содержать от 1 до 256 символов. |
range | Range | Диапазон элементов, которые можно связать с именем; диапазон может быть активным выбором , результатом поиска или созданным вручную с помощью newRange() . |
Возвращаться
NamedRange
— NamedRange
.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
Добавляет данного пользователя в список читателей Document
. Если пользователь уже был в списке редакторов, этот метод не имеет никакого эффекта.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddress | String | Адрес электронной почты пользователя, которого требуется добавить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Добавляет данного пользователя в список читателей Document
. Если пользователь уже был в списке редакторов, этот метод не имеет никакого эффекта.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление добавляемого пользователя. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
Добавляет заданный массив пользователей в список читателей Document
. Если кто-то из пользователей уже был в списке редакторов, на них этот метод не действует.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddresses | String[] | Массив адресов электронной почты пользователей, которых нужно добавить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(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('abc123456'); // 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());
Параметры
Имя | Тип | Описание |
---|---|---|
contentType | String | Тип MIME для преобразования; в настоящее время поддерживается только 'application/pdf' . |
Возвращаться
Blob
— текущий документ в виде большого двоичного объекта.
getBlob()
Извлекает текущее содержимое 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('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Возвращаться
Blob
— текущий документ в виде большого двоичного объекта.
getBody()
Извлекает Body
активного документа.
Документы могут содержать разделы разных типов (например HeaderSection
, FooterSection
). Активным разделом документа является 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('abc123456'); // Gets the document 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
getBookmark(id)
Получает Bookmark
с заданным идентификатором. Этот метод возвращает 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('abc123456'); // Gets the bookmark by its ID. 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
getBookmarks()
Получает все объекты 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. const doc = DocumentApp.openById('abc123456'); // Gets all of the bookmarks in the document. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the document to the console. console.log(bookmarks.length);
Возвращаться
Bookmark[]
— Массив объектов Bookmark
в документе.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
Получает курсор пользователя в активном документе. Сценарий может получить доступ только к курсору пользователя, запускающего сценарий, и только в том случае, если сценарий привязан к документу.
// Insert some text at the cursor position and make it bold. var 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. var 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
getEditors()
Получает список редакторов этого Document
.
Возвращаться
User[]
— Массив пользователей с разрешением на редактирование.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFootnotes()
Извлекает все элементы Footnote
в тексте документа.
Вызовы getFootnotes
вызывают перебор элементов документа. Для больших документов избегайте ненужных вызовов этого метода.
// 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('abc123456'); // Gets the first footnote. 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
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('abc123456'); // Gets the text of the document's header and logs it to the console. console.log(doc.getHeader().getText());
Возвращаться
HeaderSection
— заголовок документа.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
Получает уникальный идентификатор документа. Идентификатор документа используется с DocumentApp.openById()
для открытия определенного экземпляра документа.
Возвращаться
String
— идентификатор документа
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
Получает код языка документа. Это язык, показанный в меню «Файл» > «Язык» редактора документов, который может не совпадать с фактическим языком, содержащимся в документе.
Возвращаться
String
— язык документа или null
, если оно не определено.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
Получает заголовок документа.
Возвращаться
String
— заголовок документа
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
Получает NamedRange
с заданным идентификатором. Этот метод возвращает значение null
, если такого NamedRange
не существует. Имена не обязательно уникальны; несколько разных диапазонов в одном документе могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри документа, как идентификатор в HTML.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор диапазона, который уникален в пределах документа. |
Возвращаться
NamedRange
— NamedRange
с заданным идентификатором или null
, если такого диапазона не существует.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
Получает все объекты NamedRange
в документе.
Доступ NamedRange
может быть получен любым сценарием, обращающимся к документу. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.
Возвращаться
NamedRange[]
— массив объектов NamedRange
в документе, возможно, включающий несколько диапазонов с одинаковым именем.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
Получает все объекты NamedRange
в документе с заданным именем. Имена не обязательно уникальны; несколько разных диапазонов в одном документе могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри документа, как идентификатор в HTML.
Доступ NamedRange
может быть получен любым сценарием, обращающимся к документу. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | имя диапазона, которое не обязательно уникально |
Возвращаться
NamedRange[]
— массив объектов NamedRange
в документе с заданным именем.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
Получает выбор пользователя в активном документе. Сценарий может получить доступ только к выбранному пользователю, который запускает сценарий, и только в том случае, если сценарий привязан к документу.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var 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
getSupportedLanguageCodes()
Получает все коды языков, которые поддерживаются в файлах Документов Google.
Возвращаться
String[]
— Массив кодов языков.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
Получает URL-адрес для доступа к текущему документу.
var 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
getViewers()
Получает список читателей и комментаторов этого Document
.
Возвращаться
User[]
— Массив пользователей с разрешением на просмотр или комментирование.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
Создает новую Position
, которая является ссылкой на местоположение в документе относительно определенного элемента. Курсор пользователя, помимо прочего, представлен как Position
.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var 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
newRange()
Создает построитель, используемый для создания объектов Range
из элементов документа.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Возвращаться
RangeBuilder
— новый конструктор
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Удаляет данного пользователя из списка редакторов Document
. Этот метод не блокирует доступ пользователей к Document
, если они принадлежат к классу пользователей, имеющих общий доступ — например, если Document
доступен всему домену пользователя или если Document
находится на общем диске, который пользователь может получить доступ.
Для файлов на Диске это также удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddress | String | Адрес электронной почты пользователя, которого необходимо удалить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Удаляет данного пользователя из списка редакторов Document
. Этот метод не блокирует доступ пользователей к Document
, если они принадлежат к классу пользователей, имеющих общий доступ — например, если Document
доступен всему домену пользователя или если Document
находится на общем диске, который пользователь может получить доступ.
Для файлов на Диске это также удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление пользователя, которого нужно удалить. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Удаляет данного пользователя из списка читателей и комментаторов Document
. Этот метод не имеет эффекта, если пользователь является редактором, а не зрителем или комментатором. Этот метод также не блокирует доступ пользователей к Document
, если они принадлежат к классу пользователей, имеющих общий доступ — например, если Document
доступен всему домену пользователя или если Document
находится на общем диске, который пользователь может получить доступ.
Для файлов Диска это также удаляет пользователя из списка редакторов.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddress | String | Адрес электронной почты пользователя, которого необходимо удалить. |
Возвращаться
Document
— Этот Document
для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Удаляет данного пользователя из списка читателей и комментаторов Document
. Этот метод не имеет эффекта, если пользователь является редактором, а не зрителем. Этот метод также не блокирует доступ пользователей к Document
, если они принадлежат к классу пользователей, имеющих общий доступ — например, если Document
доступен всему домену пользователя или если Document
находится на общем диске, который пользователь может получить доступ.
Для файлов Диска это также удаляет пользователя из списка редакторов.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление пользователя, которого нужно удалить. |
Возвращаться
Document
— Этот Document
для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
Сохраняет текущий Document
. Вызывает очистку и применение ожидающих обновлений.
Метод saveAndClose()
автоматически вызывается в конце выполнения скрипта для каждого открытого редактируемого Document
.
Закрытый Document
редактировать нельзя. Используйте DocumentApp.openById()
, чтобы повторно открыть данный документ для редактирования.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Устанавливает курсор пользователя в активном документе с учетом Position
. Сценарий может получить доступ только к курсору пользователя, запускающего сценарий, и только в том случае, если сценарий привязан к документу.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.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
setLanguage(languageCode)
Устанавливает код языка документа. Это язык, показанный в меню «Файл» > «Язык» редактора документов, который может не совпадать с фактическим языком, содержащимся в документе. Используйте getSupportedLanguageCodes()
, чтобы получить все действительные коды языков.
Параметры
Имя | Тип | Описание |
---|---|---|
languageCode | String | Код языка. |
Возвращаться
Document
— Этот Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
Устанавливает заголовок документа.
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | новое название документа |
Возвращаться
Document
— текущий документ
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
Устанавливает выбор пользователя в активном документе с заданным Range
. Сценарий может получить доступ только к выбранному пользователю, который запускает сценарий, и только в том случае, если сценарий привязан к документу.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var 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