REST Resource: documents

Ресурс: документ

документ Google Документов;

JSON-представление 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Поля
documentId

string

Используется только для вывода. Идентификатор документа.
title

string

Название документа.
tabs[]

object (Tab)

Используется только для вывода. вкладки, которые являются частью документа;

Вкладки могут содержать вложенные вкладки. Дочерние вкладки представлены полем Tab.childTabs.
revisionId

string

Используется только для вывода. Идентификатор версии документа. Можно использовать в запросах на обновление, чтобы указать, к какой версии документа нужно применить изменения и как должен выполняться запрос, если документ был изменен после этой версии. Заполняется, только если у пользователя есть права на редактирование документа.

Идентификатор версии не является последовательным числом, а представляет собой непрозрачную строку. Формат идентификатора версии может меняться. Возвращенный идентификатор версии действителен только в течение 24 часов после возврата и не может быть передан другим пользователям. Если идентификатор версии не меняется между вызовами, значит документ не изменился. И наоборот, если идентификатор изменился (для того же документа и пользователя), это обычно означает, что документ был обновлен. Однако идентификатор может измениться и по внутренним причинам, например из-за изменения формата.
suggestionsViewMode

enum (SuggestionsViewMode)

Используется только для вывода. Режим просмотра предложений, примененный к документу.

Примечание. При редактировании документа изменения должны быть основаны на документе с SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

Используется только для вывода. Режим просмотра комментариев, примененный к документу.
comments[]

object (CommentThread)

Используется только для вывода. Комментарии, связанные с документом. Заполняется, только если для параметра commentsViewMode задано требование оставлять комментарии (например, COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

Используется только для вывода. Подсказки, связанные с документом. Заполняется, только если для параметра commentsViewMode задано требование оставлять комментарии (например, COMMENTS_VIEW_MODE_INCLUDED).
body

object (Body)

Используется только для вывода. Основной текст документа.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.body, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
headers

map (key: string, value: object (Header))

Используется только для вывода. Заголовки в документе, сгруппированные по идентификатору заголовка.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.headers, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
footers

map (key: string, value: object (Footer))

Используется только для вывода. Нижние колонтитулы в документе, сгруппированные по идентификатору нижнего колонтитула.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.footers, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
footnotes

map (key: string, value: object (Footnote))

Используется только для вывода. Сноски в документе, сгруппированные по идентификатору сноски.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.footnotes, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
documentStyle

object (DocumentStyle)

Используется только для вывода. Стиль документа.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.documentStyle, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Используется только для вывода. Предложенные изменения стиля документа, сгруппированные по идентификаторам предложений.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.suggestedDocumentStyleChanges, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
namedStyles

object (NamedStyles)

Используется только для вывода. Именованные стили документа.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.namedStyles, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Используется только для вывода. Предложенные изменения для именованных стилей документа, сгруппированные по идентификатору предложения.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.suggestedNamedStylesChanges, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
lists

map (key: string, value: object (List))

Используется только для вывода. Списки в документе, сгруппированные по идентификаторам.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.lists, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
namedRanges

map (key: string, value: object (NamedRanges))

Используется только для вывода. Именованные диапазоны в документе, сгруппированные по названию.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.namedRanges, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
inlineObjects

map (key: string, value: object (InlineObject))

Используется только для вывода. Встроенные объекты в документе, сгруппированные по идентификатору объекта.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.inlineObjects, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.
positionedObjects

map (key: string, value: object (PositionedObject))

Используется только для вывода. Объекты, расположенные в документе, с ключами в виде идентификаторов объектов.

Устаревшее поле. Вместо него используйте Document.tabs.documentTab.positionedObjects, которое позволяет получить доступ к содержимому документа со всех вкладок, если для параметра includeTabsContent задано значение true. Если поле false не задано, оно содержит информацию о первой вкладке в документе.

Tab

Вкладка в документе.

JSON-представление 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  "documentTab": {
    object (DocumentTab)
  }
}
Поля
tabProperties

object (TabProperties)

Свойства вкладки, например идентификатор и название.
childTabs[]

object (Tab)

Дочерние вкладки, вложенные в эту вкладку.
Содержимое вкладки. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
documentTab

object (DocumentTab)

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

TabProperties

Свойства вкладки.

JSON-представление 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer,
  "iconEmoji": string
}
Поля
tabId

string

Неизменяемый идентификатор вкладки.
title

string

Название вкладки, которое видят пользователи.
parentTabId

string

Необязательное поле. Идентификатор родительской вкладки. Пустое значение, если текущая вкладка является вкладкой корневого уровня, то есть у нее нет родительских вкладок.
index

integer

Индекс вкладки в родительском элементе с отсчетом от нуля.
nestingLevel

integer

Используется только для вывода. Глубина вкладки в документе. Вкладки верхнего уровня нумеруются с 0.
iconEmoji

string

Необязательное поле. Значок эмодзи, который показывается на вкладке. Действительный значок эмодзи представлен непустой строкой Unicode. Любой набор символов, не представляющий собой один эмодзи, считается недействительным.

Если эмодзи недействителен, возвращается ошибка 400 "Недопустимый запрос".

Если значение не задано или пустое, на вкладке будет показан значок по умолчанию.

DocumentTab

Вкладка с содержимым документа.

JSON-представление 
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  },
  "commentAnchors": {
    string: {
      object (CommentAnchor)
    },
    ...
  },
  "dropdownDefinitions": {
    string: {
      object (DropdownDefinition)
    },
    ...
  }
}
Поля
body

object (Body)

Основная часть вкладки документа.
headers

map (key: string, value: object (Header))

Заголовки на вкладке документа, сгруппированные по идентификатору заголовка.
footers

map (key: string, value: object (Footer))

Нижние колонтитулы на вкладке документа, сгруппированные по идентификатору нижнего колонтитула.
footnotes

map (key: string, value: object (Footnote))

Сноски на вкладке документа, сгруппированные по идентификаторам сносок.
documentStyle

object (DocumentStyle)

Стиль вкладки документа.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Предложенные изменения стиля вкладки документа, сгруппированные по идентификатору предложения.
namedStyles

object (NamedStyles)

Именованные стили вкладки документа.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

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

map (key: string, value: object (List))

Списки на вкладке документа, отсортированные по идентификатору списка.
namedRanges

map (key: string, value: object (NamedRanges))

Именованные диапазоны на вкладке документа, сгруппированные по названию.
inlineObjects

map (key: string, value: object (InlineObject))

Встроенные объекты на вкладке документа, сгруппированные по идентификатору объекта.
positionedObjects

map (key: string, value: object (PositionedObject))

Объекты, расположенные на вкладке документа, с ключом в виде идентификатора объекта.
commentAnchors

map (key: string, value: object (CommentAnchor))

Комментарий прикрепляется к вкладке документа по идентификатору. Заполняется, только если для параметра commentsViewMode задано требование оставлять комментарии (например, COMMENTS_VIEW_MODE_INCLUDED).
dropdownDefinitions

map (key: string, value: object (DropdownDefinition))

Определения раскрывающихся списков на вкладке документа, сгруппированные по идентификатору определения раскрывающегося списка.

Body

Текст документа.

Обычно в теле документа содержится все его содержимое, кроме headers, footers и footnotes.

JSON-представление 
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Поля
content[]

object (StructuralElement)

Содержимое тела.

Индексы для контента тела письма начинаются с нуля.

StructuralElement

Объект StructuralElement описывает контент, который задает структуру документа.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer,

  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
}
Поля
startIndex

integer

Начальный индекс этого структурного элемента (отсчитывается от нуля) в единицах кода UTF-16.
endIndex

integer

Конечный индекс этого структурного элемента (на основе нуля), исключительный, в единицах кода UTF-16.
Содержимое структурного элемента. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
paragraph

object (Paragraph)

Структурный элемент типа абзаца.
sectionBreak

object (SectionBreak)

Тип структурного элемента "Разрыв раздела".
table

object (Table)

Структурный элемент типа таблицы.
tableOfContents

object (TableOfContents)

Структурный элемент типа "Оглавление".
Конец взаимоисключающих полей.

Абзац

StructuralElement, представляющий абзац. Абзац – это фрагмент контента, который заканчивается символом новой строки.

JSON-представление 
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
Поля
elements[]

object (ParagraphElement)

Содержимое абзаца, разбитое на компоненты.
paragraphStyle

object (ParagraphStyle)

Стиль этого абзаца.
suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

Предложенный стиль абзаца применяется к этому абзацу, который идентифицируется по идентификатору предложения.
bullet

object (Bullet)

Маркер для этого абзаца. Если его нет, абзац не относится к списку.
suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

Предлагаемые изменения для маркера этого абзаца.
positionedObjectIds[]

string

Идентификаторы объектов, привязанных к этому абзацу.
suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

Идентификаторы объектов, которые предлагается прикрепить к этому абзацу, сгруппированные по идентификаторам предложений.

ParagraphElement

Объект ParagraphElement описывает контент в элементе Paragraph.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer,

  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  },
  "dateElement": {
    object (DateElement)
  },
  "dropdown": {
    object (Dropdown)
  }
}
Поля
startIndex

integer

Начальный индекс элемента абзаца, отсчитываемый от нуля, в единицах кода UTF-16.
endIndex

integer

Конечный индекс элемента абзаца (не включительно), отсчитываемый от нуля в единицах кодировки UTF-16.
Содержимое элемента абзаца. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
textRun

object (TextRun)

Элемент абзаца с текстом.
autoText

object (AutoText)

Элемент абзаца с автоматическим текстом.
pageBreak

object (PageBreak)

Элемент абзаца с разрывом страницы.
columnBreak

object (ColumnBreak)

Элемент абзаца с разрывом столбца.
footnoteReference

object (FootnoteReference)

Элемент абзаца со ссылкой на сноску.
horizontalRule

object (HorizontalRule)

Элемент абзаца с горизонтальной линией.
equation

object (Equation)

Элемент абзаца с формулой.
inlineObjectElement

object (InlineObjectElement)

Параграф встроенного объекта.
person

object (Person)

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

object (DateElement)

Элемент абзаца, представляющий дату.
dropdown

object (Dropdown)

Элемент абзаца, представляющий раскрывающееся меню.
Конец взаимоисключающих полей.

TextRun

Объект ParagraphElement, представляющий собой фрагмент текста с одинаковым форматированием.

JSON-представление 
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
content

string

Текст этого фрагмента.

Все нетекстовые элементы в фрагменте заменяются символом Юникода U+E907.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента TextRun может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого фрагмента.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста применяется к этому фрагменту, который идентифицируется по идентификатору предложения.

TextStyle

Представляет собой стиль, который можно применить к тексту.

Унаследованные стили текста представлены в этом сообщении как неустановленные поля. Родительский стиль текста зависит от того, где он определен:

  • Стиль текста в элементе Paragraph наследуется от соответствующего элемента named style type абзаца.
  • Стиль текста в элементе named style наследуется от стиля normal text.
  • Стиль текста normal text наследуется от стиля текста по умолчанию в редакторе Документов.
  • Стиль текста элемента Paragraph, который содержится в таблице, может быть унаследован от стиля таблицы.

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

JSON-представление 
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Поля
bold

boolean

Отображается ли текст полужирным шрифтом.
italic

boolean

Курсив.
underline

boolean

Подчеркнут ли текст.
strikethrough

boolean

Информация о том, зачеркнут ли текст.
smallCaps

boolean

Используются ли в тексте малые прописные буквы.
backgroundColor

object (OptionalColor)

