Class Document

Добавляет 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());

}

Параметры

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

Bookmark — новая закладка.

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

Добавляет раздел нижнего колонтитула документа, если его нет.

// 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 footer to the document.
const footer = doc.addFooter();

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

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

FooterSection — Нижний колонтитул документа.

Авторизация

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

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

Добавляет раздел заголовка документа, если он не существует.

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

Добавляет 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());

Параметры

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

NamedRange — NamedRange .

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

Параметры

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

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

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

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

Blob — текущий документ в виде большого двоичного объекта.

Извлекает 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

Получает 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.');
}

Параметры

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

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

Авторизация

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

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

Получает все объекты 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

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

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

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

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

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

Авторизация

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

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

Извлекает раздел нижнего колонтитула документа, если он существует.

// 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 footer and logs it to the console.
console.log(doc.getFooter().getText());

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

FooterSection — Нижний колонтитул документа.

Авторизация

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

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

Извлекает все элементы 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

Извлекает раздел заголовка документа, если он существует.

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

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

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

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

Авторизация

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

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

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

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

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

Авторизация

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

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

Получает название документа.

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

String — название документа

Авторизация

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

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

Получает NamedRange с заданным идентификатором. Этот метод возвращает null если такого NamedRange не существует. Имена не обязательно уникальны; несколько разных диапазонов в одном и том же документе могут иметь одно и то же имя, как класс в HTML. И наоборот, идентификаторы уникальны в пределах документа, как идентификаторы в HTML.

Параметры

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

NamedRange — NamedRange с заданным идентификатором или null , если такой диапазон не существует.

Авторизация

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

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

Получает все объекты NamedRange в документе.

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

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

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

Авторизация

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

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

Получает все объекты NamedRange в документе с заданным именем. Имена не обязательно уникальны; несколько разных диапазонов в одном и том же документе могут иметь одно и то же имя, как класс в HTML. И наоборот, идентификаторы уникальны в пределах документа, как идентификаторы в HTML.

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

Параметры

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

NamedRange[] — массив объектов NamedRange в документе с заданным именем

Авторизация

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

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

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

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

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

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

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

Авторизация

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

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

Извлекает 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

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

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

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

Авторизация

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

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

Создает новую 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

Авторизация

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

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

Создает построитель, используемый для построения объектов 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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

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

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

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

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

Параметры

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

Document — этот Document для цепочки.

Авторизация

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

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

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

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

Параметры

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

Document — этот Document для цепочки.

Авторизация

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

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

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

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

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

Авторизация

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

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

Устанавливает курсор пользователя в активном документе с учетом 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);

Параметры

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

Document — этот Document , для цепочки

Авторизация

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

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

Устанавливает код языка документа. Это язык, отображаемый в меню Файл > Язык редактора документов, который может не совпадать с фактическим языком, содержащимся в документе. Используйте getSupportedLanguageCodes() , чтобы получить все действительные коды языков.

Параметры

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

Document — Этот Document для цепочки.

Авторизация

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

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

Устанавливает заголовок документа.

Параметры

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

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

Авторизация

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

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

Устанавливает выбор пользователя в активном документе с заданным 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());

Параметры

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

Document — этот Document , для цепочки

Авторизация

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

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