Document Service

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

// Open a document by ID. var doc = DocumentApp.openById('DOCUMENT_ID'); // Create and open a document. doc = DocumentApp.create('Document Name');

Классы

Имя Краткое описание
Attribute Перечисление атрибутов элемента.
Body Содержимое вкладки в документе Google Docs.
Bookmark Объект, представляющий закладку.
ContainerElement Общий элемент, который может содержать другие элементы.
Date Элемент, представляющий форматированную дату
Document Документ, содержащий один или несколько объектов Tab , каждый из которых содержит форматированный текст и такие элементы, как таблицы и списки.
DocumentApp Служба документов создает и открывает Documents , которые можно редактировать.
DocumentTab Вкладка документа, содержащая форматированный текст и такие элементы, как таблицы и списки.
Element Общий элемент.
ElementType Перечисление всех типов элементов.
Equation Элемент, представляющий математическое выражение.
EquationFunction Элемент, представляющий функцию в математическом Equation .
EquationFunctionArgumentSeparator Элемент, представляющий разделитель функций в математическом Equation .
EquationSymbol Элемент, представляющий символ в математическом Equation .
FontFamily Перечень поддерживаемых шрифтов.
FooterSection Элемент, представляющий раздел нижнего колонтитула.
Footnote Элемент, представляющий сноску.
FootnoteSection Элемент, представляющий раздел сноски.
GlyphType Перечисление поддерживаемых типов глифов.
HeaderSection Элемент, представляющий раздел заголовка.
HorizontalAlignment Перечисление поддерживаемых типов горизонтального выравнивания.
HorizontalRule Элемент, представляющий горизонтальную линейку.
InlineDrawing Элемент, представляющий встроенный рисунок.
InlineImage Элемент, представляющий внедренное изображение.
ListItem Элемент, представляющий элемент списка.
NamedRange Range , имеющий имя и идентификатор, позволяющий его позднее получить.
PageBreak Элемент, представляющий разрыв страницы.
Paragraph Элемент, представляющий абзац.
ParagraphHeading Перечисление стандартных заголовков абзацев.
Person Элемент, представляющий ссылку на человека.
Position Ссылка на местоположение на вкладке документа относительно определенного элемента.
PositionedImage Изображение с фиксированным положением, привязанное к Paragraph .
PositionedLayout Перечисление, указывающее, как расположить PositionedImage относительно окружающего текста.
Range Диапазон элементов в документе.
RangeBuilder Построитель, используемый для создания объектов Range из элементов документа.
RangeElement Обертка вокруг Element с возможным смещением начала и конца.
RichLink Элемент, представляющий ссылку на ресурс Google, например файл на Диске или видео YouTube.
Tab Вкладка в документе Google Docs.
TabType Перечисление всех типов вкладок.
Table Элемент, представляющий таблицу.
TableCell Элемент, представляющий ячейку таблицы.
TableOfContents Элемент, содержащий оглавление.
TableRow Элемент, представляющий строку таблицы.
Text Элемент, представляющий область форматированного текста.
TextAlignment Перечисление типов выравнивания текста.
UnsupportedElement Элемент, представляющий регион, который неизвестен или не может быть затронут сценарием, например номер страницы.
VerticalAlignment Перечисление поддерживаемых типов вертикального выравнивания.

Attribute

Характеристики

Свойство Тип Описание
BACKGROUND_COLOR Enum Цвет фона элемента (абзаца, таблицы и т. д.) или документа.
BOLD Enum Настройка толщины шрифта для форматированного текста.
BORDER_COLOR Enum Цвет границы для элементов таблицы.
BORDER_WIDTH Enum Ширина границы в пунктах для элементов таблицы.
CODE Enum Содержимое кода для элементов уравнения.
FONT_FAMILY Enum Настройка семейства шрифтов для форматированного текста.
FONT_SIZE Enum Настройка размера шрифта в пунктах для форматированного текста.
FOREGROUND_COLOR Enum Настройка цвета переднего плана для форматированного текста.
HEADING Enum Тип заголовка для элементов абзаца (например, DocumentApp.ParagraphHeading.HEADING1 ).
HEIGHT Enum Настройка высоты для элементов изображения.
HORIZONTAL_ALIGNMENT Enum Горизонтальное выравнивание для элементов абзаца (например, DocumentApp.HorizontalAlignment.CENTER ).
INDENT_END Enum Настройка конечного отступа для элементов абзаца в пунктах.
INDENT_FIRST_LINE Enum Настройка отступа первой строки в пунктах для элементов абзаца.
INDENT_START Enum Начальный отступ в пунктах для элементов абзаца.
ITALIC Enum Настройка стиля шрифта для форматированного текста.
GLYPH_TYPE Enum Тип глифа для элементов элемента списка.
LEFT_TO_RIGHT Enum Настройка направления текста для форматированного текста.
LINE_SPACING Enum Параметр межстрочного интервала в качестве множителя для элементов абзаца.
LINK_URL Enum URL-адрес ссылки для форматированного текста.
LIST_ID Enum Идентификатор охватывающего списка для элементов списка.
MARGIN_BOTTOM Enum Настройка нижнего поля в пунктах для элементов абзаца.
MARGIN_LEFT Enum Настройка левого поля в пунктах для элементов абзаца.
MARGIN_RIGHT Enum Настройка правого поля в пунктах для элементов абзаца.
MARGIN_TOP Enum Настройка верхнего поля в пунктах для элементов абзаца.
NESTING_LEVEL Enum Уровень вложенности элементов для элементов списка.
MINIMUM_HEIGHT Enum Минимальная настройка высоты в пунктах для элементов строки таблицы.
PADDING_BOTTOM Enum Настройка нижнего заполнения в пунктах для элементов ячейки таблицы.
PADDING_LEFT Enum Настройка левого заполнения в пунктах для элементов ячейки таблицы.
PADDING_RIGHT Enum Правильная настройка заполнения в пунктах для элементов ячейки таблицы.
PADDING_TOP Enum Настройка верхнего заполнения в пунктах для элементов ячейки таблицы.
PAGE_HEIGHT Enum Настройка высоты страницы в пунктах для документов.
PAGE_WIDTH Enum Настройка ширины страницы в пунктах для документов.
SPACING_AFTER Enum Настройка нижнего интервала в пунктах для элементов абзаца.
SPACING_BEFORE Enum Настройка верхнего интервала в пунктах для элементов абзаца.
STRIKETHROUGH Enum Настройка зачеркивания для форматированного текста.
UNDERLINE Enum Настройка подчеркивания для форматированного текста.
VERTICAL_ALIGNMENT Enum Настройка вертикального выравнивания для элементов ячеек таблицы.
WIDTH Enum Настройка ширины для ячеек таблицы и элементов изображения.

Body

Методы

Метод Тип возврата Краткое описание
appendHorizontalRule() HorizontalRule Создает и добавляет новый HorizontalRule .
appendImage(image) InlineImage Создает и добавляет новый InlineImage из указанного BLOB-объекта изображения.
appendImage(image) InlineImage Добавляет заданный InlineImage .
appendListItem(listItem) ListItem Добавляет данный ListItem .
appendListItem(text) ListItem Создает и добавляет новый ListItem содержащий указанное текстовое содержимое.
appendPageBreak() PageBreak Создает и добавляет новый PageBreak .
appendPageBreak(pageBreak) PageBreak Добавляет заданный PageBreak .
appendParagraph(paragraph) Paragraph Добавляет данный Paragraph .
appendParagraph(text) Paragraph Создает и добавляет новый Paragraph , содержащий указанное текстовое содержимое.
appendTable() Table Создает и добавляет новую Table .
appendTable(cells) Table Добавляет новую Table , содержащую TableCell для каждого указанного строкового значения.
appendTable(table) Table Добавляет данную Table .
clear() Body Очищает содержимое элемента.
copy() Body Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getHeadingAttributes(paragraphHeading) Object Получает набор атрибутов для предоставленного ParagraphHeading .
getImages() InlineImage[] Извлекает все InlineImages содержащиеся в разделе.
getListItems() ListItem[] Извлекает все ListItems содержащиеся в разделе.
getMarginBottom() Number Получает нижнее поле в пунктах.
getMarginLeft() Number Получает левое поле в пунктах.
getMarginRight() Number Получает правое поле.
getMarginTop() Number Получает верхнее поле.
getNumChildren() Integer Получает количество детей.
getPageHeight() Number Получает высоту страницы в пунктах.
getPageWidth() Number Получает ширину страницы в пунктах.
getParagraphs() Paragraph[] Извлекает все Paragraphs содержащиеся в разделе (включая ListItems ).
getParent() ContainerElement Извлекает родительский элемент элемента.
getTables() Table[] Извлекает все Tables содержащиеся в разделе.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
insertHorizontalRule(childIndex) HorizontalRule Создает и вставляет новое HorizontalRule по указанному индексу.
insertImage(childIndex, image) InlineImage Создает и вставляет InlineImage из указанного большого двоичного объекта изображения по указанному индексу.
insertImage(childIndex, image) InlineImage Вставляет заданный InlineImage по указанному индексу.
insertListItem(childIndex, listItem) ListItem Вставляет заданный ListItem по указанному индексу.
insertListItem(childIndex, text) ListItem Создает и вставляет новый ListItem по указанному индексу, содержащий указанное текстовое содержимое.
insertPageBreak(childIndex) PageBreak Создает и вставляет новый PageBreak по указанному индексу.
insertPageBreak(childIndex, pageBreak) PageBreak Вставляет заданный PageBreak по указанному индексу.
insertParagraph(childIndex, paragraph) Paragraph Вставляет данный Paragraph по указанному индексу.
insertParagraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу, содержащий указанное текстовое содержимое.
insertTable(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insertTable(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insertTable(childIndex, table) Table Вставляет данную Table по указанному индексу.
removeChild(child) Body Удаляет указанный дочерний элемент.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) Body Устанавливает атрибуты элемента.
setHeadingAttributes(paragraphHeading, attributes) Body Устанавливает атрибуты для предоставленного ParagraphHeading .
setMarginBottom(marginBottom) Body Устанавливает нижнее поле в пунктах.
setMarginLeft(marginLeft) Body Устанавливает левое поле в пунктах.
setMarginRight(marginRight) Body Устанавливает правое поле в пунктах.
setMarginTop(marginTop) Body Устанавливает верхнее поле.
setPageHeight(pageHeight) Body Устанавливает высоту страницы в пунктах.
setPageWidth(pageWidth) Body Устанавливает ширину страницы в пунктах.
setText(text) Body Устанавливает содержимое в виде обычного текста.
setTextAlignment(textAlignment) Body Устанавливает выравнивание текста.

Bookmark

Методы

Метод Тип возврата Краткое описание
getId() String Получает идентификатор Bookmark .
getPosition() Position Получает Position Bookmark на DocumentTab .
remove() void Удаляет Bookmark .

ContainerElement

Методы

Метод Тип возврата Краткое описание
asBody() Body Возвращает текущий элемент как Body .
asEquation() Equation Возвращает текущий элемент как Equation .
asFooterSection() FooterSection Возвращает текущий элемент как FooterSection .
asFootnoteSection() FootnoteSection Возвращает текущий элемент как FootnoteSection .
asHeaderSection() HeaderSection Возвращает текущий элемент как HeaderSection .
asListItem() ListItem Возвращает текущий элемент как ListItem .
asParagraph() Paragraph Возвращает текущий элемент как Paragraph .
asTable() Table Возвращает текущий элемент в виде Table .
asTableCell() TableCell Возвращает текущий элемент как TableCell .
asTableOfContents() TableOfContents Возвращает текущий элемент как TableOfContents .
asTableRow() TableRow Возвращает текущий элемент как TableRow .
clear() ContainerElement Очищает содержимое элемента.
copy() ContainerElement Возвращает отдельную глубокую копию текущего элемента.
editAsText() Text Получает Text версию текущего элемента для редактирования.
findElement(elementType) RangeElement Ищет в содержимом элемента потомка указанного типа.
findElement(elementType, from) RangeElement Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement .
findText(searchPattern) RangeElement Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
findText(searchPattern, from) RangeElement Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
getAttributes() Object Получает атрибуты элемента.
getChild(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
getChildIndex(child) Integer Получает дочерний индекс для указанного дочернего элемента.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getNumChildren() Integer Получает количество детей.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getText() String Извлекает содержимое элемента в виде текстовой строки.
getTextAlignment() TextAlignment Получает выравнивание текста.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() ContainerElement Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() ContainerElement Удаляет элемент из его родителя.
replaceText(searchPattern, replacement) Element Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
setAttributes(attributes) ContainerElement Устанавливает атрибуты элемента.
setLinkUrl(url) ContainerElement Устанавливает URL-адрес ссылки.
setTextAlignment(textAlignment) ContainerElement Устанавливает выравнивание текста.

Date

Методы

Метод Тип возврата Краткое описание
copy() Date Возвращает отдельную глубокую копию текущего элемента.
getAttributes() Object Получает атрибуты элемента.
getDisplayText() String Возвращает отображаемое значение, отображаемое в документе.
getLocale() String Возвращает языковой стандарт даты, используемый для отображаемого значения.
getNextSibling() Element Извлекает следующий родственный элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getTimestamp() Date Возвращает метку времени, связанную с датой.
getType() ElementType Получает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Date Объединяет элемент с предыдущим одноуровневым элементом того же типа.
removeFromParent() Date Удаляет элемент из его родителя.
setAttributes(attributes) Date Устанавливает атрибуты элемента.

Document

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