Цвет фона текста. Если задано, цвет будет либо RGB, либо прозрачным в зависимости от поля color.
foregroundColor

object (OptionalColor)

Цвет текста. Если задано, цвет будет либо RGB, либо прозрачным в зависимости от поля color.
fontSize

object (Dimension)

Размер шрифта текста.
weightedFontFamily

object (WeightedFontFamily)

Семейство шрифтов и насыщенность текста.

Если в запросе на обновление указаны значения для обоих параметров (weightedFontFamily и bold), сначала применяется параметр weightedFontFamily, а затем bold.

Если значение weightedFontFamily#weight не задано, по умолчанию используется 400.

Если задано значение weightedFontFamily, то для weightedFontFamily#fontFamily также должно быть задано непустое значение. В противном случае возвращается ошибка 400 (недопустимый запрос).
baselineOffset

enum (BaselineOffset)

Вертикальное смещение текста относительно его обычного положения.

Текст со смещением базовой линии SUPERSCRIPT или SUBSCRIPT автоматически отображается с меньшим размером шрифта, который рассчитывается на основе поля fontSize. Изменения в этом поле не влияют на fontSize.

OptionalColor

Цвет, который может быть полностью непрозрачным или полностью прозрачным.

JSON-представление 
{
  "color": {
    object (Color)
  }
}
Поля
color

object (Color)

Если задано, будет использоваться как непрозрачный цвет. Если не задано, используется прозрачный цвет.

Цвет

сплошной цвет;

JSON-представление 
{
  "rgbColor": {
    object (RgbColor)
  }
}
Поля
rgbColor

object (RgbColor)

Значение цвета RGB.

RgbColor

Цвет RGB.

JSON-представление 
{
  "red": number,
  "green": number,
  "blue": number
}
Поля
red

number

Красный компонент цвета (от 0.0 до 1.0).
green

number

Зеленый компонент цвета в диапазоне от 0.0 до 1.0.
blue

number

Синий компонент цвета в диапазоне от 0,0 до 1,0.

Параметр

Величина в одном направлении в указанных единицах.

JSON-представление 
{
  "magnitude": number,
  "unit": enum (Unit)
}
Поля
magnitude

number

Величина.
unit

enum (Unit)

Единицы измерения величины.

Единица измерения

Единицы измерения.

Перечисления
UNIT_UNSPECIFIED Единицы измерения неизвестны.
PT Пункт, 1/72 дюйма.

WeightedFontFamily

Представляет семейство шрифтов и насыщенность текста.

JSON-представление 
{
  "fontFamily": string,
  "weight": integer
}
Поля
fontFamily

string

Семейство шрифтов текста.

В качестве семейства шрифтов можно выбрать любой шрифт из меню "Шрифт" в Документах или из Google Fonts. Если название шрифта не распознано, текст будет отображен шрифтом Arial.
weight

integer

Насыщенность шрифта. Это поле может принимать любое значение, кратное 100, в диапазоне от 100 до 900 включительно. Этот диапазон соответствует числовым значениям, описанным в спецификации CSS 2.1, раздел 15.6. Нечисловые значения не допускаются.

Значение по умолчанию – 400 ("обычный").

Насыщенность шрифта – лишь один из компонентов, определяющих его отображение. Итоговая толщина штриха определяется сочетанием значения weight и значения bold, полученного для стиля текста с учетом наследования:

  • Если текст выделен полужирным шрифтом, а вес меньше 400, то вес будет равен 400.
  • Если текст выделен полужирным шрифтом и значение параметра weight больше или равно 400, но меньше 700, то отображаемое значение параметра weight будет равно 700.
  • Если вес больше или равен 700, то отображаемый вес равен весу.
  • Если текст не выделен полужирным шрифтом, то отображаемый вес равен весу.

BaselineOffset

Способы вертикального смещения текста относительно его обычного положения.

Перечисления
BASELINE_OFFSET_UNSPECIFIED Смещение базовой линии текста наследуется от родительского элемента.
NONE Текст не смещен по вертикали.
SUPERSCRIPT Текст смещен вверх (надстрочный текст).
SUBSCRIPT Текст смещен вниз по вертикали (подстрочный).

SuggestedTextStyle

Предлагаемое изменение для TextStyle.

JSON-представление 
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Поля
textStyle

object (TextStyle)

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

object (TextStyleSuggestionState)

Маска, указывающая, какие поля в базовом объекте TextStyle были изменены в этом предложении.

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

boolean

Указывает, было ли предложено изменить bold.
italicSuggested

boolean

Указывает, было ли предложено изменить italic.
underlineSuggested

boolean

Указывает, было ли предложено изменить underline.
strikethroughSuggested

boolean

Указывает, было ли предложено изменить strikethrough.
smallCapsSuggested

boolean

Указывает, было ли предложено изменить smallCaps.
backgroundColorSuggested

boolean

Указывает, было ли предложено изменить backgroundColor.
foregroundColorSuggested

boolean

Указывает, было ли предложено изменить foregroundColor.
fontSizeSuggested

boolean

Указывает, было ли предложено изменить fontSize.
weightedFontFamilySuggested

boolean

Указывает, было ли предложено изменить weightedFontFamily.
baselineOffsetSuggested

boolean

Указывает, было ли предложено изменить baselineOffset.

AutoText

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

JSON-представление 
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
type

enum (Type)

Тип автоматического текста.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента AutoText может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого автотекста.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на стиль AutoText, связанный с идентификатором предложения.

Тип

Типы автотекста.

Перечисления
TYPE_UNSPECIFIED Неуказанный тип автоматического текста.
PAGE_NUMBER Введите текст, который будет автоматически заменяться номером текущей страницы.
PAGE_COUNT Тип автотекста, представляющий общее количество страниц в документе.

PageBreak

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

JSON-представление 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента PageBreak может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого разрыва страницы.

Как и текстовый контент, например текстовые фрагменты и ссылки на сноски, стиль текста разрыва страницы может влиять на макет контента, а также на стиль текста, вставленного рядом с ним.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

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

ColumnBreak

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

JSON-представление 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента ColumnBreak может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого объекта ColumnBreak.

Как и в случае с текстовым контентом, например текстовыми фрагментами и ссылками на сноски, стиль текста разрыва столбца может влиять на макет контента, а также на стиль текста, вставленного рядом с ним.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на ColumnBreak, ключ которого – идентификатор предложения.

FootnoteReference

ParagraphElement – ссылка на сноску. Ссылка на сноску – это встроенный контент, который отображается с номером и используется для идентификации сноски.

JSON-представление 
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
footnoteId

string

Идентификатор footnote, содержащего контент этой ссылки на сноску.
footnoteNumber

string

Номер сноски, который будет показан.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У объекта FootnoteReference может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого объекта FootnoteReference.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на стиль FootnoteReference, который определяется по идентификатору предложения.

HorizontalRule

Символ ParagraphElement, обозначающий горизонтальную линию.

JSON-представление 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента HorizontalRule может быть несколько идентификаторов вставки, если он является вложенным предложенным изменением. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого элемента HorizontalRule.

Как и в случае с текстовым контентом, например текстовыми фрагментами и ссылками на сноски, стиль текста горизонтальной линии может влиять на макет контента, а также на стиль текста, вставленного рядом с ней.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на это правило HorizontalRule, ключ которого – идентификатор предложения.

Формула

Значок ParagraphElement, обозначающий формулу.

JSON-представление 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Поля
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента Equation может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.

InlineObjectElement

Объект ParagraphElement, содержащий объект InlineObject.

JSON-представление 
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Поля
inlineObjectId

string

Идентификатор элемента InlineObject, который содержит этот элемент.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента InlineObjectElement может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
textStyle

object (TextStyle)

Стиль текста для этого объекта InlineObjectElement.

Как и в случае с текстовым контентом, например текстовыми фрагментами и ссылками на сноски, стиль текста встроенного объекта может влиять на макет контента, а также на стиль текста, вставленного рядом с ним.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста применяется к этому объекту InlineObject, который идентифицируется по идентификатору предложения.

Человек

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

JSON-представление 
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Поля
personId

string

Используется только для вывода. Уникальный идентификатор этой связи.
suggestedInsertionIds[]

string

Идентификаторы предложений, которые вставляют ссылку на этого человека в документ. У объекта Person может быть несколько идентификаторов вставки, если это вложенное предложенное изменение (например, предложение в предложении, сделанном другим пользователем). Если поле пустое, ссылка на пользователя не будет предлагаться для вставки.
suggestedDeletionIds[]

string

Идентификаторы предложений, которые удаляют ссылку на этого человека из документа. У объекта Person может быть несколько идентификаторов удаления, если, например, несколько пользователей предложили удалить его. Если поле пустое, ссылка на человека не будет предложена для удаления.
textStyle

object (TextStyle)

Стиль текста в Person.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на Person, который определяется по идентификатору предложения.
personProperties

object (PersonProperties)

Используется только для вывода. Свойства объекта Person. Это поле всегда присутствует.

PersonProperties

Свойства, относящиеся к связанному объекту Person.

JSON-представление 
{
  "name": string,
  "email": string
}
Поля
name

string

Имя пользователя, если оно указано в тексте ссылки вместо адреса электронной почты.
email

string

Адрес электронной почты, связанный с Person. Это поле всегда присутствует.

RichLinkProperties

Свойства, относящиеся к RichLink.

JSON-представление 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
Поля
title

string

Название RichLink, которое показывается в ссылке. Название соответствует названию связанного ресурса на момент вставки или последнего обновления ссылки. Это поле всегда присутствует.
uri

string

URI для RichLink. Этот параметр всегда присутствует.
mimeType

string

MIME-тип объекта RichLink, если он есть (например, если это файл на Диске).

DateElement

Экземпляр даты, упомянутый в документе.

JSON-представление 
{
  "dateId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "suggestedDateElementPropertiesChanges": {
    string: {
      object (SuggestedDateElementProperties)
    },
    ...
  }
}
Поля
dateId

string

Используется только для вывода. Уникальный идентификатор даты.
suggestedInsertionIds[]

string

Идентификаторы подсказок, которые вставляют эту дату в документ. У элемента DateElement может быть несколько идентификаторов вставки, если это вложенное предложенное изменение (например, предложение в предложении, сделанном другим пользователем). Если поле пустое, то эта дата не является рекомендуемой для размещения.
suggestedDeletionIds[]

string

Идентификаторы подсказок, которые удаляют эту дату из документа. У элемента DateElement может быть несколько идентификаторов удаления, если, например, несколько пользователей предложили удалить его. Если поле пустое, то эта дата не предлагается для удаления.
textStyle

object (TextStyle)

Стиль текста элемента DateElement.
suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Предложенный стиль текста меняется на этот элемент DateElement, который определяется по идентификатору предложения.
dateElementProperties

object (DateElementProperties)

Свойства этого элемента DateElement.
suggestedDateElementPropertiesChanges

map (key: string, value: object (SuggestedDateElementProperties))

Предлагаемые изменения свойств элемента даты, сгруппированные по идентификатору предложения.

DateElementProperties

Свойства DateElement.

JSON-представление 
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
Поля
timestamp

string (Timestamp format)

Момент времени, который нужно представить, в секундах и наносекундах с начала эпохи Unix: 1 января 1970 г. в полночь по UTC.

Временная метка должна быть указана в формате UTC. Если задан параметр timeZoneId, временная метка корректируется в соответствии с часовым поясом. Например, временная метка 18000 с форматом даты DATE_FORMAT_ISO8601 и форматом времени TIME_FORMAT_HOUR_MINUTE будет отображаться как 1970-01-01 5:00 AM. Временная метка 18000 с форматом даты DATE_FORMAT_ISO8601, форматом времени TIME_FORMAT_HOUR_MINUTE и часовым поясом America/New_York будет преобразована в 1970-01-01 12:00 AM.
timeZoneId

string

Часовой пояс элемента DateElement, определенный проектом Unicode Common Locale Data Repository (CLDR). например America/New_York (2-е издание). Если не задано, по умолчанию используется часовой пояс etc/UTC.
locale

string

Код языка элемента даты. например en (2-е издание). Если не задано, по умолчанию используется значение en.

Поддерживаются следующие языки: af, am, ar, as, az, be, bg, bn, ca, cs, da, de, el, en, en-CA, en-GB, es, es-419, et, eu, fa, fi, fil, fr, fr-CA, gl, gu, hi, hr, hu, hy, id, is, it, iw, ja, ka, kk, km, kn, ko, lo, lt, lv, mk, ml, mn, mr, ms, ne, nl, no, or, pa, pl, pt-BR, pt-PT, ro, ru, si, sk, sl, sq, sr, sv, sw, ta, te, th, tr, uk, ur, uz, vi, zh-CN, zh-HK, zh-TW, zu, cy, my.
dateFormat

enum (DateFormat)

Определяет, как будет отображаться в документе часть элемента DateElement, относящаяся к дате.

Если значение не задано, по умолчанию используется DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, указывающий, что элемент DateElement будет отформатирован как MMM d, y в en или аналогичным образом в зависимости от региональных настроек.
timeFormat

enum (TimeFormat)

Определяет, как временная часть элемента DateElement будет отображаться в документе.

Если значение не задано, по умолчанию используется TIME_FORMAT_DISABLED, то есть время не показывается.
displayText

string

Используется только для вывода. Указывает, как элемент DateElement отображается в документе.

DateFormat

Возможные форматы даты для DateElement.

Перечисления
DATE_FORMAT_UNSPECIFIED Формат даты не указан.
DATE_FORMAT_CUSTOM Используется только для вывода. Формат даты импортируется из внешнего источника.
DATE_FORMAT_MONTH_DAY_ABBREVIATED Дата указывается в формате "сокращенное название месяца, день". Пример: "1 января".
DATE_FORMAT_MONTH_DAY_FULL Дата указывается в формате "месяц, день". Пример: "01 января".
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED Формат даты: сокращенное название месяца, день и год. Пример: 1 января 1970 г.
DATE_FORMAT_ISO8601 Дата должна быть указана в формате ISO 8601. Пример: "1970-01-01".

TimeFormat

Возможные форматы времени для DateElement.

Перечисления
TIME_FORMAT_UNSPECIFIED Формат времени не указан.
TIME_FORMAT_DISABLED Указывает, что в дате нет времени.
TIME_FORMAT_HOUR_MINUTE Формат времени показывает часы и минуты. Пример: "1 января 1970 г., 12:00".
TIME_FORMAT_HOUR_MINUTE_TIMEZONE Формат времени включает час, минуту и часовой пояс. Пример: "1 января 1970 г., 12:00 (UTC)".

SuggestedDateElementProperties

Предлагаемое изменение для DateElementProperties.

JSON-представление 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "dateElementPropertiesSuggestionState": {
    object (DateElementPropertiesSuggestionState)
  }
}
Поля
dateElementProperties

object (DateElementProperties)

DateElementProperties, в котором будут только изменения, предложенные в этом варианте. Его можно использовать вместе с dateElementPropertiesSuggestionState, чтобы узнать, какие поля были изменены и какие значения в них теперь указаны.
dateElementPropertiesSuggestionState

object (DateElementPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте DateElementProperties были изменены в этом предложении.

DateElementPropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте DateElementProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "timestampSuggested": boolean,
  "timeZoneIdSuggested": boolean,
  "localeSuggested": boolean,
  "dateFormatSuggested": boolean,
  "timeFormatSuggested": boolean
}
Поля
timestampSuggested

boolean

Указывает, было ли предложено изменить timestamp.
timeZoneIdSuggested

boolean

Указывает, было ли предложено изменить timeZoneId.
localeSuggested

boolean

Указывает, было ли предложено изменить locale.
dateFormatSuggested

boolean

Указывает, было ли предложено изменить dateFormat.
timeFormatSuggested

boolean

Указывает, было ли предложено изменить timeFormat.

SuggestedDropdownProperties

Предложенное изменение свойств раскрывающегося списка.

JSON-представление 
{
  "dropdownProperties": {
    object (DropdownProperties)
  },
  "dropdownPropertiesSuggestionState": {
    object (DropdownPropertiesSuggestionState)
  }
}
Поля
dropdownProperties

object (DropdownProperties)

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

