Документ, содержащий один или несколько объектов Tab
, каждый из которых содержит форматированный текст и такие элементы, как таблицы и списки.
Документы можно открывать или создавать с помощью DocumentApp
.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
Методы класса Document
, которые напрямую обращаются к текстовому содержимому и изменяют его, работают либо на активной вкладке (в сценариях , привязанных к определенному документу), либо на первой вкладке (если активная вкладка недоступна). Скрипты, использующие эти методы (например, getBody()
), можно перенести для поддержки вкладок с помощью getTabs()
, а затем Tab.asDocumentTab()
.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
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 . |
getActiveTab() | Tab | Получает активную Tab пользователя в документе. |
getAs(contentType) | Blob | Извлекает текущее содержимое Document в виде большого двоичного объекта указанного типа. |
getBlob() | Blob | Извлекает текущее содержимое Document в виде большого двоичного объекта. |
getBody() | Body | Извлекает Body первой вкладки или, для сценариев, привязанных к документу, DocumentBodySection активной вкладки. |
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. |
getTab(tabId) | Tab | Получает Tab с указанным идентификатором. |
getTabs() | Tab[] | Получает все невложенные элементы Tab , являющиеся частью документа. |
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 . |
setActiveTab(tabId) | void | Устанавливает выбранную пользователем Tab в текущем документе на вкладку с указанным идентификатором. |
setCursor(position) | Document | Устанавливает курсор пользователя по заданной Position . |
setLanguage(languageCode) | Document | Устанавливает код языка документа. |
setName(name) | Document | Устанавливает заголовок документа. |
setSelection(range) | Document | Устанавливает выбор пользователя на активной вкладке с заданным Range . |
Подробная документация
addBookmark(position)
Добавляет Bookmark
в указанной Position
на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку. Чтобы добавить закладку на любую вкладку, используйте метод DocumentTab.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(DOCUMENT_ID); // 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
addEditor(emailAddress)
Добавляет данного пользователя в список редакторов Document
. Если пользователь уже был в списке зрителей, этот метод удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddress | String | Адрес электронной почты пользователя, которого необходимо добавить. |
Возвращаться
Document
— This Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Добавляет данного пользователя в список редакторов Document
. Если пользователь уже был в списке зрителей, этот метод удаляет пользователя из списка зрителей.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление добавляемого пользователя. |
Возвращаться
Document
— This 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()
Добавляет раздел заголовка, если он не существует, на первую вкладку или, для сценариев, привязанных к документу, на активную вкладку. Чтобы добавить раздел заголовка на любую вкладку, используйте метод DocumentTab.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(DOCUMENT_ID); // 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');
Возвращаться
HeaderSection
— заголовок вкладки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Добавляет NamedRange
, который представляет собой Range
с именем и идентификатором, который можно использовать для последующего извлечения, на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы добавить NamedRange
на любую вкладку, используйте метод DocumentTab.addNamedRange(name, range)
. Имена не обязательно уникальны; несколько разных диапазонов в одном документе могут иметь одно и то же имя, как класс в HTML. Идентификаторы, напротив, уникальны внутри документа, как идентификатор в HTML. После добавления NamedRange
в документ его нельзя изменить, а можно только удалить.
Любой скрипт, обращающийся к документу, может получить доступ к NamedRange
. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.
// Creates a named range that includes every table in the active tab. 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]); } // Adds the named range to the document's active tab. 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
— This Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Добавляет данного пользователя в список читателей Document
. Если пользователь уже был в списке редакторов, этот метод не имеет никакого эффекта.
Параметры
Имя | Тип | Описание |
---|---|---|
user | User | Представление добавляемого пользователя. |
Возвращаться
Document
— This Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
Добавляет заданный массив пользователей в список читателей Document
. Если кто-то из пользователей уже был в списке редакторов, на них этот метод не действует.
Параметры
Имя | Тип | Описание |
---|---|---|
emailAddresses | String[] | Массив адресов электронной почты пользователей, которых нужно добавить. |
Возвращаться
Document
— This Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getActiveTab()
Получает активную 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
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(DOCUMENT_ID); // 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' и 'text/markdown' . |
Возвращаться
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(DOCUMENT_ID); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Возвращаться
Blob
— текущий документ в виде большого двоичного объекта.
getBody()
Извлекает Body
первой вкладки или, для сценариев, привязанных к документу, DocumentBodySection
активной вкладки. Чтобы получить DocumentBodySection
любой вкладки, используйте метод DocumentTab.getBody()
.
Вкладки могут содержать разделы разных типов (например, 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(DOCUMENT_ID); // 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
getBookmark(id)
Получает Bookmark
с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить закладку на любой вкладке, используйте метод DocumentTab.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(DOCUMENT_ID); // 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
getBookmarks()
Получает все объекты Bookmark
на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить все закладки на любой вкладке, используйте метод DocumentTab.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(DOCUMENT_ID); // 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
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
в теле первой вкладки или, для сценариев, привязанных к документу, в теле активной вкладки. Чтобы получить все сноски на любой вкладке, используйте метод DocumentTab.getFootnotes()
.
Вызовы 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(DOCUMENT_ID); // 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
getHeader()
Извлекает раздел заголовка первой вкладки или, для сценариев, привязанных к документу, раздел заголовка активной вкладки. Чтобы получить раздел заголовка любой вкладки, используйте метод DocumentTab.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(DOCUMENT_ID); // Gets the text of the active or first tab'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
с заданным идентификатором на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить NamedRange
с заданным идентификатором на любой вкладке, используйте метод DocumentTab.getNamedRangeById(id)
. Этот метод возвращает 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
на любой вкладке, используйте метод DocumentTab.getNamedRanges()
.
Доступ NamedRange
может получить любой скрипт, обращающийся к вкладке. Чтобы избежать непреднамеренных конфликтов между сценариями, рассмотрите возможность добавления к именам диапазонов префиксов с уникальной строкой.
Возвращаться
NamedRange[]
— Массив объектов NamedRange
на вкладке, возможно, включающий несколько диапазонов с одинаковым именем.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
Получает все объекты NamedRange
с заданным именем на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы получить все объекты NamedRange
на любой вкладке, используйте метод DocumentTab.getNamedRanges(name)
. Имена не обязательно уникальны, даже на разных вкладках; несколько разных диапазонов на одной вкладке могут иметь одно и то же имя, как класс в 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
getTab(tabId)
Получает Tab
с указанным идентификатором. Этот метод возвращает null
, если такой Tab
не существует. Доступ к вкладкам на любом уровне вложенности.
Параметры
Имя | Тип | Описание |
---|---|---|
tabId | String | Идентификатор вкладки, которую необходимо получить. |
Возвращаться
Tab
— Tab
с указанным идентификатором или null
, если такой Tab
не существует.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTabs()
Получает все невложенные элементы Tab
, являющиеся частью документа.
Вкладки могут содержать дочерние вкладки, вкладки, вложенные в другие вкладки. Дочерние вкладки доступны с помощью Tab.getChildTabs()
.
Возвращаться
Tab[]
— Список всех Tab
, которые являются частью документа.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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
относительно местоположения на любой вкладке, используйте метод DocumentTab.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. 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
из элементов вкладки на первой вкладке или, для сценариев, привязанных к документу, на активной вкладке. Чтобы создать построитель, используемый для создания объектов DocumentRange
из элементов вкладки на любой вкладке, используйте метод DocumentTab.newRange()
.
// Change the user's selection to a range that includes every table in the active tab. 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
— This 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
setActiveTab(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(TAB_ID);
Параметры
Имя | Тип | Описание |
---|---|---|
tabId | String | Идентификатор вкладки, которую нужно сделать активной. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Устанавливает курсор пользователя по заданной Position
. Сценарий может получить доступ только к курсору пользователя, запускающего сценарий, и только в том случае, если сценарий привязан к документу.
Предоставление Position
из неактивной Tab
переключает активную вкладку пользователя.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var 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
setLanguage(languageCode)
Устанавливает код языка документа. Это язык, показанный в меню «Файл» > «Язык» редактора документов, который может не совпадать с фактическим языком, содержащимся в документе. Используйте getSupportedLanguageCodes()
чтобы получить все действительные коды языков.
Параметры
Имя | Тип | Описание |
---|---|---|
languageCode | String | Код языка. |
Возвращаться
Document
— This 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
. Сценарий может получить доступ только к выбранному пользователю, который запускает сценарий, и только если сценарий привязан к документу.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Параметры
Имя | Тип | Описание |
---|---|---|
range | Range | Новый диапазон элементов для выбора. |
Возвращаться
Document
— This Document
для связывания.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents