- Ресурс: Документ
- Тело
- СтруктурныйЭлемент
- Параграф
- Элемент Параграфа
- ТекстРан
- ТекстСтиль
- Дополнительный цвет
- Цвет
- Цвет RGB
- Измерение
- Единица
- Семейство взвешенных шрифтов
- Базовое смещение
- Связь
- Предложенныйтекстовый стиль
- TextStyleSuggestionState
- Авто текст
- Тип
- Разрыв страницы
- Разрыв столбца
- СноскаСсылка
- ГоризонтальноеПравило
- Уравнение
- ИнлайнОбжектЭлемент
- Человек
- Свойства человека
- РичЛинк
- RichLinkСвойства
- Стиль абзаца
- Именедстилетипе
- Выравнивание
- Контентдиректион
- Режим интервала
- Граница Абзаца
- ДашСтиль
- ТабСтоп
- TabStopAlignment
- Затенение
- Предложенный стиль абзаца
- Состояние абзацаStyleSuggestion
- Состояние ЗатененияПредложение
- Пуля
- Предложенный пуллет
- BulletSuggestionState
- Объектные ссылки
- Разрыв раздела
- РазделСтиль
- Свойства секцииColumnProperties
- СтолбецРазделительСтиль
- Тип секции
- Стол
- ТаблицаРоу
- Таблеселл
- TableCellStyle
- ТаблицаЯчейкаГраница
- СодержаниеВыравнивание
- Предложенныйтаблецелстиле
- TableCellStyleSuggestionState
- TableRowStyle
- ПредложенныйTableRowStyle
- TableRowStyleSuggestionState
- Стиль таблицы
- Свойства столбца таблицы
- Тип ширины
- Оглавление
- Заголовок
- Нижний колонтитул
- Сноска
- Стиль документа
- Фон
- Размер
- Предложенный стиль документа
- DocumentStyleSuggestionState
- ФонПредложениеСостояние
- Состояние Размера предложения
- Именованные стили
- именованный стиль
- Предложенные именованные стили
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- Список
- Список свойств
- Уровень вложенности
- Выравнивание пули
- Тип глифа
- Предложенные свойства списка
- ListPropertiesSuggestionState
- Состояние вложенностиLevelSuggestionState
- Именованные диапазоны
- Именованныйдиапазон
- Диапазон
- ПредложенияViewMode
- ИнлайнОбъект
- Свойства инлайнобжекта
- ВстроенныйОбъект
- Свойства встроенного чертежа
- Свойства изображения
- Свойства урожая
- ВстроенныйОбъектГраница
- Пропертитестате
- Ссылка на связанное содержимое
- ЛистыДиаграммаСсылка
- Предложенные свойства InlineObject
- InlineObjectPropertiesSuggestionState
- Эмбеддедобжектсуггестионстате
- ВстроенноеDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- ЛистыДиаграммаСсылкаПредложениеСостояние
- ПозиционированныйОбъект
- Свойства позиционированного объекта
- Позиционирование объекта
- ПозиционированныйОбжектЛайаут
- Предложенные свойства объектаPositionedObjectProperties
- ПозиционированныйОбъектСвойстваСуггестионСостояние
- PositionedObjectPositioningSuggestionState
- Методы
Ресурс: Документ
Документ Google Docs.
JSON-представление |
---|
{ "documentId": string, "title": string, "body": { object ( |
Поля | |
---|---|
documentId | Только вывод. Идентификатор документа. |
title | Название документа. |
body | Только вывод. Основная часть документа. |
headers | Только вывод. Заголовки в документе, связанные с идентификатором заголовка. |
footers | Только вывод. Нижние колонтитулы в документе, обозначенные идентификатором нижнего колонтитула. |
footnotes | Только вывод. Сноски в документе, обозначенные идентификатором сноски. |
documentStyle | Только вывод. Стиль документа. |
suggestedDocumentStyleChanges | Только вывод. Предлагаемые изменения стиля документа с указанием идентификатора предложения. |
namedStyles | Только вывод. Именованные стили документа. |
suggestedNamedStylesChanges | Только вывод. Предлагаемые изменения в названных стилях документа с указанием идентификатора предложения. |
lists | Только вывод. Списки в документе, сгруппированные по идентификатору списка. |
namedRanges | Только вывод. Именованные диапазоны в документе с ключом по имени. |
revisionId | Только вывод. Идентификатор редакции документа. Может использоваться в запросах на обновление, чтобы указать, к какой версии документа следует применять обновления и как должен вести себя запрос, если документ редактировался после этой версии. Заполняется только в том случае, если у пользователя есть доступ к редактированию документа. Идентификатор редакции — это не последовательный номер, а непрозрачная строка. Формат идентификатора версии может со временем измениться. Возвращенный идентификатор версии гарантированно действителен только в течение 24 часов после его возврата и не может быть передан другим пользователям. Если идентификатор редакции не меняется между вызовами, то документ не изменился. И наоборот, изменение идентификатора (для того же документа и пользователя) обычно означает, что документ был обновлен. Однако изменение идентификатора также может быть связано с внутренними факторами, такими как изменение формата идентификатора. |
suggestionsViewMode | Только вывод. К документу применен режим просмотра предложений. Примечание. При редактировании документа изменения должны быть основаны на документе с |
inlineObjects | Только вывод. Встроенные объекты в документе, обозначенные идентификатором объекта. |
positionedObjects | Только вывод. Размещенные объекты в документе с указанием идентификатора объекта. |
Тело
Тело документа.
Тело обычно содержит все содержимое документа, за исключением headers
, footers
и footnotes
.
JSON-представление |
---|
{
"content": [
{
object ( |
Поля | |
---|---|
content[] | Содержимое тела. Индексы содержимого тела начинаются с нуля. |
СтруктурныйЭлемент
StructuralElement описывает содержимое, которое обеспечивает структуру документа.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Поля | |
---|---|
startIndex | Начальный индекс этого структурного элемента, отсчитываемый от нуля, в кодовых единицах UTF-16. |
endIndex | Конечный индекс этого структурного элемента, начинающийся с нуля, исключая его в кодовых единицах UTF-16. |
content поля объединения. Содержание структурного элемента. content может быть только одним из следующих: | |
paragraph | Структурный элемент типа абзаца. |
sectionBreak | Тип разрыва сечения структурного элемента. |
table | Табличный тип структурного элемента. |
tableOfContents | Оглавление типа структурного элемента. |
Параграф
StructuralElement
, представляющий абзац. Абзац — это диапазон содержимого, заканчивающийся символом новой строки.
JSON-представление |
---|
{ "elements": [ { object ( |
Поля | |
---|---|
elements[] | Содержание абзаца, разбитое на составные части. |
paragraphStyle | Стиль этого абзаца. |
suggestedParagraphStyleChanges | Предлагаемый стиль абзаца изменится на этот абзац с указанием идентификатора предложения. |
bullet | Пуля для этого абзаца. Если он отсутствует, абзац не принадлежит списку. |
suggestedBulletChanges | Предлагаемые изменения к пункту этого абзаца. |
positionedObjectIds[] | Идентификаторы позиционированных объектов, привязанных к этому абзацу. |
suggestedPositionedObjectIds | Идентификаторы размещенных объектов, которые предлагается прикрепить к этому абзацу, с ключом по идентификатору предложения. |
Элемент Параграфа
ParagraphElement описывает содержимое внутри Paragraph
.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
Поля | |
---|---|
startIndex | Начальный индекс этого элемента абзаца, отсчитываемый от нуля, в кодовых единицах UTF-16. |
endIndex | Конечный индекс этого элемента абзаца с нулевой базой, исключая его, в кодовых единицах UTF-16. |
content поля объединения. Содержимое элемента абзаца. content может быть только одним из следующих: | |
textRun | Элемент абзаца текстового фрагмента. |
autoText | Элемент абзаца автоматического текста. |
pageBreak | Элемент абзаца разрыва страницы. |
columnBreak | Элемент абзаца разрыва столбца. |
footnoteReference | Элемент абзаца ссылки на сноску. |
horizontalRule | Элемент абзаца горизонтального правила. |
equation | Элемент абзаца уравнения. |
inlineObjectElement | Элемент абзаца встроенного объекта. |
person | Элемент абзаца, который ссылается на человека или адрес электронной почты. |
richLink | Элемент абзаца, который ссылается на ресурс Google (например, файл на Google Диске, видео YouTube или событие Календаря). |
ТекстРан
Элемент ParagraphElement
, представляющий фрагмент текста, имеющий одинаковый стиль.
JSON-представление |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
content | Текст этого пробега. Все нетекстовые элементы в выполнении заменяются символом Юникода U+E907. |
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Стиль текста этого запуска. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится в этом запуске с указанием идентификатора предложения. |
ТекстСтиль
Представляет стиль, который можно применить к тексту.
Унаследованные стили текста представлены в этом сообщении как неустановленные поля. Родитель текстового стиля зависит от того, где определен текстовый стиль:
- TextStyle текста в
Paragraph
наследуется от соответствующегоnamed style type
абзаца. - TextStyle
named style
наследуется отnormal text
с именем style. - TextStyle
normal text
с именем style наследуется от стиля текста по умолчанию в редакторе документов. - TextStyle элемента
Paragraph
, содержащегося в таблице, может наследовать стиль текста от стиля таблицы.
Если стиль текста не унаследован от родительского элемента, при отмене полей стиль вернется к значению, соответствующему значениям по умолчанию в редакторе Документов.
JSON-представление |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
Поля | |
---|---|
bold | Будет ли текст выделен жирным шрифтом. |
italic | Выделен ли текст курсивом или нет. |
underline | Подчеркнут или нет текст. |
strikethrough | Независимо от того, перечеркнут ли текст. |
smallCaps | Независимо от того, написан ли текст маленькими заглавными буквами. |
backgroundColor | Цвет фона текста. Если установлено, цвет является либо цветом RGB, либо прозрачным, в зависимости от |
foregroundColor | Цвет переднего плана текста. Если установлено, цвет является либо цветом RGB, либо прозрачным, в зависимости от |
fontSize | Размер шрифта текста. |
weightedFontFamily | Семейство шрифтов и визуализируемый вес текста. Если в запросе на обновление указаны значения как для Если Если установлен |
baselineOffset | Вертикальное смещение текста от его нормального положения. Текст со смещением базовой линии |
link | Назначение гиперссылки текста. Если не установлено, ссылки нет. Ссылки не наследуются от родительского текста. Изменение ссылки в запросе на обновление приводит к некоторым другим изменениям в текстовом стиле диапазона:
|
Дополнительный цвет
Цвет, который может быть полностью непрозрачным или полностью прозрачным.
JSON-представление |
---|
{
"color": {
object ( |
Поля | |
---|---|
color | Если установлено, будет использоваться как непрозрачный цвет. Если не установлено, это представляет собой прозрачный цвет. |
Цвет
Сплошной цвет.
JSON-представление |
---|
{
"rgbColor": {
object ( |
Поля | |
---|---|
rgbColor | Значение цвета RGB. |
Цвет RGB
Цвет RGB.
JSON-представление |
---|
{ "red": number, "green": number, "blue": number } |
Поля | |
---|---|
red | Красная составляющая цвета от 0,0 до 1,0. |
green | Зелёная составляющая цвета от 0,0 до 1,0. |
blue | Синяя составляющая цвета от 0,0 до 1,0. |
Измерение
Величина в одном направлении в указанных единицах.
JSON-представление |
---|
{
"magnitude": number,
"unit": enum ( |
Поля | |
---|---|
magnitude | Величина. |
unit | Единицы измерения величины. |
Единица
Меры измерения.
Перечисления | |
---|---|
UNIT_UNSPECIFIED | Единицы неизвестны. |
PT | Точка, 1/72 дюйма. |
Семейство взвешенных шрифтов
Представляет семейство шрифтов и толщину текста.
JSON-представление |
---|
{ "fontFamily": string, "weight": integer } |
Поля | |
---|---|
fontFamily | Семейство шрифтов текста. Семейством шрифтов может быть любой шрифт из меню «Шрифт» в Документах или из Google Fonts . Если имя шрифта неизвестно, текст отображается в |
weight | Вес шрифта. Это поле может иметь любое значение, кратное Значение по умолчанию — Вес шрифта составляет лишь один компонент отображаемого веса шрифта. Комбинация
|
Базовое смещение
Способы вертикального смещения текста от его нормального положения.
Перечисления | |
---|---|
BASELINE_OFFSET_UNSPECIFIED | Смещение базовой линии текста наследуется от родительского элемента. |
NONE | Текст не смещен по вертикали. |
SUPERSCRIPT | Текст смещен вертикально вверх (надстрочный индекс). |
SUBSCRIPT | Текст смещен вертикально вниз (индекс). |
Связь
Ссылка на другую часть документа или внешний URL-ресурс.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
destination поля Союза. Назначение ссылки. destination может быть только одним из следующих: | |
url | Внешний URL-адрес. |
bookmarkId | Идентификатор закладки в этом документе. |
headingId | Идентификатор заголовка в этом документе. |
Предложенныйтекстовый стиль
Предлагаемое изменение TextStyle
.
JSON-представление |
---|
{ "textStyle": { object ( |
Поля | |
---|---|
textStyle | |
textStyleSuggestionState | Маска, указывающая, какие поля базового |
TextStyleSuggestionState
Маска, указывающая, какие поля базового TextStyle
были изменены в этом предложении. Для любого поля, для которого установлено значение true, предлагается новое значение.
JSON-представление |
---|
{ "boldSuggested": boolean, "italicSuggested": boolean, "underlineSuggested": boolean, "strikethroughSuggested": boolean, "smallCapsSuggested": boolean, "backgroundColorSuggested": boolean, "foregroundColorSuggested": boolean, "fontSizeSuggested": boolean, "weightedFontFamilySuggested": boolean, "baselineOffsetSuggested": boolean, "linkSuggested": boolean } |
Поля | |
---|---|
boldSuggested | Указывает, было ли предложено изменить |
italicSuggested | Указывает, было ли предложено изменить курсив на |
underlineSuggested | Указывает, было ли предложено изменить значение |
strikethroughSuggested | Указывает, было ли предложено изменить |
smallCapsSuggested | Указывает, было ли предложено изменить |
backgroundColorSuggested | Указывает, было ли предложено изменить |
foregroundColorSuggested | Указывает, было ли предложено изменить |
fontSizeSuggested | Указывает, было ли предложено изменить |
weightedFontFamilySuggested | Указывает, было ли предложено изменить |
baselineOffsetSuggested | Указывает, было ли предложено изменить |
linkSuggested | Указывает, было ли предложено изменить |
Авто текст
ParagraphElement
, представляющий место в тексте, которое динамически заменяется содержимым, которое может меняться со временем, например номером страницы.
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Тип этого автотекста. |
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Текстовый стиль этого автотекста. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот автотекст с ключом по идентификатору предложения. |
Тип
Виды автотекста.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Неуказанный тип автоматического текста. |
PAGE_NUMBER | Введите автоматический текст, который представляет номер текущей страницы. |
PAGE_COUNT | Введите автоматический текст, который представляет общее количество страниц в документе. |
Разрыв страницы
ParagraphElement
, представляющий разрыв страницы. Разрыв страницы приводит к тому, что последующий текст начинается с начала следующей страницы.
JSON-представление |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Стиль текста этого PageBreak. Подобно текстовому содержимому, такому как текстовые фрагменты и ссылки на сноски, стиль текста разрыва страницы может влиять на макет содержимого, а также на стиль текста, вставленного рядом с ним. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот разрыв страницы с ключом по идентификатору предложения. |
Разрыв столбца
ParagraphElement
, представляющий разрыв столбца. Разрыв столбца приводит к тому, что последующий текст начинается с начала следующего столбца.
JSON-представление |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Текстовый стиль этого ColumnBreak. Подобно текстовому содержимому, такому как текстовые фрагменты и ссылки на сноски, стиль текста разрыва столбца может влиять на макет содержимого, а также на стиль текста, вставленного рядом с ним. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот ColumnBreak с ключом по идентификатору предложения. |
СноскаСсылка
ParagraphElement
, представляющий ссылку на сноску. Ссылка на сноску — это встроенный контент, отображаемый с помощью номера и используемый для идентификации сноски.
JSON-представление |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
footnoteId | Идентификатор |
footnoteNumber | Отображаемый номер этой сноски. |
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Стиль текста этой ссылки FootnoteReference. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот FootnoteReference, привязанный к идентификатору предложения. |
ГоризонтальноеПравило
ParagraphElement
, представляющий горизонтальную линию.
JSON-представление |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Текстовый стиль этого HorizontalRule. Подобно текстовому содержимому, такому как текстовые фрагменты и ссылки на сноски, стиль текста горизонтальной линейки может влиять на макет содержимого, а также на стиль текста, вставленного рядом с ним. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на это HorizontalRule с ключом по идентификатору предложения. |
Уравнение
ParagraphElement
, представляющий уравнение.
JSON-представление |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
Поля | |
---|---|
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
ИнлайнОбжектЭлемент
ParagraphElement
, содержащий InlineObject
.
JSON-представление |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
inlineObjectId | Идентификатор |
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
textStyle | Текстовый стиль этого InlineObjectElement. Подобно текстовому содержимому, такому как текстовые фрагменты и ссылки на сноски, стиль текста элемента встроенного объекта может влиять на макет содержимого, а также на стиль текста, вставленного рядом с ним. |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот InlineObject с ключом по идентификатору предложения. |
Человек
Человек или адрес электронной почты, упомянутый в документе. Эти упоминания ведут себя как единый неизменяемый элемент, содержащий имя или адрес электронной почты человека.
JSON-представление |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
personId | Только вывод. Уникальный идентификатор этой ссылки. |
suggestedInsertionIds[] | Идентификаторы предложений, которые вставляют ссылку на этого человека в документ. |
suggestedDeletionIds[] | Идентификаторы предложений, которые удаляют ссылку на этого человека из документа. У |
textStyle | Стиль текста этого |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот |
personProperties | Только вывод. Свойства этого |
Свойства человека
Свойства, специфичные для связанного Person
.
JSON-представление |
---|
{ "name": string, "email": string } |
Поля | |
---|---|
name | Только вывод. Имя человека, если оно отображается в тексте ссылки вместо адреса электронной почты человека. |
email | Только вывод. Адрес электронной почты, связанный с этим |
РичЛинк
Ссылка на ресурс Google (например, файл на Диске, видео YouTube или событие Календаря).
JSON-представление |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
Поля | |
---|---|
richLinkId | Только вывод. Идентификатор этой ссылки. |
suggestedInsertionIds[] | Идентификаторы предложений, которые вставляют эту ссылку в документ. |
suggestedDeletionIds[] | Идентификаторы предложений по удалению этой ссылки из документа. |
textStyle | Стиль текста этого |
suggestedTextStyleChanges | Предлагаемый стиль текста изменится на этот |
richLinkProperties | Только вывод. Свойства этого |
RichLinkСвойства
Свойства, специфичные для RichLink
.
JSON-представление |
---|
{ "title": string, "uri": string, "mimeType": string } |
Поля | |
---|---|
title | Только вывод. Название |
uri | Только вывод. URI для |
mimeType | Только вывод. MIME-тип |
Стиль абзаца
Стили, применимые ко всему абзацу.
Унаследованные стили абзацев представлены в этом сообщении как неустановленные поля. Родитель стиля абзаца зависит от того, где определен стиль абзаца:
- Стиль ParagraphStyle в
Paragraph
наследуется от соответствующегоnamed style type
абзаца. - Стиль абзаца
named style
наследуется отnormal text
с именем style. - Стиль абзаца
normal text
с именем style наследуется от стиля абзаца по умолчанию в редакторе Документов. - ParagraphStyle элемента
Paragraph
, содержащегося в таблице, может наследовать стиль абзаца от стиля таблицы.
Если стиль абзаца не унаследован от родительского элемента, при отмене полей стиль вернется к значению, соответствующему значениям по умолчанию в редакторе Документов.
JSON-представление |
---|
{ "headingId": string, "namedStyleType": enum ( |
Поля | |
---|---|
headingId | Идентификатор заголовка абзаца. Если пусто, то этот абзац не является заголовком. Это свойство доступно только для чтения. |
namedStyleType | Именованный тип стиля абзаца. Поскольку обновление именованного типа стиля влияет на другие свойства в ParagraphStyle, именованный тип стиля применяется до обновления других свойств. |
alignment | Выравнивание текста для этого абзаца. |
lineSpacing | Расстояние между строками в процентах от нормального, где нормальное значение равно 100,0. Если не установлено, значение наследуется от родительского элемента. |
direction | Направление текста этого абзаца. Если этот параметр не установлен, значение по умолчанию равно |
spacingMode | Режим интервалов для абзаца. |
spaceAbove | Количество дополнительного пространства над абзацем. Если не установлено, значение наследуется от родительского элемента. |
spaceBelow | Объем дополнительного пространства под абзацем. Если не установлено, значение наследуется от родительского элемента. |
borderBetween | Граница между этим абзацем и следующим и предыдущим абзацами. Если не установлено, значение наследуется от родительского элемента. Между граница отображается, когда соседний абзац имеет те же свойства границы и отступа. Границы абзацев не могут быть обновлены частично. При изменении границы абзаца новая граница должна быть указана полностью. |
borderTop | Граница вверху этого абзаца. Если не установлено, значение наследуется от родительского элемента. Верхняя граница отображается, когда абзац выше имеет разные свойства границы и отступа. Границы абзацев не могут быть обновлены частично. При изменении границы абзаца новая граница должна быть указана полностью. |
borderBottom | Граница внизу этого абзаца. Если не установлено, значение наследуется от родительского элемента. Нижняя граница отображается, когда абзац ниже имеет разные свойства границы и отступа. Границы абзацев не могут быть обновлены частично. При изменении границы абзаца новая граница должна быть указана полностью. |
borderLeft | Граница слева от этого абзаца. Если не установлено, значение наследуется от родительского элемента. Границы абзацев не могут быть обновлены частично. При изменении границы абзаца новая граница должна быть указана полностью. |
borderRight | Граница справа от этого абзаца. Если не установлено, значение наследуется от родительского элемента. Границы абзацев не могут быть обновлены частично. При изменении границы абзаца новая граница должна быть указана полностью. |
indentFirstLine | Размер отступа для первой строки абзаца. Если не установлено, значение наследуется от родительского элемента. |
indentStart | Величина отступа абзаца на стороне, соответствующей началу текста, в зависимости от текущего направления абзаца. Если не установлено, значение наследуется от родительского элемента. |
indentEnd | Величина отступа абзаца на стороне, соответствующей концу текста, в зависимости от текущего направления абзаца. Если не установлено, значение наследуется от родительского элемента. |
tabStops[] | Список табуляции для этого абзаца. Список табуляции не наследуется. Это свойство доступно только для чтения. |
keepLinesTogether | Должны ли все строки абзаца располагаться на одной странице или в столбце, если это возможно. Если не установлено, значение наследуется от родительского элемента. |
keepWithNext | Должна ли хотя бы часть этого абзаца располагаться на той же странице или в той же колонке, что и следующий абзац, если это возможно. Если не установлено, значение наследуется от родительского элемента. |
avoidWidowAndOrphan | Стоит ли избегать вдов и сирот по абзацу. Если не установлено, значение наследуется от родительского элемента. |
shading | Затенение абзаца. Если не установлено, значение наследуется от родительского элемента. |
pageBreakBefore | Должен ли текущий абзац всегда начинаться в начале страницы. Если не установлено, значение наследуется от родительского элемента. Попытка обновить |
Именедстилетипе
Типы именованных стилей.
Перечисления | |
---|---|
NAMED_STYLE_TYPE_UNSPECIFIED | Тип именованного стиля не указан. |
NORMAL_TEXT | Нормальный текст. |
TITLE | Заголовок. |
SUBTITLE | Подзаголовок. |
HEADING_1 | Заголовок 1. |
HEADING_2 | Заголовок 2. |
HEADING_3 | Заголовок 3. |
HEADING_4 | Заголовок 4. |
HEADING_5 | Заголовок 5. |
HEADING_6 | Заголовок 6. |
Выравнивание
Типы выравнивания текста абзаца.
Перечисления | |
---|---|
ALIGNMENT_UNSPECIFIED | Выравнивание абзаца наследуется от родительского элемента. |
START | Абзац выравнивается по началу строки. Выравнивание по левому краю для текста LTR, в противном случае — по правому краю. |
CENTER | Абзац центрируется. |
END | Абзац выравнивается по концу строки. Выравнивание по правому краю для текста LTR, в противном случае — по левому краю. |
JUSTIFIED | Абзац оправдан. |
Контентдиректион
Направления, по которым может течь контент.
Перечисления | |
---|---|
CONTENT_DIRECTION_UNSPECIFIED | Направление контента не указано. |
LEFT_TO_RIGHT | Содержимое идет слева направо. |
RIGHT_TO_LEFT | Содержимое идет справа налево. |
Режим интервала
Различные режимы интервалов между абзацами.
Перечисления | |
---|---|
SPACING_MODE_UNSPECIFIED | Режим интервала наследуется от родительского элемента. |
NEVER_COLLAPSE | Расстояние между абзацами отображается всегда. |
COLLAPSE_LISTS | Между элементами списка пропускается расстояние между абзацами. |
Граница Абзаца
Граница вокруг абзаца.
JSON-представление |
---|
{ "color": { object ( |
Поля | |
---|---|
color | Цвет границы. |
width | Ширина границы. |
padding | Заполнение границы. |
dashStyle | Пунктирный стиль границы. |
ДашСтиль
Виды штрихов, с помощью которых можно визуализировать линейную геометрию. Эти значения основаны на простом типе ST_PresetLineDashVal, описанном в разделе 20.1.10.48 документа «Форматы файлов Office Open XML — основы и справочник по языку разметки», часть 1 ECMA-376, 4-е издание .
Перечисления | |
---|---|
DASH_STYLE_UNSPECIFIED | Неопределенный стиль тире. |
SOLID | Сплошная линия. Соответствует значению ECMA-376 ST_PresetLineDashVal «твердое». Это стиль тире по умолчанию. |
DOT | Пунктирная линия. Соответствует значению ECMA-376 ST_PresetLineDashVal «точка». |
DASH | Пунктир. Соответствует значению ECMA-376 ST_PresetLineDashVal «тире». |
ТабСтоп
Табуляция внутри абзаца.
JSON-представление |
---|
{ "offset": { object ( |
Поля | |
---|---|
offset | Смещение между этой позицией табуляции и начальным полем. |
alignment | Выравнивание этой позиции табуляции. Если не установлено, значение по умолчанию равно |
TabStopAlignment
Выравнивание табуляции.
Перечисления | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED | Выравнивание позиции табуляции не указано. |
START | Позиция табуляции выравнивается по началу строки. Это значение по умолчанию. |
CENTER | Позиция табуляции выравнивается по центру строки. |
END | Стоп табуляции выравнивается по концу строки. |
Затенение
Затенение абзаца.
JSON-представление |
---|
{
"backgroundColor": {
object ( |
Поля | |
---|---|
backgroundColor | Цвет фона заливки этого абзаца. |
Предложенный стиль абзаца
Предлагаемое изменение ParagraphStyle
.
JSON-представление |
---|
{ "paragraphStyle": { object ( |
Поля | |
---|---|
paragraphStyle | |
paragraphStyleSuggestionState | Маска, указывающая, какие поля базового |
Состояние абзацаStyleSuggestion
Маска, указывающая, какие поля базового ParagraphStyle
были изменены в этом предложении. Для любого поля, для которого установлено значение true, предлагается новое значение.
JSON-представление |
---|
{
"headingIdSuggested": boolean,
"namedStyleTypeSuggested": boolean,
"alignmentSuggested": boolean,
"lineSpacingSuggested": boolean,
"directionSuggested": boolean,
"spacingModeSuggested": boolean,
"spaceAboveSuggested": boolean,
"spaceBelowSuggested": boolean,
"borderBetweenSuggested": boolean,
"borderTopSuggested": boolean,
"borderBottomSuggested": boolean,
"borderLeftSuggested": boolean,
"borderRightSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"indentEndSuggested": boolean,
"keepLinesTogetherSuggested": boolean,
"keepWithNextSuggested": boolean,
"avoidWidowAndOrphanSuggested": boolean,
"shadingSuggestionState": {
object ( |
Поля | |
---|---|
headingIdSuggested | Указывает, было ли предложено изменить |
namedStyleTypeSuggested | Указывает, было ли предложено изменить |
alignmentSuggested | Указывает, было ли предложено изменить |
lineSpacingSuggested | Указывает, было ли предложено изменить |
directionSuggested | Указывает, было ли предложено изменить |
spacingModeSuggested | Указывает, было ли предложено изменить |
spaceAboveSuggested | Указывает, было ли предложено изменить |
spaceBelowSuggested | Указывает, было ли предложено изменить |
borderBetweenSuggested | Указывает, было ли предложено изменить |
borderTopSuggested | Указывает, было ли предложено изменить |
borderBottomSuggested | Указывает, было ли предложено изменить |
borderLeftSuggested | Указывает, было ли предложено изменить |
borderRightSuggested | Указывает, было ли предложено изменить |
indentFirstLineSuggested | Указывает, было ли предложено изменить |
indentStartSuggested | Указывает, было ли предложено изменить |
indentEndSuggested | Указывает, было ли предложено изменить |
keepLinesTogetherSuggested | Указывает, было ли предложено изменить |
keepWithNextSuggested | Указывает, было ли предложено изменить |
avoidWidowAndOrphanSuggested | Указывает, было ли предложено изменение, чтобы |
shadingSuggestionState | Маска, указывающая, какое из полей |
pageBreakBeforeSuggested | Указывает, было ли предложено изменить |
Состояние ЗатененияПредложение
Маска, указывающая, какие поля базовой Shading
были изменены в результате предложенного изменения. Для любого поля, для которого установлено значение true, предлагается новое значение.
JSON-представление |
---|
{ "backgroundColorSuggested": boolean } |
Поля | |
---|---|
backgroundColorSuggested | Указывает, было ли предложено изменить |
Пуля
Описывает суть абзаца.
JSON-представление |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
Поля | |
---|---|
listId | Идентификатор списка, которому принадлежит этот абзац. |
nestingLevel | Уровень вложенности этого абзаца в списке. |
textStyle | К этому маркеру применен стиль текста, специфичный для абзаца. |
Предложенный пуллет
Предлагаемое изменение в Bullet
.
JSON-представление |
---|
{ "bullet": { object ( |
Поля | |
---|---|
bullet | |
bulletSuggestionState | Маска, указывающая, какие поля базового |
BulletSuggestionState
Маска, указывающая, какие поля базового Bullet
были изменены в этом предложении. Для любого поля, для которого установлено значение true, предлагается новое значение.
JSON-представление |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Поля | |
---|---|
listIdSuggested | Указывает, было ли предложено изменить |
nestingLevelSuggested | Указывает, было ли предложено изменить |
textStyleSuggestionState | Маска, указывающая, какие поля в |
Объектные ссылки
Коллекция идентификаторов объектов.
JSON-представление |
---|
{ "objectIds": [ string ] } |
Поля | |
---|---|
objectIds[] | Идентификаторы объектов. |
Разрыв раздела
StructuralElement
, представляющий разрыв раздела. Раздел — это диапазон содержимого, имеющий одинаковый SectionStyle
. Разрыв раздела представляет собой начало нового раздела, а стиль раздела применяется к разделу после разрыва раздела.
Тело документа всегда начинается с разрыва раздела.
JSON-представление |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
Поля | |
---|---|
suggestedInsertionIds[] | Предлагаемые идентификаторы вставки. |
suggestedDeletionIds[] | Предлагаемые идентификаторы удаления. Если пусто, то удаление этого контента не предлагается. |
sectionStyle | Стиль раздела после разрыва раздела. |
РазделСтиль
Стиль, применяемый к разделу.
JSON-представление |
---|
{ "columnProperties": [ { object ( |
Поля | |
---|---|
columnProperties[] | Свойства столбцов раздела. Если пусто, раздел содержит один столбец со свойствами по умолчанию в редакторе Документов. Раздел можно обновить, чтобы в нем было не более трех столбцов. При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приведет к ошибке 400 неверного запроса. |
columnSeparatorStyle | Стиль разделителей столбцов. Этот стиль можно установить, даже если в разделе один столбец. При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приводит к ошибке 400 неверный запрос. |
contentDirection | Направление содержания данного раздела. Если не установлено, значение по умолчанию равно При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приводит к ошибке 400 неверный запрос. |
marginTop | Верхнее поле страницы раздела. Если значение не установлено, по умолчанию используется значение При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приводит к ошибке 400 неверный запрос. |
marginBottom | Нижнее поле страницы раздела. Если значение не установлено, по умолчанию используется значение При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приводит к ошибке 400 неверный запрос. |
marginRight | Правое поле страницы раздела. Если значение не установлено, по умолчанию используется значение При обновлении этого свойства требуется установка конкретного значения. Снятие этого свойства приводит к ошибке 400 неверный запрос. |
marginLeft | The left page margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginHeader | The header margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
marginFooter | The footer margin of the section. If unset, the value defaults to When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
sectionType | Только вывод. The type of section. |
defaultHeaderId | The ID of the default header. If unset, the value inherits from the previous This property is read-only. |
defaultFooterId | The ID of the default footer. If unset, the value inherits from the previous This property is read-only. |
firstPageHeaderId | The ID of the header used only for the first page of the section. If This property is read-only. |
firstPageFooterId | The ID of the footer used only for the first page of the section. If This property is read-only. |
evenPageHeaderId | The ID of the header used only for even pages. If the value of DocumentStyle's This property is read-only. |
evenPageFooterId | The ID of the footer used only for even pages. If the value of DocumentStyle's This property is read-only. |
useFirstPageHeaderFooter | Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
pageNumberStart | The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
flipPageOrientation | Необязательный. Indicates whether to flip the dimensions of DocumentStyle's When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. |
SectionColumnProperties
Properties that apply to a section's column.
JSON-представление |
---|
{ "width": { object ( |
Поля | |
---|---|
width | Только вывод. The width of the column. |
paddingEnd | The padding at the end of the column. |
ColumnSeparatorStyle
The style of column separators between columns.
Enums | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED | An unspecified column separator style. |
NONE | No column separator lines between columns. |
BETWEEN_EACH_COLUMN | Renders a column separator line between each column. |
SectionType
Represents how the start of the current section is positioned relative to the previous section.
Enums | |
---|---|
SECTION_TYPE_UNSPECIFIED | The section type is unspecified. |
CONTINUOUS | The section starts immediately after the last paragraph of the previous section. |
NEXT_PAGE | The section starts on the next page. |
Table
A StructuralElement
representing a table.
JSON-представление |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
Поля | |
---|---|
rows | Number of rows in the table. |
columns | Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. |
tableRows[] | The contents and style of each row. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
tableStyle | The style of the table. |
TableRow
The contents and style of a row in a Table
.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
Поля | |
---|---|
startIndex | The zero-based start index of this row, in UTF-16 code units. |
endIndex | The zero-based end index of this row, exclusive, in UTF-16 code units. |
tableCells[] | The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
tableRowStyle | The style of the table row. |
suggestedTableRowStyleChanges | The suggested style changes to this row, keyed by suggestion ID. |
TableCell
The contents and style of a cell in a Table
.
JSON-представление |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
Поля | |
---|---|
startIndex | The zero-based start index of this cell, in UTF-16 code units. |
endIndex | The zero-based end index of this cell, exclusive, in UTF-16 code units. |
content[] | The content of the cell. |
tableCellStyle | The style of the cell. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
suggestedTableCellStyleChanges | The suggested changes to the table cell style, keyed by suggestion ID. |
TableCellStyle
The style of a TableCell
.
Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.
JSON-представление |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
Поля | |
---|---|
rowSpan | The row span of the cell. This property is read-only. |
columnSpan | The column span of the cell. This property is read-only. |
backgroundColor | The background color of the cell. |
borderLeft | The left border of the cell. |
borderRight | The right border of the cell. |
borderTop | The top border of the cell. |
borderBottom | The bottom border of the cell. |
paddingLeft | The left padding of the cell. |
paddingRight | The right padding of the cell. |
paddingTop | The top padding of the cell. |
paddingBottom | The bottom padding of the cell. |
contentAlignment | The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. |
TableCellBorder
A border around a table cell.
Table cell borders cannot be transparent. To hide a table cell border, make its width 0.
JSON-представление |
---|
{ "color": { object ( |
Поля | |
---|---|
color | The color of the border. This color cannot be transparent. |
width | The width of the border. |
dashStyle | The dash style of the border. |
ContentAlignment
The types of content alignment.
Derived from a subset of the values of the "ST_TextAnchoringType" simple type in section 20.1.10.59 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th edition .
Enums | |
---|---|
CONTENT_ALIGNMENT_UNSPECIFIED | An unspecified content alignment. The content alignment is inherited from the parent if one exists. |
CONTENT_ALIGNMENT_UNSUPPORTED | An unsupported content alignment. |
TOP | An alignment that aligns the content to the top of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 't'. |
MIDDLE | An alignment that aligns the content to the middle of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'. |
BOTTOM | An alignment that aligns the content to the bottom of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'. |
SuggestedTableCellStyle
A suggested change to a TableCellStyle
.
JSON-представление |
---|
{ "tableCellStyle": { object ( |
Поля | |
---|---|
tableCellStyle | A |
tableCellStyleSuggestionState | A mask that indicates which of the fields on the base |
TableCellStyleSuggestionState
A mask that indicates which of the fields on the base TableCellStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "rowSpanSuggested": boolean, "columnSpanSuggested": boolean, "backgroundColorSuggested": boolean, "borderLeftSuggested": boolean, "borderRightSuggested": boolean, "borderTopSuggested": boolean, "borderBottomSuggested": boolean, "paddingLeftSuggested": boolean, "paddingRightSuggested": boolean, "paddingTopSuggested": boolean, "paddingBottomSuggested": boolean, "contentAlignmentSuggested": boolean } |
Поля | |
---|---|
rowSpanSuggested | Indicates if there was a suggested change to |
columnSpanSuggested | Indicates if there was a suggested change to |
backgroundColorSuggested | Indicates if there was a suggested change to |
borderLeftSuggested | Indicates if there was a suggested change to |
borderRightSuggested | Indicates if there was a suggested change to |
borderTopSuggested | Indicates if there was a suggested change to |
borderBottomSuggested | Indicates if there was a suggested change to |
paddingLeftSuggested | Indicates if there was a suggested change to |
paddingRightSuggested | Indicates if there was a suggested change to |
paddingTopSuggested | Indicates if there was a suggested change to |
paddingBottomSuggested | Indicates if there was a suggested change to |
contentAlignmentSuggested | Indicates if there was a suggested change to |
TableRowStyle
Styles that apply to a table row.
JSON-представление |
---|
{
"minRowHeight": {
object ( |
Поля | |
---|---|
minRowHeight | The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. |
tableHeader | Whether the row is a table header. |
preventOverflow | Whether the row cannot overflow across page or column boundaries. |
SuggestedTableRowStyle
A suggested change to a TableRowStyle
.
JSON-представление |
---|
{ "tableRowStyle": { object ( |
Поля | |
---|---|
tableRowStyle | A |
tableRowStyleSuggestionState | A mask that indicates which of the fields on the base |
TableRowStyleSuggestionState
A mask that indicates which of the fields on the base TableRowStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "minRowHeightSuggested": boolean } |
Поля | |
---|---|
minRowHeightSuggested | Indicates if there was a suggested change to |
TableStyle
Styles that apply to a table.
JSON-представление |
---|
{
"tableColumnProperties": [
{
object ( |
Поля | |
---|---|
tableColumnProperties[] | The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's |
TableColumnProperties
The properties of a column in a table.
JSON-представление |
---|
{ "widthType": enum ( |
Поля | |
---|---|
widthType | The width type of the column. |
width | The width of the column. Set when the column's |
WidthType
The type of width of the column.
Enums | |
---|---|
WIDTH_TYPE_UNSPECIFIED | The column width type is unspecified. |
EVENLY_DISTRIBUTED | The column width is evenly distributed among the other evenly distributed columns. The width of the column is automatically determined and will have an equal portion of the width remaining for the table after accounting for all columns with specified widths. |
FIXED_WIDTH | A fixed column width. The [width][ google.apps.docs.v1.TableColumnProperties.width property contains the column's width. |
TableOfContents
A StructuralElement
representing a table of contents.
JSON-представление |
---|
{
"content": [
{
object ( |
Поля | |
---|---|
content[] | The content of the table of contents. |
suggestedInsertionIds[] | The suggested insertion IDs. A |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
Header
A document header.
JSON-представление |
---|
{
"headerId": string,
"content": [
{
object ( |
Поля | |
---|---|
headerId | The ID of the header. |
content[] | The contents of the header. The indexes for a header's content begin at zero. |
Footnote
A document footnote.
JSON-представление |
---|
{
"footnoteId": string,
"content": [
{
object ( |
Поля | |
---|---|
footnoteId | The ID of the footnote. |
content[] | The contents of the footnote. The indexes for a footnote's content begin at zero. |
DocumentStyle
The style of the document.
JSON-представление |
---|
{ "background": { object ( |
Поля | |
---|---|
background | The background of the document. Documents cannot have a transparent background color. |
defaultHeaderId | The ID of the default header. If not set, there's no default header. This property is read-only. |
defaultFooterId | The ID of the default footer. If not set, there's no default footer. This property is read-only. |
evenPageHeaderId | The ID of the header used only for even pages. The value of This property is read-only. |
evenPageFooterId | The ID of the footer used only for even pages. The value of This property is read-only. |
firstPageHeaderId | The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of This property is read-only. |
firstPageFooterId | The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of This property is read-only. |
useFirstPageHeaderFooter | Indicates whether to use the first page header / footer IDs for the first page. |
useEvenPageHeaderFooter | Indicates whether to use the even page header / footer IDs for the even pages. |
pageNumberStart | The page number from which to start counting the number of pages. |
marginTop | The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. |
marginBottom | The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. |
marginRight | The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. |
marginLeft | The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. |
pageSize | The size of a page in the document. |
marginHeader | The amount of space between the top of the page and the contents of the header. |
marginFooter | The amount of space between the bottom of the page and the contents of the footer. |
useCustomHeaderFooterMargins | Indicates whether DocumentStyle This property is read-only. |
flipPageOrientation | Необязательный. Indicates whether to flip the dimensions of the |
Фон
Represents the background of a document.
JSON-представление |
---|
{
"color": {
object ( |
Поля | |
---|---|
color | The background color. |
Size
A width and height.
JSON-представление |
---|
{ "height": { object ( |
Поля | |
---|---|
height | The height of the object. |
width | The width of the object. |
SuggestedDocumentStyle
A suggested change to the DocumentStyle
.
JSON-представление |
---|
{ "documentStyle": { object ( |
Поля | |
---|---|
documentStyle | A |
documentStyleSuggestionState | A mask that indicates which of the fields on the base |
DocumentStyleSuggestionState
A mask that indicates which of the fields on the base DocumentStyle
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "backgroundSuggestionState": { object ( |
Поля | |
---|---|
backgroundSuggestionState | A mask that indicates which of the fields in |
defaultHeaderIdSuggested | Indicates if there was a suggested change to |
defaultFooterIdSuggested | Indicates if there was a suggested change to |
evenPageHeaderIdSuggested | Indicates if there was a suggested change to |
evenPageFooterIdSuggested | Indicates if there was a suggested change to |
firstPageHeaderIdSuggested | Indicates if there was a suggested change to |
firstPageFooterIdSuggested | Indicates if there was a suggested change to |
useFirstPageHeaderFooterSuggested | Indicates if there was a suggested change to |
useEvenPageHeaderFooterSuggested | Indicates if there was a suggested change to |
pageNumberStartSuggested | Indicates if there was a suggested change to |
marginTopSuggested | Indicates if there was a suggested change to |
marginBottomSuggested | Indicates if there was a suggested change to |
marginRightSuggested | Indicates if there was a suggested change to |
marginLeftSuggested | Indicates if there was a suggested change to |
pageSizeSuggestionState | A mask that indicates which of the fields in [size] [google.apps.docs.v1.DocumentStyle.size] have been changed in this suggestion. |
marginHeaderSuggested | Indicates if there was a suggested change to |
marginFooterSuggested | Indicates if there was a suggested change to |
useCustomHeaderFooterMarginsSuggested | Indicates if there was a suggested change to |
flipPageOrientationSuggested | Необязательный. Indicates if there was a suggested change to |
BackgroundSuggestionState
A mask that indicates which of the fields on the base Background
have been changed in this suggestion. For any field set to true, the Backgound
has a new suggested value.
JSON-представление |
---|
{ "backgroundColorSuggested": boolean } |
Поля | |
---|---|
backgroundColorSuggested | Indicates whether the current background color has been modified in this suggestion. |
SizeSuggestionState
A mask that indicates which of the fields on the base Size
have been changed in this suggestion. For any field set to true, the Size
has a new suggested value.
JSON-представление |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
Поля | |
---|---|
heightSuggested | Indicates if there was a suggested change to |
widthSuggested | Indicates if there was a suggested change to |
NamedStyles
The named styles. Paragraphs in the document can inherit their TextStyle
and ParagraphStyle
from these named styles.
JSON-представление |
---|
{
"styles": [
{
object ( |
Поля | |
---|---|
styles[] | The named styles. There's an entry for each of the possible |
NamedStyle
A named style. Paragraphs in the document can inherit their TextStyle
and ParagraphStyle
from this named style when they have the same named style type.
JSON-представление |
---|
{ "namedStyleType": enum ( |
Поля | |
---|---|
namedStyleType | The type of this named style. |
textStyle | The text style of this named style. |
paragraphStyle | The paragraph style of this named style. |
SuggestedNamedStyles
A suggested change to the NamedStyles
.
JSON-представление |
---|
{ "namedStyles": { object ( |
Поля | |
---|---|
namedStyles | A |
namedStylesSuggestionState | A mask that indicates which of the fields on the base |
NamedStylesSuggestionState
The suggestion state of a NamedStyles
message.
JSON-представление |
---|
{
"stylesSuggestionStates": [
{
object ( |
Поля | |
---|---|
stylesSuggestionStates[] | A mask that indicates which of the fields on the corresponding The order of these named style suggestion states matches the order of the corresponding named style within the |
NamedStyleSuggestionState
A suggestion state of a NamedStyle
message.
JSON-представление |
---|
{ "namedStyleType": enum ( |
Поля | |
---|---|
namedStyleType | The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding |
textStyleSuggestionState | A mask that indicates which of the fields in |
paragraphStyleSuggestionState | A mask that indicates which of the fields in |
List
A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet
.
JSON-представление |
---|
{ "listProperties": { object ( |
Поля | |
---|---|
listProperties | The properties of the list. |
suggestedListPropertiesChanges | The suggested changes to the list properties, keyed by suggestion ID. |
suggestedInsertionId | The suggested insertion ID. If empty, then this is not a suggested insertion. |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this list. |
ListProperties
The properties of a list
that describe the look and feel of bullets belonging to paragraphs associated with a list.
JSON-представление |
---|
{
"nestingLevels": [
{
object ( |
Поля | |
---|---|
nestingLevels[] | Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. |
NestingLevel
Contains properties describing the look and feel of a list bullet at a given level of nesting.
JSON-представление |
---|
{ "bulletAlignment": enum ( |
Поля | |
---|---|
bulletAlignment | The alignment of the bullet within the space allotted for rendering the bullet. |
glyphFormat | The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the For example, the glyph format The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. |
indentFirstLine | The amount of indentation for the first line of paragraphs at this level of nesting. |
indentStart | The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. |
textStyle | The text style of bullets at this level of nesting. |
startNumber | The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at This value is ignored for nesting levels with unordered glyphs. |
Union field glyph_kind . The kind of glyph used by bullets. This defines the bullet glyph that replaces the placeholders in the glyph_format . glyph_kind can be only one of the following: | |
glyphType | The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the |
glyphSymbol | A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the |
BulletAlignment
The types of alignment for a bullet.
Enums | |
---|---|
BULLET_ALIGNMENT_UNSPECIFIED | The bullet alignment is unspecified. |
START | The bullet is aligned to the start of the space allotted for rendering the bullet. Left-aligned for LTR text, right-aligned otherwise. |
CENTER | The bullet is aligned to the center of the space allotted for rendering the bullet. |
END | The bullet is aligned to the end of the space allotted for rendering the bullet. Right-aligned for LTR text, left-aligned otherwise. |
GlyphType
The types of glyphs used by bullets when paragraphs at this level of nesting are ordered.
Enums | |
---|---|
GLYPH_TYPE_UNSPECIFIED | The glyph type is unspecified or unsupported. |
NONE | An empty string. |
DECIMAL | A number, like 1 , 2 , or 3 . |
ZERO_DECIMAL | A number where single digit numbers are prefixed with a zero, like 01 , 02 , or 03 . Numbers with more than one digit are not prefixed with a zero. |
UPPER_ALPHA | An uppercase letter, like A , B , or C . |
ALPHA | A lowercase letter, like a , b , or c . |
UPPER_ROMAN | An uppercase Roman numeral, like I , II , or III . |
ROMAN | A lowercase Roman numeral, like i , ii , or iii . |
SuggestedListProperties
A suggested change to ListProperties
.
JSON-представление |
---|
{ "listProperties": { object ( |
Поля | |
---|---|
listProperties | A |
listPropertiesSuggestionState | A mask that indicates which of the fields on the base |
ListPropertiesSuggestionState
A mask that indicates which of the fields on the base ListProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
Поля | |
---|---|
nestingLevelsSuggestionStates[] | A mask that indicates which of the fields on the corresponding The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. |
NestingLevelSuggestionState
A mask that indicates which of the fields on the base NestingLevel
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
Поля | |
---|---|
bulletAlignmentSuggested | Indicates if there was a suggested change to |
glyphTypeSuggested | Indicates if there was a suggested change to |
glyphFormatSuggested | Indicates if there was a suggested change to |
glyphSymbolSuggested | Indicates if there was a suggested change to |
indentFirstLineSuggested | Indicates if there was a suggested change to |
indentStartSuggested | Indicates if there was a suggested change to |
textStyleSuggestionState | A mask that indicates which of the fields in |
startNumberSuggested | Indicates if there was a suggested change to |
NamedRanges
A collection of all the NamedRange
s in the document that share a given name.
JSON-представление |
---|
{
"name": string,
"namedRanges": [
{
object ( |
Поля | |
---|---|
name | The name that all the |
namedRanges[] | The |
NamedRange
A collection of Range
s with the same named range ID.
Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID.
A named range is created with a single Range
, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges.
Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
JSON-представление |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
Поля | |
---|---|
namedRangeId | The ID of the named range. |
name | The name of the named range. |
ranges[] | The ranges that belong to this named range. |
Range
Specifies a contiguous range of text.
JSON-представление |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer } |
Поля | |
---|---|
segmentId | The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. |
startIndex | The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. |
endIndex | The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. |
SuggestionsViewMode
The suggestions view mode applied to the document that indicates how suggested changes are represented. It provides options for reading the document with all suggestions inline, accepted, or rejected.
Enums | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS | The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode. |
SUGGESTIONS_INLINE | The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes. |
PREVIEW_SUGGESTIONS_ACCEPTED | The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes. |
PREVIEW_WITHOUT_SUGGESTIONS | The returned document is a preview with all suggested changes rejected if there are any suggestions in the document. |
InlineObject
An object that appears inline with text. An InlineObject contains an EmbeddedObject
such as an image.
JSON-представление |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
Поля | |
---|---|
objectId | The ID of this inline object. Can be used to update an object's properties. |
inlineObjectProperties | The properties of this inline object. |
suggestedInlineObjectPropertiesChanges | The suggested changes to the inline object properties, keyed by suggestion ID. |
suggestedInsertionId | The suggested insertion ID. If empty, then this is not a suggested insertion. |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
InlineObjectProperties
Properties of an InlineObject
.
JSON-представление |
---|
{
"embeddedObject": {
object ( |
Поля | |
---|---|
embeddedObject | The embedded object of this inline object. |
EmbeddedObject
An embedded object in the document.
JSON-представление |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
Поля | |
---|---|
title | The title of the embedded object. The |
description | The description of the embedded object. The |
embeddedObjectBorder | The border of the embedded object. |
size | The visible size of the image after cropping. |
marginTop | The top margin of the embedded object. |
marginBottom | The bottom margin of the embedded object. |
marginRight | The right margin of the embedded object. |
marginLeft | The left margin of the embedded object. |
linkedContentReference | A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. |
Union field properties . The properties that are specific to each embedded object type. properties can be only one of the following: | |
embeddedDrawingProperties | The properties of an embedded drawing. |
imageProperties | The properties of an image. |
EmbeddedDrawingProperties
This type has no fields.
The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.
ImageProperties
The properties of an image.
JSON-представление |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
Поля | |
---|---|
contentUri | A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. |
sourceUri | The source URI is the URI used to insert the image. The source URI can be empty. |
brightness | The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. |
contrast | The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. |
transparency | The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. |
cropProperties | The crop properties of the image. |
angle | The clockwise rotation angle of the image, in radians. |
CropProperties
The crop properties of an image.
The crop rectangle is represented using fractional offsets from the original content's 4 edges.
- If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle.
- If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle.
- If all offsets and rotation angle are 0, the image is not cropped.
JSON-представление |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
Поля | |
---|---|
offsetLeft | The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. |
offsetRight | The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. |
offsetTop | The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. |
offsetBottom | The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. |
angle | The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. |
EmbeddedObjectBorder
A border around an EmbeddedObject
.
JSON-представление |
---|
{ "color": { object ( |
Поля | |
---|---|
color | The color of the border. |
width | The width of the border. |
dashStyle | The dash style of the border. |
propertyState | The property state of the border property. |
PropertyState
The possible states of a property.
Enums | |
---|---|
RENDERED | If a property's state is RENDERED, then the element has the corresponding property when rendered in the document. This is the default value. |
NOT_RENDERED | If a property's state is NOT_RENDERED, then the element does not have the corresponding property when rendered in the document. |
LinkedContentReference
A reference to the external linked source content.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Union field reference . The reference specific to the type of linked content. reference can be only one of the following: | |
sheetsChartReference | A reference to the linked chart. |
SheetsChartReference
A reference to a linked chart embedded from Google Sheets.
JSON-представление |
---|
{ "spreadsheetId": string, "chartId": integer } |
Поля | |
---|---|
spreadsheetId | The ID of the Google Sheets spreadsheet that contains the source chart. |
chartId | The ID of the specific chart in the Google Sheets spreadsheet that's embedded. |
SuggestedInlineObjectProperties
A suggested change to InlineObjectProperties
.
JSON-представление |
---|
{ "inlineObjectProperties": { object ( |
Поля | |
---|---|
inlineObjectProperties | An |
inlineObjectPropertiesSuggestionState | A mask that indicates which of the fields on the base |
InlineObjectPropertiesSuggestionState
A mask that indicates which of the fields on the base InlineObjectProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{
"embeddedObjectSuggestionState": {
object ( |
Поля | |
---|---|
embeddedObjectSuggestionState | A mask that indicates which of the fields in |
EmbeddedObjectSuggestionState
A mask that indicates which of the fields on the base EmbeddedObject
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
Поля | |
---|---|
embeddedDrawingPropertiesSuggestionState | A mask that indicates which of the fields in |
imagePropertiesSuggestionState | A mask that indicates which of the fields in |
titleSuggested | Indicates if there was a suggested change to |
descriptionSuggested | Indicates if there was a suggested change to |
embeddedObjectBorderSuggestionState | A mask that indicates which of the fields in |
sizeSuggestionState | A mask that indicates which of the fields in |
marginLeftSuggested | Indicates if there was a suggested change to |
marginRightSuggested | Indicates if there was a suggested change to |
marginTopSuggested | Indicates if there was a suggested change to |
marginBottomSuggested | Indicates if there was a suggested change to |
linkedContentReferenceSuggestionState | A mask that indicates which of the fields in |
EmbeddedDrawingPropertiesSuggestionState
This type has no fields.
A mask that indicates which of the fields on the base EmbeddedDrawingProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
ImagePropertiesSuggestionState
A mask that indicates which of the fields on the base ImageProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
Поля | |
---|---|
contentUriSuggested | Indicates if there was a suggested change to |
sourceUriSuggested | Indicates if there was a suggested change to [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri]. |
brightnessSuggested | Indicates if there was a suggested change to [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]. |
contrastSuggested | Indicates if there was a suggested change to [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]. |
transparencySuggested | Indicates if there was a suggested change to [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]. |
cropPropertiesSuggestionState | A mask that indicates which of the fields in |
angleSuggested | Indicates if there was a suggested change to [angle] [google.apps.docs.v1.EmbeddedObject.angle]. |
CropPropertiesSuggestionState
A mask that indicates which of the fields on the base CropProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
Поля | |
---|---|
offsetLeftSuggested | Indicates if there was a suggested change to |
offsetRightSuggested | Indicates if there was a suggested change to |
offsetTopSuggested | Indicates if there was a suggested change to |
offsetBottomSuggested | Indicates if there was a suggested change to |
angleSuggested | Indicates if there was a suggested change to |
EmbeddedObjectBorderSuggestionState
A mask that indicates which of the fields on the base EmbeddedObjectBorder
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
Поля | |
---|---|
colorSuggested | Indicates if there was a suggested change to [color] [google.apps.docs.v1.EmbeddedBorderObject.color]. |
widthSuggested | Indicates if there was a suggested change to [width] [google.apps.docs.v1.EmbeddedBorderObject.width]. |
dashStyleSuggested | Indicates if there was a suggested change to [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]. |
propertyStateSuggested | Indicates if there was a suggested change to [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]. |
LinkedContentReferenceSuggestionState
A mask that indicates which of the fields on the base LinkedContentReference
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
Поля | |
---|---|
sheetsChartReferenceSuggestionState | A mask that indicates which of the fields in |
SheetsChartReferenceSuggestionState
A mask that indicates which of the fields on the base SheetsChartReference
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
Поля | |
---|---|
spreadsheetIdSuggested | Indicates if there was a suggested change to |
chartIdSuggested | Indicates if there was a suggested change to |
PositionedObject
An object that's tethered to a Paragraph
and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject
such as an image.
JSON-представление |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
Поля | |
---|---|
objectId | The ID of this positioned object. |
positionedObjectProperties | The properties of this positioned object. |
suggestedPositionedObjectPropertiesChanges | The suggested changes to the positioned object properties, keyed by suggestion ID. |
suggestedInsertionId | The suggested insertion ID. If empty, then this is not a suggested insertion. |
suggestedDeletionIds[] | The suggested deletion IDs. If empty, then there are no suggested deletions of this content. |
PositionedObjectProperties
Properties of a PositionedObject
.
JSON-представление |
---|
{ "positioning": { object ( |
Поля | |
---|---|
positioning | The positioning of this positioned object relative to the newline of the |
embeddedObject | The embedded object of this positioned object. |
PositionedObjectPositioning
The positioning of a PositionedObject
. The positioned object is positioned relative to the beginning of the Paragraph
it's tethered to.
JSON-представление |
---|
{ "layout": enum ( |
Поля | |
---|---|
layout | The layout of this positioned object. |
leftOffset | The offset of the left edge of the positioned object relative to the beginning of the |
topOffset | The offset of the top edge of the positioned object relative to the beginning of the |
PositionedObjectLayout
The possible layouts of a [PositionedObject][google.aps.docs.v1.PositionedObject].
Enums | |
---|---|
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED | The layout is unspecified. |
WRAP_TEXT | The text wraps around the positioned object. |
BREAK_LEFT | Breaks text such that the positioned object is on the left and text is on the right. |
BREAK_RIGHT | Breaks text such that the positioned object is on the right and text is on the left. |
BREAK_LEFT_RIGHT | Breaks text such that there's no text on the left or right of the positioned object. |
IN_FRONT_OF_TEXT | The positioned object is in front of the text. |
BEHIND_TEXT | The positioned object is behind the text. |
SuggestedPositionedObjectProperties
A suggested change to PositionedObjectProperties
.
JSON-представление |
---|
{ "positionedObjectProperties": { object ( |
Поля | |
---|---|
positionedObjectProperties | A |
positionedObjectPropertiesSuggestionState | A mask that indicates which of the fields on the base |
PositionedObjectPropertiesSuggestionState
A mask that indicates which of the fields on the base PositionedObjectProperties
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "positioningSuggestionState": { object ( |
Поля | |
---|---|
positioningSuggestionState | A mask that indicates which of the fields in |
embeddedObjectSuggestionState | A mask that indicates which of the fields in |
PositionedObjectPositioningSuggestionState
A mask that indicates which of the fields on the base PositionedObjectPositioning
have been changed in this suggestion. For any field set to true, there's a new suggested value.
JSON-представление |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
Поля | |
---|---|
layoutSuggested | Indicates if there was a suggested change to |
leftOffsetSuggested | Indicates if there was a suggested change to |
topOffsetSuggested | Indicates if there was a suggested change to |
Methods | |
---|---|
| Applies one or more updates to the document. |
| Creates a blank document using the title given in the request. |
| Gets the latest version of the specified document. |