object (DropdownPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте DropdownProperties были изменены в этом предложении.

ParagraphStyle

Стили, которые применяются ко всему абзацу.

Унаследованные стили абзацев представлены в этом сообщении как неустановленные поля. Родительский стиль абзаца зависит от того, где он определен:

  • Стиль абзаца в элементе Paragraph наследуется от соответствующего элемента named style type.
  • Стиль ParagraphStyle в элементе named style наследуется от именованного стиля normal text.
  • Стиль абзаца normal text наследуется от стиля абзаца по умолчанию в редакторе Документов.
  • Стиль абзаца элемента Paragraph, который содержится в таблице, может быть унаследован от стиля таблицы.

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

JSON-представление 
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
Поля
headingId

string

Идентификатор заголовка абзаца. Если поле пустое, то абзац не является заголовком.

Это свойство доступно только для чтения.
namedStyleType

enum (NamedStyleType)

Тип стиля абзаца.

Поскольку обновление типа именованного стиля влияет на другие свойства в ParagraphStyle, тип именованного стиля применяется до обновления других свойств.
alignment

enum (Alignment)

Выравнивание текста в абзаце.
lineSpacing

number

Межстрочный интервал в процентах от нормального, где нормальный интервал равен 100 %. Если параметр не задан, значение наследуется от родительского элемента.
direction

enum (ContentDirection)

Направление текста в этом абзаце. Если значение не задано, по умолчанию используется LEFT_TO_RIGHT, поскольку направление абзаца не наследуется.
spacingMode

enum (SpacingMode)

Режим интервалов для абзаца.
spaceAbove

object (Dimension)

Размер дополнительного интервала над абзацем. Если параметр не задан, значение наследуется от родительского элемента.
spaceBelow

object (Dimension)

Размер дополнительного интервала после абзаца. Если параметр не задан, значение наследуется от родительского элемента.
borderBetween

object (ParagraphBorder)

Граница между этим абзацем и предыдущим или следующим. Если параметр не задан, значение наследуется от родительского элемента.

Граница между абзацами отображается, если у соседних абзацев одинаковые свойства границ и отступов.

Нельзя изменить только часть границ абзаца. При изменении границы абзаца необходимо указать ее полностью.
borderTop

object (ParagraphBorder)

Граница в верхней части абзаца. Если параметр не задан, значение наследуется от родительского элемента.

Верхняя граница отображается, если у абзаца выше другие свойства границы и отступа.

Нельзя изменить только часть границ абзаца. При изменении границы абзаца необходимо указать ее полностью.
borderBottom

object (ParagraphBorder)

Граница внизу этого абзаца. Если параметр не задан, значение наследуется от родительского элемента.

Нижняя граница отображается, если у следующего абзаца другие свойства границ и отступов.

Нельзя изменить только часть границ абзаца. При изменении границы абзаца необходимо указать ее полностью.
borderLeft

object (ParagraphBorder)

Граница слева от абзаца. Если параметр не задан, значение наследуется от родительского элемента.

Нельзя изменить только часть границ абзаца. При изменении границы абзаца необходимо указать ее полностью.
borderRight

object (ParagraphBorder)

Граница справа от абзаца. Если параметр не задан, значение наследуется от родительского элемента.

Нельзя изменить только часть границ абзаца. При изменении границы абзаца необходимо указать ее полностью.
indentFirstLine

object (Dimension)

Величина отступа первой строки абзаца. Если параметр не задан, значение наследуется от родительского элемента.
indentStart

object (Dimension)

Величина отступа для абзаца с той стороны, которая соответствует началу текста, с учетом текущего направления абзаца. Если параметр не задан, значение наследуется от родительского элемента.
indentEnd

object (Dimension)

Величина отступа для абзаца с той стороны, которая соответствует концу текста, с учетом текущего направления абзаца. Если параметр не задан, значение наследуется от родительского элемента.
tabStops[]

object (TabStop)

Список позиций табуляции для этого абзаца. Список позиций табуляции не наследуется.

Это свойство доступно только для чтения.
keepLinesTogether

boolean

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

boolean

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

boolean

Нужно ли избегать висячих строк в абзаце. Если параметр не задан, значение наследуется от родительского элемента.
shading

object (Shading)

Заливка абзаца. Если параметр не задан, значение наследуется от родительского элемента.
pageBreakBefore

boolean

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

При попытке обновить pageBreakBefore для абзацев в регионах, которые не поддерживаются, например Table, Header, Footer и Footnote, может возникнуть недопустимое состояние документа, при котором возвращается ошибка 400 "Недопустимый запрос".

NamedStyleType

Типы именованных стилей.

Перечисления
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 Абзац выровнен по началу строки. Выравнивание по левому краю для текста, написанного слева направо, и по правому краю в остальных случаях.
CENTER Абзац выровнен по центру.
END Абзац выровнен по правому краю. Выравнивание по правому краю для текста, написанного слева направо, и по левому краю в остальных случаях.
JUSTIFIED Абзац выровнен по ширине.

ContentDirection

Контент с указаниями маршрута может быть добавлен.

Перечисления
CONTENT_DIRECTION_UNSPECIFIED Не указано направление контента.
LEFT_TO_RIGHT Контент располагается слева направо.
RIGHT_TO_LEFT Контент читается справа налево.

SpacingMode

Разные режимы для интервалов между абзацами.

Перечисления
SPACING_MODE_UNSPECIFIED Режим интервалов наследуется от родительского элемента.
NEVER_COLLAPSE Межстрочный интервал всегда отображается.
COLLAPSE_LISTS Между элементами списка не добавляется интервал между абзацами.

ParagraphBorder

Рамка вокруг абзаца.

JSON-представление 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Поля
color

object (OptionalColor)

Цвет границы.
width

object (Dimension)

Ширина границы.
padding

object (Dimension)

Поля границы.
dashStyle

enum (DashStyle)

Стиль пунктирной линии границы.

DashStyle

Типы штрихов, с помощью которых можно отрисовать линейную геометрию. Эти значения основаны на простом типе "ST_PresetLineDashVal", описанном в разделе 20.1.10.49 документа "Office Open XML File Formats - Fundamentals and Markup Language Reference", часть 1 ECMA-376 5th edition.

Перечисления
DASH_STYLE_UNSPECIFIED Тип тире не указан.
SOLID Сплошная линия. Соответствует значению "solid" из типа ST_PresetLineDashVal спецификации ECMA-376. Это стиль тире по умолчанию.
DOT Пунктирная линия. Соответствует значению dot (точка) параметра ST_PresetLineDashVal из спецификации ECMA-376.
DASH Пунктирная линия. Соответствует значению dash (пунктир) параметра ST_PresetLineDashVal в спецификации ECMA-376.

TabStop

Позиция табуляции в абзаце.

JSON-представление 
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Поля
offset

object (Dimension)

Смещение между этой позицией табуляции и левым полем.
alignment

enum (TabStopAlignment)

Выравнивание табуляции. Если значение не задано, по умолчанию используется START.

TabStopAlignment

Выравнивание позиции табуляции.

Перечисления
TAB_STOP_ALIGNMENT_UNSPECIFIED Выравнивание табуляции не указано.
START Позиция табуляции выравнивается по началу строки. Это значение используется по умолчанию.
CENTER Позиция табуляции выравнивается по центру строки.
END Позиция табуляции выравнивается по концу строки.

Затенение

Заливка абзаца.

JSON-представление 
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
Поля
backgroundColor

object (OptionalColor)

Цвет фона для затенения абзаца.

SuggestedParagraphStyle

Предлагаемое изменение для ParagraphStyle.

JSON-представление 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Поля
paragraphStyle

object (ParagraphStyle)

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

object (ParagraphStyleSuggestionState)

Маска, указывающая, какие поля в базовом объекте ParagraphStyle были изменены в этом предложении.

ParagraphStyleSuggestionState

Маска, указывающая, какие поля в базовом объекте 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 (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Поля
headingIdSuggested

boolean

Указывает, было ли предложено изменить headingId.
namedStyleTypeSuggested

boolean

Указывает, было ли предложено изменить namedStyleType.
alignmentSuggested

boolean

Указывает, было ли предложено изменить alignment.
lineSpacingSuggested

boolean

Указывает, было ли предложено изменить lineSpacing.
directionSuggested

boolean

Указывает, было ли предложено изменить direction.
spacingModeSuggested

boolean

Указывает, было ли предложено изменить spacingMode.
spaceAboveSuggested

boolean

Указывает, было ли предложено изменить spaceAbove.
spaceBelowSuggested

boolean

Указывает, было ли предложено изменить spaceBelow.
borderBetweenSuggested

boolean

Указывает, было ли предложено изменить borderBetween.
borderTopSuggested

boolean

Указывает, было ли предложено изменить borderTop.
borderBottomSuggested

boolean

Указывает, было ли предложено изменить borderBottom.
borderLeftSuggested

boolean

Указывает, было ли предложено изменить borderLeft.
borderRightSuggested

boolean

Указывает, было ли предложено изменить borderRight.
indentFirstLineSuggested

boolean

Указывает, было ли предложено изменить indentFirstLine.
indentStartSuggested

boolean

Указывает, было ли предложено изменить indentStart.
indentEndSuggested

boolean

Указывает, было ли предложено изменить indentEnd.
keepLinesTogetherSuggested

boolean

Указывает, было ли предложено изменить keepLinesTogether.
keepWithNextSuggested

boolean

Указывает, было ли предложено изменить keepWithNext.
avoidWidowAndOrphanSuggested

boolean

Указывает, было ли предложено изменить avoidWidowAndOrphan.
shadingSuggestionState

object (ShadingSuggestionState)

Маска, указывающая, какие поля в shading были изменены в этом предложении.
pageBreakBeforeSuggested

boolean

Указывает, было ли предложено изменить pageBreakBefore.

ShadingSuggestionState

Маска, указывающая, какие поля в базовом объекте Shading были изменены в предложенном изменении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "backgroundColorSuggested": boolean
}
Поля
backgroundColorSuggested

boolean

Указывает, было ли предложено изменить Shading.

Маркер списка

Описывает маркер абзаца.

JSON-представление 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Поля
listId

string

Идентификатор списка, к которому относится этот абзац.
nestingLevel

integer

Уровень вложенности этого абзаца в списке.
textStyle

object (TextStyle)

Стиль текста, примененный к этому маркеру.

SuggestedBullet

Предлагаемое изменение для Bullet.

JSON-представление 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Поля
bullet

object (Bullet)

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

object (BulletSuggestionState)

Маска, указывающая, какие поля в базовом объекте Bullet были изменены в этом предложении.

BulletSuggestionState

Маска, указывающая, какие поля в базовом объекте Bullet были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Поля
listIdSuggested

boolean

Указывает, было ли предложено изменить listId.
nestingLevelSuggested

boolean

Указывает, было ли предложено изменить nestingLevel.
textStyleSuggestionState

object (TextStyleSuggestionState)

Маска, указывающая, какие поля в text style были изменены в этом предложении.

ObjectReferences

Набор идентификаторов объектов.

JSON-представление 
{
  "objectIds": [
    string
  ]
}
Поля
objectIds[]

string

Идентификаторы объектов.

SectionBreak

Символ StructuralElement, обозначающий разрыв раздела. Раздел – это диапазон контента с одинаковым значением SectionStyle. Разрыв раздела обозначает начало нового раздела, и стиль раздела применяется к разделу после разрыва.

Основная часть документа всегда начинается с разрыва раздела.

JSON-представление 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Поля
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У объекта SectionBreak может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
sectionStyle

object (SectionStyle)

Стиль раздела после разрыва.

SectionStyle

Стиль, применяемый к разделу.

JSON-представление 
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
Поля
columnProperties[]

object (SectionColumnProperties)

Свойства столбцов раздела.

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

При обновлении этого свойства необходимо задать определенное значение. Если не задать это свойство, будет возвращена ошибка 400 (недопустимый запрос).
columnSeparatorStyle

enum (ColumnSeparatorStyle)

Стиль разделителей столбцов.

Этот стиль можно задать, даже если в разделе всего один столбец.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
contentDirection

enum (ContentDirection)

Направление контента в этом разделе. Если значение не задано, по умолчанию используется LEFT_TO_RIGHT.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
marginTop

object (Dimension)

Верхнее поле страницы в разделе. Если значение не задано, по умолчанию используется значение marginTop из DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
marginBottom

object (Dimension)

Нижнее поле страницы в разделе. Если значение не задано, по умолчанию используется значение marginBottom из DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
marginRight

object (Dimension)

Правое поле страницы в разделе. Если значение не задано, по умолчанию используется значение marginRight из DocumentStyle. При изменении правого поля столбцы в этом разделе будут изменены. Поскольку отступ влияет на ширину столбца, он применяется до свойств столбца.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
marginLeft

object (Dimension)

Левое поле страницы в разделе. Если значение не задано, по умолчанию используется значение marginLeft из DocumentStyle. При изменении левого поля столбцы в этом разделе будут изменены. Поскольку отступ влияет на ширину столбца, он применяется до свойств столбца.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
marginHeader

object (Dimension)

Поле верхнего колонтитула раздела. Если значение не задано, по умолчанию используется значение marginHeader из DocumentStyle. Если значение обновлено, для параметра useCustomHeaderFooterMargins в DocumentStyle задано значение true. Значение параметра useCustomHeaderFooterMargins в DocumentStyle указывает, учитывается ли для этого раздела верхнее поле.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
sectionType

enum (SectionType)

Используется только для вывода. Тип раздела.
defaultHeaderId

string

Идентификатор заголовка по умолчанию. Если значение не задано, оно наследуется от предыдущего элемента SectionBreak's SectionStyle. Если значение не задано в первом разделе, оно наследуется из defaultHeaderId в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
firstPageHeaderId

string

Идентификатор заголовка, который используется только на первой странице раздела. Если для useFirstPageHeaderFooter задано значение true, это значение используется для заголовка на первой странице раздела. Если значение равно false, заголовок на первой странице раздела использует defaultHeaderId. Если значение не задано, оно наследуется от предыдущего элемента SectionBreak's SectionStyle. Если значение не задано в первом разделе, оно наследуется из firstPageHeaderId в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
firstPageFooterId

string

Идентификатор нижнего колонтитула, который используется только на первой странице раздела. Если для параметра useFirstPageHeaderFooter задано значение true, это значение используется для нижнего колонтитула на первой странице раздела. Если значение "ложь", в нижнем колонтитуле на первой странице раздела используется defaultFooterId. Если значение не задано, оно наследуется от предыдущего элемента SectionBreak's SectionStyle. Если значение не задано в первом разделе, оно наследуется из firstPageFooterId в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
evenPageHeaderId

string

Идентификатор верхнего колонтитула, используемого только на четных страницах. Если значение useEvenPageHeaderFooter в DocumentStyle равно true, это значение используется для заголовков на четных страницах раздела. Если значение равно false, в заголовках четных страниц используется defaultHeaderId. Если значение не задано, оно наследуется от предыдущего элемента SectionBreak's SectionStyle. Если значение не задано в первом разделе, оно наследуется из evenPageHeaderId в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
evenPageFooterId

string

Идентификатор нижнего колонтитула, который используется только на четных страницах. Если значение useEvenPageHeaderFooter в DocumentStyle равно true, это значение используется для нижних колонтитулов на четных страницах раздела. Если значение равно False, в нижних колонтитулах на четных страницах используется символ defaultFooterId. Если значение не задано, оно наследуется от предыдущего элемента SectionBreak's SectionStyle. Если значение не задано в первом разделе, оно наследуется из evenPageFooterId в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
useFirstPageHeaderFooter

boolean

Указывает, следует ли использовать идентификаторы верхнего и нижнего колонтитулов первой страницы для первой страницы раздела. Если значение не задано, оно наследуется от useFirstPageHeaderFooter из DocumentStyle для первого раздела. Если значение не задано для последующих секторов, оно должно интерпретироваться как false.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
pageNumberStart

integer

Номер страницы, с которой начинается нумерация страниц в этом разделе. Если не задано, нумерация страниц продолжается с предыдущего раздела. Если значение не задано в первом элементе SectionBreak, обратитесь к элементу pageNumberStart в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).
flipPageOrientation

boolean

Необязательное поле. Указывает, нужно ли менять местами значения параметров pageSize из DocumentStyle для этого раздела. Это позволяет переключаться между книжной и альбомной ориентацией страницы. Если значение не задано, оно наследуется от flipPageOrientation в DocumentStyle.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

При обновлении этого свойства необходимо задать определенное значение. Если отменить настройку этого свойства, возникнет ошибка 400 (недопустимый запрос).

SectionColumnProperties

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

JSON-представление 
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
Поля
width

object (Dimension)

Используется только для вывода. Ширина столбца.
paddingEnd

object (Dimension)

Отступ в конце столбца.

ColumnSeparatorStyle

Стиль разделителей между столбцами.

Перечисления
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Неуказанный стиль разделителя столбцов.
NONE Между столбцами нет разделительных линий.
BETWEEN_EACH_COLUMN Отображает разделительную линию между столбцами.

SectionType

Показывает, как начало текущего раздела расположено относительно предыдущего.

Перечисления
SECTION_TYPE_UNSPECIFIED Тип раздела не указан.
CONTINUOUS Раздел начинается сразу после последнего абзаца предыдущего раздела.
NEXT_PAGE Раздел начинается на следующей странице.

Таблица

Значок StructuralElement, обозначающий таблицу.

JSON-представление 
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Поля
rows

integer

Количество строк в таблице.
columns

integer

Количество столбцов в таблице.

Таблица может быть непрямоугольной, поэтому в некоторых строках может быть разное количество ячеек.
tableRows[]

object (TableRow)

Содержимое и стиль каждой строки.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента Table может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
tableStyle

object (TableStyle)

Стиль таблицы.

TableRow

Содержимое и стиль строки в Table.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Поля
startIndex

integer

Начальный индекс этой строки, отсчитываемый от нуля, в единицах кода UTF-16.
endIndex

integer

Конечный индекс этой строки (не включительно), отсчитываемый от нуля в единицах кода UTF-16.
tableCells[]

object (TableCell)

Содержимое и стиль каждой ячейки в этой строке.

Таблица может быть непрямоугольной, поэтому в разных строках может быть разное количество ячеек.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента TableRow может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
tableRowStyle

object (TableRowStyle)

Стиль строки таблицы.
suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

Предложенные изменения стиля для этой строки, сгруппированные по идентификатору предложения.

TableCell

Содержимое и стиль ячейки в таблице Table.

JSON-представление 
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Поля
startIndex

integer

Начальный индекс этой ячейки (отсчитывается от нуля) в единицах кода UTF-16.
endIndex

integer

Конечный индекс ячейки (не включительно), отсчитываемый от нуля в единицах кода UTF-16.
content[]

object (StructuralElement)

Содержимое ячейки.
tableCellStyle

object (TableCellStyle)

Стиль ячейки.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента TableCell может быть несколько идентификаторов вставки, если это вложенное предложенное изменение. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.
suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

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

TableCellStyle

Стиль TableCell.

Унаследованные стили ячеек таблицы представлены в этом сообщении как неустановленные поля. Стиль ячейки таблицы может быть унаследован от стиля таблицы.

JSON-представление 
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
Поля
rowSpan

integer

Количество строк, занимаемых ячейкой.

Это свойство доступно только для чтения.
columnSpan

integer

Количество столбцов, занимаемых ячейкой.

Это свойство доступно только для чтения.
backgroundColor

object (OptionalColor)

Цвет фона ячейки.
borderLeft

object (TableCellBorder)

Левая граница ячейки.
borderRight

object (TableCellBorder)

Правая граница ячейки.
borderTop

object (TableCellBorder)

Верхняя граница ячейки.
borderBottom

object (TableCellBorder)

Нижняя граница ячейки.
paddingLeft

object (Dimension)

Левое поле ячейки.
paddingRight

object (Dimension)

Правое поле ячейки.
paddingTop

object (Dimension)

Верхнее поле ячейки.
paddingBottom

object (Dimension)

Нижнее поле ячейки.
contentAlignment

enum (ContentAlignment)

Выравнивание контента в ячейке таблицы. Выравнивание по умолчанию соответствует выравниванию для новых ячеек таблицы в редакторе Документов.

TableCellBorder

Граница вокруг ячейки таблицы.

Границы ячеек таблицы не могут быть прозрачными. Чтобы скрыть границу ячейки таблицы, задайте для нее ширину 0.

JSON-представление 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Поля
color

object (OptionalColor)

Цвет границы.

Этот цвет не может быть прозрачным.
width

object (Dimension)

Ширина границы.
dashStyle

enum (DashStyle)

Стиль пунктирной линии границы.

ContentAlignment

Типы соответствия контента.

Получено из подмножества значений простого типа "ST_TextAnchoringType" в разделе 20.1.10.60 документа "Форматы файлов Office Open XML – основы и справочник по языку разметки", часть 1 ECMA-376 5-го издания.

Перечисления
CONTENT_ALIGNMENT_UNSPECIFIED Неуказанное выравнивание контента. Выравнивание контента наследуется от родительского элемента, если он существует.
CONTENT_ALIGNMENT_UNSUPPORTED Неподдерживаемое выравнивание контента.
TOP Выравнивание по верхнему краю контейнера. Соответствует значению "t" типа ST_TextAnchoringType из спецификации ECMA-376.
MIDDLE Выравнивание по центру контейнера. Соответствует типу привязки текста ECMA-376 ST_TextAnchoringType ctr.
BOTTOM Выравнивание по нижнему краю контейнера. Соответствует значению "b" типа ST_TextAnchoringType из спецификации ECMA-376.

SuggestedTableCellStyle

Предлагаемое изменение для TableCellStyle.

JSON-представление 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Поля
tableCellStyle

object (TableCellStyle)

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

object (TableCellStyleSuggestionState)

Маска, указывающая, какие поля в базовом объекте TableCellStyle были изменены в этом предложении.

TableCellStyleSuggestionState

Маска, указывающая, какие поля в базовом объекте TableCellStyle были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

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

boolean

Указывает, было ли предложено изменить rowSpan.
columnSpanSuggested

boolean

Указывает, было ли предложено изменить columnSpan.
backgroundColorSuggested

boolean

Указывает, было ли предложено изменить backgroundColor.
borderLeftSuggested

boolean

Указывает, было ли предложено изменить borderLeft.
borderRightSuggested

boolean

Указывает, было ли предложено изменить borderRight.
borderTopSuggested

boolean

Указывает, было ли предложено изменить borderTop.
borderBottomSuggested

boolean

Указывает, было ли предложено изменить borderBottom.
paddingLeftSuggested

boolean

Указывает, было ли предложено изменить paddingLeft.
paddingRightSuggested

boolean

Указывает, было ли предложено изменить paddingRight.
paddingTopSuggested

boolean

Указывает, было ли предложено изменить paddingTop.
paddingBottomSuggested

boolean

Указывает, было ли предложено изменить paddingBottom.
contentAlignmentSuggested

boolean

Указывает, было ли предложено изменить contentAlignment.

TableRowStyle

Стили, применяемые к строке таблицы.

JSON-представление 
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Поля
minRowHeight

object (Dimension)

Минимальная высота строки. Строка будет отображаться в редакторе Документов с высотой, равной или большей этого значения, чтобы показать все содержимое ячеек строки.
tableHeader

boolean

Является ли строка заголовком таблицы.
preventOverflow

boolean

Указывает, может ли строка выходить за границы страницы или столбца.

SuggestedTableRowStyle

Предлагаемое изменение для TableRowStyle.

JSON-представление 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Поля
tableRowStyle

object (TableRowStyle)

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

object (TableRowStyleSuggestionState)

Маска, указывающая, какие поля в базовом объекте TableRowStyle были изменены в этом предложении.

TableRowStyleSuggestionState

Маска, указывающая, какие поля в базовом объекте TableRowStyle были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "minRowHeightSuggested": boolean
}
Поля
minRowHeightSuggested

boolean

Указывает, было ли предложено изменить minRowHeight.

TableStyle

Стили, применяемые к таблице.

JSON-представление 
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Поля
tableColumnProperties[]

object (TableColumnProperties)

Свойства каждого столбца.

Обратите внимание, что в Документах таблицы содержат строки, а строки – ячейки, как в HTML. Свойства строки можно найти в ее tableRowStyle.

TableColumnProperties

Свойства столбца в таблице.

JSON-представление 
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Поля
widthType

enum (WidthType)

Тип ширины столбца.
width

object (Dimension)

Ширина столбца. Установите, когда значение widthType в столбце равно FIXED_WIDTH.

WidthType

Тип ширины столбца.

Перечисления
WIDTH_TYPE_UNSPECIFIED Тип ширины столбца не указан.
EVENLY_DISTRIBUTED

Ширина столбца равномерно распределяется между другими столбцами с равномерным распределением.

Ширина столбца определяется автоматически и будет равна оставшейся ширине таблицы, разделенной на количество столбцов без указанной ширины.
FIXED_WIDTH фиксированную ширину столбца; Свойство [width][google.apps.docs.v1.TableColumnProperties.width содержит ширину столбца.

TableOfContents

Значок StructuralElement, обозначающий оглавление.

JSON-представление 
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Поля
content[]

object (StructuralElement)

Содержание оглавления.
suggestedInsertionIds[]

string

Идентификаторы предложенных вставок. У элемента TableOfContents может быть несколько идентификаторов вставки, если он является вложенным предложенным изменением. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.

Сноска

Сноска в документе.

JSON-представление 
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Поля
footnoteId

string

Идентификатор сноски.
content[]

object (StructuralElement)

Содержимое сноски.

Индексы для содержания сноски начинаются с нуля.

DocumentStyle

Стиль документа.

JSON-представление 
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean,
  "documentFormat": {
    object (DocumentFormat)
  }
}
Поля
background

object (Background)

Фон документа. У документов не может быть прозрачного фона.
defaultHeaderId

string

Идентификатор заголовка по умолчанию. Если не задано, заголовок по умолчанию отсутствует.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
evenPageHeaderId

string

Идентификатор верхнего колонтитула, используемого только на четных страницах. Значение useEvenPageHeaderFooter определяет, какое значение использовать для заголовка на четных страницах: defaultHeaderId или указанное здесь. Если не задано, верхнего колонтитула четной страницы нет.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
evenPageFooterId

string

Идентификатор нижнего колонтитула, который используется только на четных страницах. Значение useEvenPageHeaderFooter определяет, какой колонтитул будет использоваться на четных страницах: defaultFooterId или указанное здесь значение. Если не задано, нижнего колонтитула на четных страницах не будет.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
firstPageHeaderId

string

Идентификатор заголовка, который используется только на первой странице. Если не задано, то уникального верхнего колонтитула для первой страницы нет. Значение useFirstPageHeaderFooter определяет, какое значение использовать для заголовка на первой странице: defaultHeaderId или указанное здесь. Если не задано, верхний колонтитул первой страницы отсутствует.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
firstPageFooterId

string

Идентификатор нижнего колонтитула, который используется только на первой странице. Если не задано, то уникального нижнего колонтитула для первой страницы нет. Значение useFirstPageHeaderFooter определяет, какое значение будет использоваться для нижнего колонтитула на первой странице: defaultFooterId или указанное здесь. Если не задано, нижний колонтитул первой страницы отсутствует.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.

Это свойство доступно только для чтения.
useFirstPageHeaderFooter

boolean

Указывает, следует ли использовать идентификаторы верхнего и нижнего колонтитулов первой страницы для первой страницы.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
useEvenPageHeaderFooter

boolean

Указывает, следует ли использовать идентификаторы верхних и нижних колонтитулов для четных страниц.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
pageNumberStart

integer

Номер страницы, с которой нужно начать подсчет.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
marginTop

object (Dimension)

Верхнее поле страницы.

Если изменить верхнее поле страницы в стиле документа, верхнее поле страницы будет удалено во всех стилях разделов.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
marginBottom

object (Dimension)

Нижнее поле страницы.

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

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
marginRight

object (Dimension)

Правое поле страницы.

Если изменить правое поле в стиле документа, правое поле будет удалено во всех стилях разделов. Также может измениться размер столбцов во всех разделах.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
marginLeft

object (Dimension)

Левое поле страницы.

Если изменить левое поле страницы в стиле документа, левое поле страницы будет удалено во всех стилях разделов. Также может измениться размер столбцов во всех разделах.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
pageSize

object (Size)

Размер страницы в документе.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
marginHeader

object (Dimension)

Расстояние между верхним краем страницы и содержимым верхнего колонтитула.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
flipPageOrientation

boolean

Необязательное поле. Указывает, нужно ли менять местами значения параметров pageSize, чтобы изменить ориентацию страницы с вертикальной на горизонтальную или наоборот.

Если для параметра [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] задано значение PAGELESS, это свойство не будет отображаться.
documentFormat

object (DocumentFormat)

Указывает настройки формата на уровне документа, например режим документа (с разбивкой по страницам или без нее).

Фон

Представляет фон документа.

JSON-представление 
{
  "color": {
    object (OptionalColor)
  }
}
Поля
color

object (OptionalColor)

Цвет фона.

Размер

Ширина и высота.

JSON-представление 
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Поля
height

object (Dimension)

Высота объекта.
width

object (Dimension)

Ширина объекта.

DocumentFormat

Представляет настройки формата на уровне документа.

JSON-представление 
{
  "documentMode": enum (DocumentMode)
}
Поля
documentMode

enum (DocumentMode)

Разбивка по страницам или без нее.

DocumentMode

Разбивка по страницам или без нее.

Перечисления
DOCUMENT_MODE_UNSPECIFIED Режим документа не указан.
PAGES В документе есть страницы.
PAGELESS В документе нет разбивки по страницам.

SuggestedDocumentStyle

Предлагаемое изменение для DocumentStyle.

JSON-представление 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Поля
documentStyle

object (DocumentStyle)

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

object (DocumentStyleSuggestionState)

Маска, указывающая, какие поля в базовом объекте DocumentStyle были изменены в этом предложении.

DocumentStyleSuggestionState

Маска, указывающая, какие поля в базовом объекте DocumentStyle были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
Поля
backgroundSuggestionState

object (BackgroundSuggestionState)

Маска, указывающая, какие поля в background были изменены в этом предложении.
defaultHeaderIdSuggested

boolean

Указывает, было ли предложено изменить defaultHeaderId.
evenPageHeaderIdSuggested

boolean

Указывает, было ли предложено изменить evenPageHeaderId.
evenPageFooterIdSuggested

boolean

Указывает, было ли предложено изменить evenPageFooterId.
firstPageHeaderIdSuggested

boolean

Указывает, было ли предложено изменить firstPageHeaderId.
firstPageFooterIdSuggested

boolean

Указывает, было ли предложено изменить firstPageFooterId.
useFirstPageHeaderFooterSuggested

boolean

Указывает, было ли предложено изменить useFirstPageHeaderFooter.
useEvenPageHeaderFooterSuggested

boolean

Указывает, было ли предложено изменить useEvenPageHeaderFooter.
pageNumberStartSuggested

boolean

Указывает, было ли предложено изменить pageNumberStart.
marginTopSuggested

boolean

Указывает, было ли предложено изменить marginTop.
marginBottomSuggested

boolean

Указывает, было ли предложено изменить marginBottom.
marginRightSuggested

boolean

Указывает, было ли предложено изменить marginRight.
marginLeftSuggested

boolean

Указывает, было ли предложено изменить marginLeft.
pageSizeSuggestionState

object (SizeSuggestionState)

Маска, указывающая, какие поля в [size] [google.apps.docs.v1.DocumentStyle.size] были изменены в этом предложении.
marginHeaderSuggested

boolean

Указывает, было ли предложено изменить marginHeader.
flipPageOrientationSuggested

boolean

Необязательное поле. Указывает, было ли предложено изменить flipPageOrientation.

BackgroundSuggestionState

Маска, указывающая, какие поля в базовом объекте Background были изменены в этом предложении. Если для какого-либо поля задано значение true, у объекта Backgound есть новое предложенное значение.

JSON-представление 
{
  "backgroundColorSuggested": boolean
}
Поля
backgroundColorSuggested

boolean

Указывает, был ли изменен текущий цвет фона в этом предложении.

SizeSuggestionState

Маска, указывающая, какие поля в базовом объекте Size были изменены в этом предложении. Если для какого-либо поля задано значение true, у объекта Size есть новое предложенное значение.

JSON-представление 
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Поля
heightSuggested

boolean

Указывает, было ли предложено изменить height.
widthSuggested

boolean

Указывает, было ли предложено изменить width.

NamedStyles

Стили с названиями. Абзацы в документе могут наследовать TextStyle и ParagraphStyle из этих именованных стилей.

JSON-представление 
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Поля
styles[]

object (NamedStyle)

Стили с названиями.

Для каждого возможного значения named style types есть запись.

NamedStyle

Именованный стиль. Абзацы в документе могут наследовать значения TextStyle и ParagraphStyle из этого именованного стиля, если у них одинаковый тип именованного стиля.

JSON-представление 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Поля
namedStyleType

enum (NamedStyleType)

Тип этого именованного стиля.
textStyle

object (TextStyle)

Стиль текста для этого именованного стиля.
paragraphStyle

object (ParagraphStyle)

Стиль абзаца для этого именованного стиля.

SuggestedNamedStyles

Предлагаемое изменение для NamedStyles.

JSON-представление 
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Поля
namedStyles

object (NamedStyles)

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

object (NamedStylesSuggestionState)

Маска, указывающая, какие поля в базовом объекте NamedStyles были изменены в этом предложении.

NamedStylesSuggestionState

Состояние предложения для сообщения NamedStyles.

JSON-представление 
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Поля
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

Маска, указывающая, какие поля в соответствующем объекте NamedStyle из styles были изменены в этом предложении.

Порядок этих состояний совпадает с порядком соответствующих именованных стилей в предложении named styles.

NamedStyleSuggestionState

Статус подсказки для сообщения NamedStyle.

JSON-представление 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Поля
namedStyleType

enum (NamedStyleType)

Тип именованного стиля, которому соответствует состояние предложения.

Это поле предназначено для удобного сопоставления NamedStyleSuggestionState с соответствующим NamedStyle.
textStyleSuggestionState

object (TextStyleSuggestionState)

Маска, указывающая, какие поля в text style были изменены в этом предложении.
paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Маска, указывающая, какие поля в paragraph style были изменены в этом предложении.

Список

Объект List представляет атрибуты списка для группы абзацев, относящихся к одному списку. У абзаца, входящего в список, в элементе bullet есть ссылка на идентификатор списка.

JSON-представление 
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
listProperties

object (ListProperties)

Свойства списка.
suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

Предлагаемые изменения свойств списка, сгруппированные по идентификатору предложения.
suggestedInsertionId

string

Идентификатор предложенной вставки. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если список пуст, значит удалять ничего не нужно.

ListProperties

Свойства объекта list, описывающие внешний вид маркеров, относящихся к абзацам, связанным со списком.

JSON-представление 
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Поля
nestingLevels[]

object (NestingLevel)

Описывает свойства маркеров на связанном уровне.

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

NestingLevel

Содержит свойства, описывающие внешний вид маркера списка на определенном уровне вложенности.

JSON-представление 
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  "glyphType": enum (GlyphType),
  "glyphSymbol": string
}
Поля
bulletAlignment

enum (BulletAlignment)

Выравнивание маркера в пространстве, отведенном для его отрисовки.
glyphFormat

string

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

Формат глифа содержит один или несколько плейсхолдеров, которые заменяются на подходящие значения в зависимости от glyphType или glyphSymbol. Плейсхолдеры имеют формат %[nestingLevel]. Кроме того, у плейсхолдеров могут быть префиксы и суффиксы. Таким образом, формат глифа соответствует шаблону <prefix>%[nestingLevel]<suffix>. Обратите внимание, что префикс и суффикс не являются обязательными и могут быть любыми строками.

Например, формат глифа %0. означает, что отрисованный глиф заменит плейсхолдер соответствующим глифом для уровня вложенности 0, за которым будет следовать точка в качестве суффикса. Таким образом, список с типом маркера UPPER_ALPHA и форматом маркера %0. на уровне вложенности 0 будет содержать отрисованные маркеры.

A.

B.

C.

Формат глифа может содержать плейсхолдеры для текущего уровня вложенности, а также плейсхолдеры для родительских уровней вложенности. Например, в списке может использоваться формат глифа %0. на уровне вложенности 0 и формат глифа %0.%1. на уровне вложенности 1. Если оба уровня вложенности имеют тип глифа DECIMAL, то в результате будет создан список с отрисованными глифами.

1.

2.

2.1.

2.2.

3.

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

object (Dimension)

Величина отступа первой строки абзацев на этом уровне вложенности.
indentStart

object (Dimension)

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

object (TextStyle)

Стиль текста маркеров на этом уровне вложенности.
startNumber

integer

Номер первого пункта списка на этом уровне вложенности.

Для списков с буквами и римскими цифрами значение 0 считается равным 1. Если указать значение 0 или 1, то нумерованные списки с буквами и римскими цифрами будут начинаться с a и i соответственно.

Это значение игнорируется для уровней вложенности с неупорядоченными глифами.
Тип глифа, используемого в качестве маркера. Определяет глиф маркера, который заменяет плейсхолдеры в файле glyph_format. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
glyphType

enum (GlyphType)

Тип глифа, используемого в качестве маркера, когда абзацы на этом уровне вложенности упорядочены.

Тип глифа определяет, какой глиф будет использоваться для замены плейсхолдеров в glyphFormat, когда абзацы на этом уровне вложенности упорядочиваются. Например, если уровень вложенности равен 0, glyphFormat – %0., а тип глифа – DECIMAL, то отрисованный глиф заменит плейсхолдер %0 в формате глифа на число, соответствующее порядку элемента списка в списке.
glyphSymbol

string

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

Символ глифа заменяет плейсхолдеры в glyphFormat. Например, если glyphSymbol – это сплошной круг, соответствующий кодовой точке Unicode U+25cf, а glyphFormat – %0, то отрисованный глиф будет сплошным кругом.
Конец взаимоисключающих полей.

BulletAlignment

Типы выравнивания для маркера.

Перечисления
BULLET_ALIGNMENT_UNSPECIFIED Выравнивание маркера не указано.
START Маркер выравнивается по началу пространства, отведенного для его отрисовки. Выравнивание по левому краю для текста, написанного слева направо, и по правому краю в остальных случаях.
CENTER Маркер выравнивается по центру пространства, отведенного для его отрисовки.
END Маркер выравнивается по концу пространства, отведенного для его отрисовки. Выравнивание по правому краю для текста, написанного слева направо, и по левому краю в остальных случаях.

GlyphType

Типы глифов, используемых в качестве маркеров при нумерации абзацев на этом уровне вложенности.

Перечисления
GLYPH_TYPE_UNSPECIFIED Тип глифа не указан или не поддерживается.
NONE Пустая строка.
DECIMAL Число, например 1, 2 или 3.
ZERO_DECIMAL Число, в котором перед однозначными числами стоит ноль, например 01, 02 или 03. Если номер состоит из нескольких цифр, ноль в начале не добавляется.
UPPER_ALPHA Заглавная буква, например A, B или C.
ALPHA Строчная буква, например a, b или c.
UPPER_ROMAN Римское число, написанное заглавными буквами, например I, II или III.
ROMAN Строчное римское число, например i, ii или iii.

SuggestedListProperties

Предлагаемое изменение для объекта "ListProperties".

JSON-представление 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Поля
listProperties

object (ListProperties)

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

object (ListPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте ListProperties были изменены в этом предложении.

ListPropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте ListProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Поля
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Маска, указывающая, какие поля в соответствующем объекте NestingLevel из nestingLevels были изменены в этом предложении.

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

NestingLevelSuggestionState

Маска, указывающая, какие поля в базовом объекте NestingLevel были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Поля
bulletAlignmentSuggested

boolean

Указывает, было ли предложено изменить bulletAlignment.
glyphTypeSuggested

boolean

Указывает, было ли предложено изменить glyphType.
glyphFormatSuggested

boolean

Указывает, было ли предложено изменить glyphFormat.
glyphSymbolSuggested

boolean

Указывает, было ли предложено изменить glyphSymbol.
indentFirstLineSuggested

boolean

Указывает, было ли предложено изменить indentFirstLine.
indentStartSuggested

boolean

Указывает, было ли предложено изменить indentStart.
textStyleSuggestionState

object (TextStyleSuggestionState)

Маска, указывающая, какие поля в text style были изменены в этом предложении.
startNumberSuggested

boolean

Указывает, было ли предложено изменить startNumber.

NamedRanges

Коллекция всех NamedRange в документе, у которых одинаковое имя.

JSON-представление 
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Поля
name

string

Название, общее для всех named ranges.
namedRanges[]

object (NamedRange)

NamedRangeс одинаковыми названиями.

NamedRange

Коллекция Range с одинаковым идентификатором именованного диапазона.

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

Именованный диапазон создается с помощью одного символа Range, а контент, добавленный в него, обычно расширяет диапазон. Однако некоторые изменения в документе могут привести к тому, что диапазон будет разбит на несколько.

Именованные диапазоны не являются частными. Все приложения и соавторы, у которых есть доступ к документу, могут видеть его именованные диапазоны.

JSON-представление 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Поля
namedRangeId

string

Идентификатор именованного диапазона.
name

string

Название именованного диапазона.
ranges[]

object (Range)

Диапазоны, входящие в этот именованный диапазон.

Диапазон

Указывает непрерывный диапазон текста.

JSON-представление 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
Поля
segmentId

string

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

integer

Начальный индекс диапазона (отсчитывается от нуля) в единицах кода UTF-16.

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

integer

Конечный индекс диапазона (не включительно), отсчитываемый от нуля в единицах кода UTF-16.

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

string

Вкладка, на которой находится этот диапазон. Если этот параметр не указан, запрос применяется к первой вкладке.

В документе с одной вкладкой:

  • Если указан, должен совпадать с идентификатором вкладки.

  • Если этот параметр не указан, запрос применяется к одной вкладке.

В документе с несколькими вкладками:

  • Если указано, запрос применяется к определенной вкладке.

  • Если этот параметр не указан, запрос применяется к первой вкладке документа.

InlineObject

Объект, который отображается на одном уровне с текстом. Объект InlineObject содержит EmbeddedObject, например изображение.

JSON-представление 
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
objectId

string

Идентификатор встроенного объекта. Используется для обновления свойств объекта.
inlineObjectProperties

object (InlineObjectProperties)

Свойства этого встроенного объекта.
suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

Предлагаемые изменения свойств встроенного объекта, сгруппированные по идентификатору предложения.
suggestedInsertionId

string

Идентификатор предложенной вставки. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.

InlineObjectProperties

Свойства InlineObject.

JSON-представление 
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Поля
embeddedObject

object (EmbeddedObject)

Встроенный объект этого встроенного объекта.

EmbeddedObject

Встроенный объект в документе.

JSON-представление 
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
}
Поля
title

string

Заголовок встроенного объекта. Атрибуты title и description объединяются для показа альтернативного текста.
description

string

Описание встроенного объекта. Атрибуты title и description объединяются для показа альтернативного текста.
embeddedObjectBorder

object (EmbeddedObjectBorder)

Граница встроенного объекта.
size

object (Size)

Видимый размер изображения после кадрирования.
marginTop

object (Dimension)

Верхнее поле встроенного объекта.
marginBottom

object (Dimension)

Нижнее поле встроенного объекта.
marginRight

object (Dimension)

Размер правого поля встроенного объекта.
marginLeft

object (Dimension)

Левое поле встроенного объекта.
linkedContentReference

object (LinkedContentReference)

Ссылка на внешний связанный источник контента. Например, если встроенный объект является связанной диаграммой, в нем содержится ссылка на исходную диаграмму Google Таблиц.

Если значение не задано, встроенный объект не связан.
Свойства, относящиеся к каждому типу встроенного объекта. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

Свойства встроенного рисунка.
imageProperties

object (ImageProperties)

Свойства изображения.
Конец взаимоисключающих полей.

EmbeddedDrawingProperties

У этого типа нет полей.

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

ImageProperties

Свойства изображения.

JSON-представление 
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Поля
contentUri

string

URI изображения со стандартным сроком действия 30 минут. Этот URI помечен аккаунтом отправителя запроса. Любой, у кого есть URI, может получить доступ к изображению как исходный отправитель запроса. Если настройки доступа к документу изменятся, доступ к изображению может быть потерян.
sourceUri

string

Исходный URI – это URI, который использовался для вставки изображения. URI источника может быть пустым.
brightness

number

Эффект яркости изображения. Значение должно быть в интервале [-1.0, 1.0], где 0 означает отсутствие эффекта.
contrast

number

Контрастность изображения. Значение должно быть в интервале [-1.0, 1.0], где 0 означает отсутствие эффекта.
transparency

number

Эффект прозрачности изображения. Значение должно быть в диапазоне от 0,0 до 1,0, где 0 означает отсутствие эффекта, а 1 – прозрачность.
cropProperties

object (CropProperties)

Свойства кадрирования изображения.
angle

number

Угол поворота изображения по часовой стрелке в радианах.

CropProperties

Свойства кадрирования изображения.

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

  • Если смещение находится в интервале (0, 1), соответствующий край прямоугольника обрезки располагается внутри исходного ограничивающего прямоугольника изображения.
  • Если смещение отрицательное или больше 1, соответствующий край прямоугольника кадрирования будет расположен за пределами исходного ограничивающего прямоугольника изображения.
  • Если все смещения и углы поворота равны 0, изображение не обрезается.
JSON-представление 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Поля
offsetLeft

number

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

number

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

number

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

number

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

number

Угол поворота рамки кадрирования вокруг ее центра по часовой стрелке в радианах. Поворот применяется после смещения.

EmbeddedObjectBorder

Рамка вокруг EmbeddedObject.

JSON-представление 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Поля
color

object (OptionalColor)

Цвет границы.
width

object (Dimension)

Ширина границы.
dashStyle

enum (DashStyle)

Стиль пунктирной линии границы.
propertyState

enum (PropertyState)

Состояние свойства границы.

PropertyState

Возможные состояния объекта.

Перечисления
RENDERED Если для свойства задано состояние RENDERED, то при отрисовке элемента в документе это свойство будет присутствовать. Это значение используется по умолчанию.
NOT_RENDERED Если для свойства задано значение NOT_RENDERED, то при отрисовке элемента в документе соответствующее свойство отсутствует.

LinkedContentReference

Ссылка на внешний связанный источник контента.

JSON-представление 
{

  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
Поля
Ссылка, относящаяся к типу связанного контента. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
sheetsChartReference

object (SheetsChartReference)

Ссылка на связанную диаграмму.
Конец взаимоисключающих полей.

SheetsChartReference

Ссылка на связанную диаграмму, встроенную из Google Таблиц.

JSON-представление 
{
  "spreadsheetId": string,
  "chartId": integer
}
Поля
spreadsheetId

string

Идентификатор таблицы Google, содержащей исходную диаграмму.
chartId

integer

Идентификатор определенной диаграммы в таблице Google, которая встроена в документ.

SuggestedInlineObjectProperties

Предлагаемое изменение для объекта "InlineObjectProperties".

JSON-представление 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Поля
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties, в котором содержатся только изменения, предложенные в этом варианте. Его можно использовать вместе с inlineObjectPropertiesSuggestionState, чтобы узнать, какие поля были изменены и какие значения в них теперь указаны.
inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте InlineObjectProperties были изменены в этом предложении.

InlineObjectPropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте InlineObjectProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Поля
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Маска, указывающая, какие поля в embeddedObject были изменены в этом предложении.

EmbeddedObjectSuggestionState

Маска, указывающая, какие поля в базовом объекте EmbeddedObject были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
Поля
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

Маска, указывающая, какие поля в embeddedDrawingProperties были изменены в этом предложении.
imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Маска, указывающая, какие поля в imageProperties были изменены в этом предложении.
titleSuggested

boolean

Указывает, было ли предложено изменить title.
descriptionSuggested

boolean

Указывает, было ли предложено изменить description.
embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Маска, указывающая, какие поля в embeddedObjectBorder были изменены в этом предложении.
sizeSuggestionState

object (SizeSuggestionState)

Маска, указывающая, какие поля в size были изменены в этом предложении.
marginLeftSuggested

boolean

Указывает, было ли предложено изменить marginLeft.
marginRightSuggested

boolean

Указывает, было ли предложено изменить marginRight.
marginTopSuggested

boolean

Указывает, было ли предложено изменить marginTop.
marginBottomSuggested

boolean

Указывает, было ли предложено изменить marginBottom.
linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Маска, указывающая, какие поля в linkedContentReference были изменены в этом предложении.

EmbeddedDrawingPropertiesSuggestionState

У этого типа нет полей.

Маска, указывающая, какие поля в базовом объекте EmbeddedDrawingProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

ImagePropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте ImageProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Поля
contentUriSuggested

boolean

Указывает, было ли предложено изменить contentUri.
sourceUriSuggested

boolean

Указывает, было ли предложено изменить [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].
brightnessSuggested

boolean

Указывает, было ли предложено изменить значение [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].
contrastSuggested

boolean

Указывает, было ли предложено изменить [контрастность] [google.apps.docs.v1.EmbeddedObject.contrast].
transparencySuggested

boolean

Указывает, было ли предложено изменить значение [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Маска, указывающая, какие поля в cropProperties были изменены в этом предложении.
angleSuggested

boolean

Указывает, было ли предложено изменить значение [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте CropProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Поля
offsetLeftSuggested

boolean

Указывает, было ли предложено изменить offsetLeft.
offsetRightSuggested

boolean

Указывает, было ли предложено изменить offsetRight.
offsetTopSuggested

boolean

Указывает, было ли предложено изменить offsetTop.
offsetBottomSuggested

boolean

Указывает, было ли предложено изменить offsetBottom.
angleSuggested

boolean

Указывает, было ли предложено изменить angle.

EmbeddedObjectBorderSuggestionState

Маска, указывающая, какие поля в базовом объекте EmbeddedObjectBorder были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Поля
colorSuggested

boolean

Указывает, было ли предложено изменить значение атрибута "цвет" [color] [google.apps.docs.v1.EmbeddedBorderObject.color].
widthSuggested

boolean

Указывает, было ли предложено изменить значение атрибута "ширина" [width] [google.apps.docs.v1.EmbeddedBorderObject.width].
dashStyleSuggested

boolean

Указывает, было ли предложено изменить [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].
propertyStateSuggested

boolean

Указывает, было ли предложено изменить [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

Маска, указывающая, какие поля в базовом объекте LinkedContentReference были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Поля
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Маска, указывающая, какие поля в sheetsChartReference были изменены в этом предложении.

SheetsChartReferenceSuggestionState

Маска, указывающая, какие поля в базовом объекте SheetsChartReference были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Поля
spreadsheetIdSuggested

boolean

Указывает, было ли предложено изменить spreadsheetId.
chartIdSuggested

boolean

Указывает, было ли предложено изменить chartId.

PositionedObject

Объект, привязанный к символу Paragraph и расположенный относительно начала абзаца. Объект PositionedObject содержит EmbeddedObject, например изображение.

JSON-представление 
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
objectId

string

Идентификатор объекта с позиционированием.
positionedObjectProperties

object (PositionedObjectProperties)

Свойства этого объекта с позиционированием.
suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

Предлагаемые изменения свойств объекта с позиционированием, сгруппированные по идентификатору предложения.
suggestedInsertionId

string

Идентификатор предложенной вставки. Если поле пустое, то это не рекомендуемая вставка.
suggestedDeletionIds[]

string

Идентификаторы предложенных удалений. Если поле пустое, значит удалять контент не рекомендуется.

PositionedObjectProperties

Свойства PositionedObject.

JSON-представление 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Поля
positioning

object (PositionedObjectPositioning)

Позиция объекта относительно новой строки объекта Paragraph, на который ссылается этот объект.
embeddedObject

object (EmbeddedObject)

Встроенный объект этого позиционированного объекта.

PositionedObjectPositioning

Позиционирование PositionedObject. Позиционированный объект размещается относительно начала Paragraph, к которому он привязан.

JSON-представление 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Поля
layout

enum (PositionedObjectLayout)

Макет этого объекта с позиционированием.
leftOffset

object (Dimension)

Смещение левого края размещенного объекта относительно начала Paragraph, к которому он привязан. Точное положение объекта может зависеть от другого контента в документе и его стиля.
topOffset

object (Dimension)

Смещение верхнего края позиционированного объекта относительно начала Paragraph, к которому он привязан. Точное положение объекта может зависеть от другого контента в документе и его стиля.

PositionedObjectLayout

Возможные макеты [PositionedObject][google.aps.docs.v1.PositionedObject].

Перечисления
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED Макет не указан.
WRAP_TEXT Текст будет обтекать объект.
BREAK_LEFT Текст разбивается так, что размещенный объект находится слева, а текст – справа.
BREAK_RIGHT Текст будет разбит так, что размещенный объект окажется справа, а текст – слева.
BREAK_LEFT_RIGHT Разрывает текст так, чтобы слева и справа от объекта не было текста.
IN_FRONT_OF_TEXT Объект находится перед текстом.
BEHIND_TEXT Объект находится за текстом.

SuggestedPositionedObjectProperties

Предлагаемое изменение для объекта "PositionedObjectProperties".

JSON-представление 
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Поля
positionedObjectProperties

object (PositionedObjectProperties)

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

object (PositionedObjectPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте PositionedObjectProperties были изменены в этом предложении.

PositionedObjectPropertiesSuggestionState

Маска, указывающая, какие поля в базовом объекте PositionedObjectProperties были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Поля
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Маска, указывающая, какие поля в positioning были изменены в этом предложении.
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Маска, указывающая, какие поля в embeddedObject были изменены в этом предложении.

PositionedObjectPositioningSuggestionState

Маска, указывающая, какие поля в базовом объекте PositionedObjectPositioning были изменены в этом предложении. Для каждого поля, для которого задано значение true, есть новое рекомендуемое значение.

JSON-представление 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Поля
layoutSuggested

boolean

Указывает, было ли предложено изменить layout.
leftOffsetSuggested

boolean

Указывает, было ли предложено изменить leftOffset.
topOffsetSuggested

boolean

Указывает, было ли предложено изменить topOffset.

CommentAnchor

Один или несколько адресов в документе, связанных с CommentThreads с одинаковым значением anchorId. Примечание. Несколько якорей могут указывать на одно и то же местоположение.

JSON-представление 
{
  "anchorId": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Поля
anchorId

string

Идентификатор якоря комментария.
ranges[]

object (Range)

Коллекция объектов Range в документе, связанных с этим якорем.

SuggestedDropdownDefinitionProperties

Предложенное изменение свойств определения раскрывающегося списка.

JSON-представление 
{
  "dropdownDefinitionProperties": {
    object (DropdownDefinitionProperties)
  },
  "dropdownDefinitionPropertiesSuggestionState": {
    object (DropdownDefinitionPropertiesSuggestionState)
  }
}
Поля
dropdownDefinitionProperties

object (DropdownDefinitionProperties)

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

object (DropdownDefinitionPropertiesSuggestionState)

Маска, указывающая, какие поля в базовом объекте DropdownDefinitionProperties были изменены в этом предложении.

SuggestionsViewMode

Режим просмотра предложений, примененный к документу, который указывает, как представлены предложенные изменения. В нем можно выбрать, как читать документ: с предложениями, принятыми или отклоненными.

Перечисления
DEFAULT_FOR_CURRENT_ACCESS Режим SuggestionsViewMode, примененный к возвращенному документу, зависит от текущего уровня доступа пользователя. Если у пользователя есть только доступ на просмотр, применяется значение PREVIEW_WITHOUT_SUGGESTIONS. В противном случае будет применена сумма SUGGESTIONS_INLINE. Это режим просмотра предложений по умолчанию.
SUGGESTIONS_INLINE

В возвращенном документе есть встроенные подсказки. Предложенные изменения будут выделены в документе.

Если у пользователя нет разрешения на просмотр предложенных изменений, при попытке получить документ в этом режиме будет возвращена ошибка 403.
PREVIEW_SUGGESTIONS_ACCEPTED

Возвращенный документ – это предварительная версия, в которой приняты все предложенные изменения.

Если у пользователя нет разрешения на просмотр предложенных изменений, при попытке получить документ в этом режиме будет возвращена ошибка 403.
PREVIEW_WITHOUT_SUGGESTIONS Возвращенный документ – это предварительная версия, в которой отклонены все предложенные изменения (если они есть).

CommentsViewMode

Режим просмотра комментариев, примененный к документу, который указывает, включены ли комментарии. В нем можно выбрать, как читать документ: с комментариями и якорями комментариев или без них.

Если вы задали для свойства commentsViewMode какое-либо значение, то для свойства includeTabsContent необходимо задать значение true или использовать маску поля, которая ссылается на поле Document.tabs (или любое вложенное поле).

Комментарии можно вернуть, только если исправления возвращаются в тексте. Если для параметра commentsViewMode задано значение COMMENTS_VIEW_MODE_INCLUDED или COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, для параметра suggestionsViewMode можно задать только значение PREVIEW_WITHOUT_SUGGESTIONS или PREVIEW_SUGGESTIONS_ACCEPTED.

Перечисления
COMMENTS_VIEW_MODE_UNSPECIFIED Не указан режим просмотра комментариев. Применяется сумма COMMENTS_VIEW_MODE_OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS Режим просмотра комментариев, примененный к возвращенному документу, зависит от текущего уровня доступа пользователя. Если у пользователя есть только доступ на просмотр, применяется значение COMMENTS_VIEW_MODE_OMITTED. В противном случае будет применена сумма COMMENTS_VIEW_MODE_INCLUDED.
COMMENTS_VIEW_MODE_OMITTED В возвращенном документе отсутствуют комментарии.
COMMENTS_VIEW_MODE_INCLUDED

В возвращенном документе есть комментарии.

Если у пользователя нет разрешения на просмотр комментариев, при попытке получить документ в этом режиме будет возвращена ошибка 403.

Если задано значение suggestionsViewMode, то также должно быть задано как SUGGESTIONS_INLINE. В противном случае возвращается ошибка 400 (неверный запрос).

CommentThread

Представляет собой одну цепочку комментариев.

JSON-представление 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Поля
commentId

string

Уникальный идентификатор цепочки комментариев.
anchorId

string

Идентификатор CommentAnchor в документе, с которым связана цепочка. Несколько цепочек комментариев могут быть привязаны к одному объекту CommentAnchor.
headPost

object (Post)

Первая запись в цепочке.
replies[]

object (Post)

Ответы на основное сообщение.
status

enum (Status)

Открыта или закрыта цепочка.
Текст из документа, процитированный при создании комментария. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
plainTextQuote

string

Текст, процитированный из документа при создании комментария, в формате обычного текста.
Конец взаимоисключающих полей.

Запись

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

JSON-представление 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedDocument": boolean,
  "fromCopiedDocument": boolean,
  "fromDocumentComparison": boolean,
  "assigneeEmail": string,

  "commentAction": enum (CommentActionType),
  "suggestionAction": enum (SuggestionActionType)
}
Поля
postId

string

Используется только для вывода. Уникальный идентификатор записи.
content

string

Содержимое записи.

Обязательно, если значение commentAction не равно RESOLVE или REOPEN.

Текст будет обрабатываться так же, как комментарии, созданные в редакторе Документов. Она будет работать так же, как и текущая версия, в том числе в отношении форматирования и уведомлений.

Не более 2048 единиц кода UTF-8.
contentHtml

string

Используется только для вывода. Содержимое записи в формате HTML.
author

object (PostAuthor)

Используется только для вывода. Пользователь, создавший запись.
createTime

string (Timestamp format)

Используется только для вывода. Время создания записи.
updateTime

string (Timestamp format)

Используется только для вывода. Время последнего обновления записи.
deleted

boolean

Используется только для вывода. Удалена ли запись. Если в поле true указано значение content, то поля author и должны быть пустыми.
fromImportedDocument

boolean

Используется только для вывода. Является ли запись частью импортированного документа. Это поле нельзя задать напрямую.
fromCopiedDocument

boolean

Используется только для вывода. Указывает, скопирована ли запись из документа. Это поле нельзя задать напрямую.
fromDocumentComparison

boolean

Используется только для вывода. Является ли запись результатом сравнения документов. Это поле нельзя задать напрямую.
assigneeEmail

string

Необязательное поле. Адрес электронной почты пользователя, который назначается ответственным за цепочку в рамках этой записи.

Возвращает ошибку 400 (неверный запрос), если:

  • Родительская цепочка – это CommentThread, у которого в поле headPost не назначен исполнитель.

  • Родительская цепочка – SuggestionThread.

  • Параметр commentAction имеет значение RESOLVE или REOPEN.

  • assigneeEmail превышает 2048 единиц кода UTF-8.
Действие, выполненное при создании публикации. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
commentAction

enum (CommentActionType)

Необязательное поле. Тип действия для записей с комментариями.
suggestionAction

enum (SuggestionActionType)

Используется только для вывода. Тип действия для публикаций с предложениями.
Конец взаимоисключающих полей.

PostAuthor

Представляет пользователя, который написал комментарий или запись с предложением.

JSON-представление 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Поля
displayName

string

Отображаемое имя пользователя. Может отсутствовать, если автор анонимный.
me

boolean

Является ли пользователь аутентифицированным пользователем, выполняющим запрос.
anonymous

boolean

Является ли пользователь анонимным.
user

string

Название ресурса пользователя, который является автором записи. Его также можно использовать для идентификации пользователя в Google People API. Формат: users/{user}. Не заполняется, если поле anonymous имеет значение true или если запись взята из импортированного документа.

CommentActionType

Действие, выполненное с ответом на цепочку комментариев.

Перечисления
COMMENT_ACTION_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
NO_COMMENT_ACTION_CHANGE В этом сообщении нет изменений, связанных с действиями.
RESOLVE Эта запись завершает цепочку.
REOPEN После этого цепочка будет снова открыта.

SuggestionActionType

Действие, выполненное с ответом на цепочку предложений.

Перечисления
SUGGESTION_ACTION_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
NO_SUGGESTION_ACTION_CHANGE В этом сообщении нет изменений, связанных с действиями.
ACCEPT Эта запись принимает предложение.
REJECT Эта запись отклоняет предложение.

Статус

Варианты статуса цепочки комментариев.

Перечисления
STATUS_UNSPECIFIED Значение по умолчанию. Это значение не используется.
OPEN Цепочка комментариев открыта.
RESOLVED Цепочка комментариев помечена как решенная.

SuggestionThread

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

JSON-представление 
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
Поля
suggestionId

string

Уникальный идентификатор предложения.
headPost

object (Post)

Первая запись в цепочке.
replies[]

object (Post)

Ответы на основное сообщение.
status

enum (Status)

Открыта ли цепочка, принята или отклонена.
summaryText

string

Сводка предложенных изменений в документе в виде обычного текста. Может быть пустым.
summaryHtml

string

Краткое описание предложенных изменений в документе в формате HTML. Может быть пустым.

Статус

Варианты статуса цепочки предложений.

Перечисления
STATUS_UNSPECIFIED Значение по умолчанию. Это значение не используется.
OPEN Цепочка предложений открыта.
ACCEPTED Цепочка предложений принята.
REJECTED Цепочка предложений отклонена.

Методы

batchUpdate

 Применяет к документу одно или несколько обновлений.

create

 Создает пустой документ с названием, указанным в запросе.

get

 Получает последнюю версию указанного документа.