REST Resource: documents

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

Документ Google Docs.

JSON-представление 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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 .

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 или не задано, это поле содержит информацию о первой вкладке документа.

Вкладка

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

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

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
Поля
tabProperties

object ( TabProperties )

Свойства вкладки, такие как идентификатор и заголовок.

childTabs[]

object ( Tab )

Дочерние вкладки, вложенные в данную вкладку.

content поля объединения. content вкладки может быть только одним из следующих:
documentTab

object ( DocumentTab )

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

TabProperties

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

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

string

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

title

string

Видимое пользователю название вкладки.

parentTabId

string

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

index

integer

Нулевой индекс вкладки внутри родительской вкладки.

nestingLevel

integer

Только вывод. Глубина вкладки в документе. Вкладки корневого уровня начинаются с 0.

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)
    },
    ...
  }
}
Поля
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 ))

Размещенные объекты на вкладке документа, обозначенные идентификатором объекта.

Тело

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

Тело обычно содержит все содержимое документа, за исключением headers и footers и footnotes .

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

object ( StructuralElement )

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

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

StructuralElement

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

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

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}
Поля
startIndex

integer

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

endIndex

integer

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

content поля объединения. Содержимое структурного элемента. content может быть только одним из следующих:
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 описывает содержимое Paragraph .

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

  // Union field content can be only one of the following:
  "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)
  }
  // End of list of possible types for union field content.
}
Поля
startIndex

integer

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

endIndex

integer

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

content поля объединения. Содержимое элемента абзаца. content может быть только одним из следующих:
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 )

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

TextRun

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

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

string

Текст этого выпуска.

Любые нетекстовые элементы в строке заменяются символом Unicode U+E907.

suggestedInsertionIds[]

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

Стиль текста этого выпуска.

suggestedTextStyleChanges

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

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

TextStyle

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

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

  • TextStyle текста в Paragraph наследуется от соответствующего named style type абзаца.
  • TextStyle named style наследуется от normal text именованного стиля.
  • TextStyle normal text с именем style наследует стиль текста по умолчанию в редакторе Docs.
  • TextStyle элемента 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 .

Дополнительный цвет

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

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.
  • Если текст жирный и его жирность больше или равна 400 , но меньше 700 , визуализируемый жирность составит 700 .
  • Если вес больше или равен 700 , то отображаемый вес равен весу.
  • Если текст не жирный, отображаемая толщина равна толщине.

Смещение базовой линии

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

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

ПредложенныйТекстСтиль

Предлагаемое изменение 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 .

Автотекст

Элемент 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 ))

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

Тип

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

Перечисления
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 )

Стиль текста этого PageBreak.

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

suggestedTextStyleChanges

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

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

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, определяемый идентификатором предложения.

СноскаСсылка

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 )

Стиль текста этой сноски.

suggestedTextStyleChanges

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

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

Горизонтальное правило

ParagraphElement представляющий горизонтальную линию.

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

string

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

suggestedDeletionIds[]

string

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

textStyle

object ( TextStyle )

Стиль текста этого горизонтального правила.

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

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 , если он есть (например, если это файл на Диске).

Стиль абзаца

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

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

  • ParagraphStyle для Paragraph наследует named style type абзаца.
  • ParagraphStyle named style наследует от normal text именованного стиля.
  • ParagraphStyle normal text с именем style наследует стиль абзаца по умолчанию в редакторе Docs.
  • ParagraphStyle элемента 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,0. Если не задано, значение наследуется от родительского элемента.

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 bad request.

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 Абзац выравнивается по началу строки. Для текста LTR — по левому краю, в противном случае — по правому краю.
CENTER Абзац выравнивается по центру.
END Абзац выравнивается по концу строки. Для текста с LTR — по правому краю, в противном случае — по левому краю.
JUSTIFIED Абзац обоснован.

ContentDirection

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

Перечисления
CONTENT_DIRECTION_UNSPECIFIED Направление содержания не определено.
LEFT_TO_RIGHT Содержимое идет слева направо.
RIGHT_TO_LEFT Содержимое идет справа налево.

SpacingMode

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

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

Граница абзаца

Граница вокруг абзаца.

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 )

The dash style of the border.

DashStyle

The kinds of dashes with which linear geometry can be rendered. These values are based on the "ST_PresetLineDashVal" simple type described in section 20.1.10.49 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 5th edition .

Перечисления
DASH_STYLE_UNSPECIFIED Unspecified dash style.
SOLID Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'. This is the default dash style.
DOT Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.
DASH Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.

TabStop

A tab stop within a paragraph.

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

object ( Dimension )

The offset between this tab stop and the start margin.

alignment

enum ( TabStopAlignment )

The alignment of this tab stop. If unset, the value defaults to START .

TabStopAlignment

The alignment of the tab stop.

Перечисления
TAB_STOP_ALIGNMENT_UNSPECIFIED The tab stop alignment is unspecified.
START The tab stop is aligned to the start of the line. This is the default.
CENTER The tab stop is aligned to the center of the line.
END The tab stop is aligned to the end of the line.

Затенение

The shading of a paragraph.

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

object ( OptionalColor )

The background color of this paragraph shading.

SuggestedParagraphStyle

A suggested change to a ParagraphStyle .

JSON representation 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Поля
paragraphStyle

object ( ParagraphStyle )

A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraphStyleSuggestionState to see which fields have changed and their new values.

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.

ParagraphStyleSuggestionState

A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

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

Indicates if there was a suggested change to headingId .

namedStyleTypeSuggested

boolean

Indicates if there was a suggested change to namedStyleType .

alignmentSuggested

boolean

Indicates if there was a suggested change to alignment .

lineSpacingSuggested

boolean

Indicates if there was a suggested change to lineSpacing .

directionSuggested

boolean

Indicates if there was a suggested change to direction .

spacingModeSuggested

boolean

Indicates if there was a suggested change to spacingMode .

spaceAboveSuggested

boolean

Indicates if there was a suggested change to spaceAbove .

spaceBelowSuggested

boolean

Indicates if there was a suggested change to spaceBelow .

borderBetweenSuggested

boolean

Indicates if there was a suggested change to borderBetween .

borderTopSuggested

boolean

Indicates if there was a suggested change to borderTop .

borderBottomSuggested

boolean

Indicates if there was a suggested change to borderBottom .

borderLeftSuggested

boolean

Indicates if there was a suggested change to borderLeft .

borderRightSuggested

boolean

Indicates if there was a suggested change to borderRight .

indentFirstLineSuggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indentStartSuggested

boolean

Indicates if there was a suggested change to indentStart .

indentEndSuggested

boolean

Indicates if there was a suggested change to indentEnd .

keepLinesTogetherSuggested

boolean

Indicates if there was a suggested change to keepLinesTogether .

keepWithNextSuggested

boolean

Indicates if there was a suggested change to keepWithNext .

avoidWidowAndOrphanSuggested

boolean

Indicates if there was a suggested change to avoidWidowAndOrphan .

shadingSuggestionState

object ( ShadingSuggestionState )

A mask that indicates which of the fields in shading have been changed in this suggestion.

pageBreakBeforeSuggested

boolean

Indicates if there was a suggested change to pageBreakBefore .

ShadingSuggestionState

A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value.

JSON representation 
{
  "backgroundColorSuggested": boolean
}
Поля
backgroundColorSuggested

boolean

Indicates if there was a suggested change to the Shading .

Пуля

Describes the bullet of a paragraph.

JSON representation 
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Поля
listId

string

The ID of the list this paragraph belongs to.

nestingLevel

integer

The nesting level of this paragraph in the list.

textStyle

object ( TextStyle )

The paragraph-specific text style applied to this bullet.

SuggestedBullet

A suggested change to a Bullet .

JSON representation 
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Поля
bullet

object ( Bullet )

A Bullet that only includes the changes made in this suggestion. This can be used along with the bulletSuggestionState to see which fields have changed and their new values.

bulletSuggestionState

object ( BulletSuggestionState )

A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.

BulletSuggestionState

A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Поля
listIdSuggested

boolean

Indicates if there was a suggested change to the listId .

nestingLevelSuggested

boolean

Indicates if there was a suggested change to the nestingLevel .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

ObjectReferences

A collection of object IDs.

JSON representation 
{
  "objectIds": [
    string
  ]
}
Поля
objectIds[]

string

The object IDs.

РазделBreak

A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle . A section break represents the start of a new section, and the section style applies to the section after the section break.

The document body always begins with a section break.

JSON representation 
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Поля
suggestedInsertionIds[]

string

The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

sectionStyle

object ( SectionStyle )

The style of the section after this section break.

SectionStyle

The styling that applies to a section.

JSON representation 
{
  "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 )

The section's columns properties.

If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns.

When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.

columnSeparatorStyle

enum ( ColumnSeparatorStyle )

The style of column separators.

This style can be set even when there's one column in the section.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

contentDirection

enum ( ContentDirection )

The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT .

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginTop

object ( Dimension )

The top page margin of the section. If unset, the value defaults to marginTop from DocumentStyle.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginBottom

object ( Dimension )

The bottom page margin of the section. If unset, the value defaults to marginBottom from DocumentStyle.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginRight

object ( Dimension )

The right page margin of the section. If unset, the value defaults to marginRight from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginLeft

object ( Dimension )

The left page margin of the section. If unset, the value defaults to marginLeft from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

marginHeader

object ( Dimension )

The header margin of the section. If unset, the value defaults to marginHeader from DocumentStyle. If updated, useCustomHeaderFooterMargins is set to true on DocumentStyle. The value of useCustomHeaderFooterMargins on DocumentStyle indicates if a header margin is being respected for this section.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

sectionType

enum ( SectionType )

Output only. The type of section.

defaultHeaderId

string

The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's defaultHeaderId .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

firstPageHeaderId

string

The ID of the header used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the defaultHeaderId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageHeaderId .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

firstPageFooterId

string

The ID of the footer used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the defaultFooterId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageFooterId .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

evenPageHeaderId

string

The ID of the header used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the defaultHeaderId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageHeaderId .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

evenPageFooterId

string

The ID of the footer used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the defaultFooterId . If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageFooterId .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

useFirstPageHeaderFooter

boolean

Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's useFirstPageHeaderFooter for the first section. If the value is unset for subsequent sectors, it should be interpreted as false.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

pageNumberStart

integer

The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak , refer to DocumentStyle's pageNumberStart .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

flipPageOrientation

boolean

Optional. Indicates whether to flip the dimensions of DocumentStyle's pageSize for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flipPageOrientation .

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

SectionColumnProperties

Properties that apply to a section's column.

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

object ( Dimension )

Output only. The width of the column.

paddingEnd

object ( Dimension )

The padding at the end of the column.

ColumnSeparatorStyle

The style of column separators between columns.

Перечисления
COLUMN_SEPARATOR_STYLE_UNSPECIFIED An unspecified column separator style.
NONE No column separator lines between columns.
BETWEEN_EACH_COLUMN Renders a column separator line between each column.

SectionType

Represents how the start of the current section is positioned relative to the previous section.

Перечисления
SECTION_TYPE_UNSPECIFIED The section type is unspecified.
CONTINUOUS The section starts immediately after the last paragraph of the previous section.
NEXT_PAGE The section starts on the next page.

Стол

A StructuralElement representing a table.

JSON representation 
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Поля
rows

integer

Number of rows in the table.

columns

integer

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

It's possible for a table to be non-rectangular, so some rows may have a different number of cells.

tableRows[]

object ( TableRow )

The contents and style of each row.

suggestedInsertionIds[]

string

The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

tableStyle

object ( TableStyle )

The style of the table.

TableRow

The contents and style of a row in a Table .

JSON representation 
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Поля
startIndex

integer

The zero-based start index of this row, in UTF-16 code units.

endIndex

integer

The zero-based end index of this row, exclusive, in UTF-16 code units.

tableCells[]

object ( TableCell )

The contents and style of each cell in this row.

It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

tableRowStyle

object ( TableRowStyle )

The style of the table row.

suggestedTableRowStyleChanges

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

The suggested style changes to this row, keyed by suggestion ID.

TableCell

The contents and style of a cell in a Table .

JSON representation 
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Поля
startIndex

integer

The zero-based start index of this cell, in UTF-16 code units.

endIndex

integer

The zero-based end index of this cell, exclusive, in UTF-16 code units.

content[]

object ( StructuralElement )

The content of the cell.

tableCellStyle

object ( TableCellStyle )

The style of the cell.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

suggestedTableCellStyleChanges

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

The suggested changes to the table cell style, keyed by suggestion ID.

TableCellStyle

The style of a TableCell .

Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.

JSON representation 
{
  "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

The column span of the cell.

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

backgroundColor

object ( OptionalColor )

The background color of the cell.

borderLeft

object ( TableCellBorder )

The left border of the cell.

borderRight

object ( TableCellBorder )

The right border of the cell.

borderTop

object ( TableCellBorder )

The top border of the cell.

borderBottom

object ( TableCellBorder )

The bottom border of the cell.

paddingLeft

object ( Dimension )

The left padding of the cell.

paddingRight

object ( Dimension )

The right padding of the cell.

paddingTop

object ( Dimension )

The top padding of the cell.

paddingBottom

object ( Dimension )

The bottom padding of the cell.

contentAlignment

enum ( ContentAlignment )

The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.

TableCellBorder

A border around a table cell.

Table cell borders cannot be transparent. To hide a table cell border, make its width 0.

JSON representation 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Поля
color

object ( OptionalColor )

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

This color cannot be transparent.

width

object ( Dimension )

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

dashStyle

enum ( DashStyle )

The dash style of the border.

Выравнивание содержимого

The types of content alignment.

Derived from a subset of the values of the "ST_TextAnchoringType" simple type in section 20.1.10.60 of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 5th edition .

Перечисления
CONTENT_ALIGNMENT_UNSPECIFIED An unspecified content alignment. The content alignment is inherited from the parent if one exists.
CONTENT_ALIGNMENT_UNSUPPORTED An unsupported content alignment.
TOP An alignment that aligns the content to the top of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 't'.
MIDDLE An alignment that aligns the content to the middle of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.
BOTTOM An alignment that aligns the content to the bottom of the content holder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'.

SuggestedTableCellStyle

A suggested change to a TableCellStyle .

JSON representation 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Поля
tableCellStyle

object ( TableCellStyle )

A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the tableCellStyleSuggestionState to see which fields have changed and their new values.

tableCellStyleSuggestionState

object ( TableCellStyleSuggestionState )

A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.

TableCellStyleSuggestionState

A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "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

Indicates if there was a suggested change to rowSpan .

columnSpanSuggested

boolean

Indicates if there was a suggested change to columnSpan .

backgroundColorSuggested

boolean

Indicates if there was a suggested change to backgroundColor .

borderLeftSuggested

boolean

Indicates if there was a suggested change to borderLeft .

borderRightSuggested

boolean

Indicates if there was a suggested change to borderRight .

borderTopSuggested

boolean

Indicates if there was a suggested change to borderTop .

borderBottomSuggested

boolean

Indicates if there was a suggested change to borderBottom .

paddingLeftSuggested

boolean

Indicates if there was a suggested change to paddingLeft .

paddingRightSuggested

boolean

Indicates if there was a suggested change to paddingRight .

paddingTopSuggested

boolean

Indicates if there was a suggested change to paddingTop .

paddingBottomSuggested

boolean

Indicates if there was a suggested change to paddingBottom .

contentAlignmentSuggested

boolean

Indicates if there was a suggested change to contentAlignment .

TableRowStyle

Styles that apply to a table row.

JSON representation 
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Поля
minRowHeight

object ( Dimension )

The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.

tableHeader

boolean

Whether the row is a table header.

preventOverflow

boolean

Whether the row cannot overflow across page or column boundaries.

SuggestedTableRowStyle

A suggested change to a TableRowStyle .

JSON representation 
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Поля
tableRowStyle

object ( TableRowStyle )

A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the tableRowStyleSuggestionState to see which fields have changed and their new values.

tableRowStyleSuggestionState

object ( TableRowStyleSuggestionState )

A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.

TableRowStyleSuggestionState

A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "minRowHeightSuggested": boolean
}
Поля
minRowHeightSuggested

boolean

Indicates if there was a suggested change to minRowHeight .

TableStyle

Styles that apply to a table.

JSON representation 
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Поля
tableColumnProperties[]

object ( TableColumnProperties )

The properties of each column.

Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's tableRowStyle .

TableColumnProperties

The properties of a column in a table.

JSON representation 
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Поля
widthType

enum ( WidthType )

The width type of the column.

width

object ( Dimension )

The width of the column. Set when the column's widthType is FIXED_WIDTH .

WidthType

The type of width of the column.

Перечисления
WIDTH_TYPE_UNSPECIFIED The column width type is unspecified.
EVENLY_DISTRIBUTED

The column width is evenly distributed among the other evenly distributed columns.

The width of the column is automatically determined and will have an equal portion of the width remaining for the table after accounting for all columns with specified widths.

FIXED_WIDTH A fixed column width. The [width][ google.apps.docs.v1.TableColumnProperties.width property contains the column's width.

Оглавление

A StructuralElement representing a table of contents.

JSON representation 
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Поля
content[]

object ( StructuralElement )

The content of the table of contents.

suggestedInsertionIds[]

string

The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Сноска

A document footnote.

JSON representation 
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Поля
footnoteId

string

The ID of the footnote.

content[]

object ( StructuralElement )

The contents of the footnote.

The indexes for a footnote's content begin at zero.

DocumentStyle

The style of the document.

JSON representation 
{
  "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 )

The background of the document. Documents cannot have a transparent background color.

defaultHeaderId

string

The ID of the default header. If not set, there's no default header.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

evenPageHeaderId

string

The ID of the header used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on even pages. If not set, there's no even page header.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

evenPageFooterId

string

The ID of the footer used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on even pages. If not set, there's no even page footer.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

firstPageHeaderId

string

The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on the first page. If not set, there's no first page header.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

firstPageFooterId

string

The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on the first page. If not set, there's no first page footer.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

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

useFirstPageHeaderFooter

boolean

Indicates whether to use the first page header / footer IDs for the first page.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

useEvenPageHeaderFooter

boolean

Indicates whether to use the even page header / footer IDs for the even pages.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

pageNumberStart

integer

The page number from which to start counting the number of pages.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

marginTop

object ( Dimension )

The top page margin.

Updating the top page margin on the document style clears the top page margin on all section styles.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

marginBottom

object ( Dimension )

The bottom page margin.

Updating the bottom page margin on the document style clears the bottom page margin on all section styles.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

marginRight

object ( Dimension )

The right page margin.

Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

marginLeft

object ( Dimension )

The left page margin.

Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

pageSize

object ( Size )

The size of a page in the document.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

marginHeader

object ( Dimension )

The amount of space between the top of the page and the contents of the header.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

flipPageOrientation

boolean

Optional. Indicates whether to flip the dimensions of the pageSize , which allows changing the page orientation between portrait and landscape.

If [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] is PAGELESS , this property will not be rendered.

documentFormat

object ( DocumentFormat )

Specifies document-level format settings, such as the document mode (pages vs pageless).

Фон

Represents the background of a document.

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

object ( OptionalColor )

The background color.

Размер

A width and height.

JSON representation 
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Поля
height

object ( Dimension )

The height of the object.

width

object ( Dimension )

The width of the object.

DocumentFormat

Represents document-level format settings.

JSON representation 
{
  "documentMode": enum (DocumentMode)
}
Поля
documentMode

enum ( DocumentMode )

Whether the document has pages or is pageless.

DocumentMode

Whether the document has pages or is pageless.

Перечисления
DOCUMENT_MODE_UNSPECIFIED The document mode is unspecified.
PAGES The document has pages.
PAGELESS The document is pageless.

SuggestedDocumentStyle

A suggested change to the DocumentStyle .

JSON representation 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Поля
documentStyle

object ( DocumentStyle )

A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the documentStyleSuggestionState to see which fields have changed and their new values.

documentStyleSuggestionState

object ( DocumentStyleSuggestionState )

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion.

DocumentStyleSuggestionState

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "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 )

A mask that indicates which of the fields in background have been changed in this suggestion.

defaultHeaderIdSuggested

boolean

Indicates if there was a suggested change to defaultHeaderId .

evenPageHeaderIdSuggested

boolean

Indicates if there was a suggested change to evenPageHeaderId .

evenPageFooterIdSuggested

boolean

Indicates if there was a suggested change to evenPageFooterId .

firstPageHeaderIdSuggested

boolean

Indicates if there was a suggested change to firstPageHeaderId .

firstPageFooterIdSuggested

boolean

Indicates if there was a suggested change to firstPageFooterId .

useFirstPageHeaderFooterSuggested

boolean

Indicates if there was a suggested change to useFirstPageHeaderFooter .

useEvenPageHeaderFooterSuggested

boolean

Indicates if there was a suggested change to useEvenPageHeaderFooter .

pageNumberStartSuggested

boolean

Indicates if there was a suggested change to pageNumberStart .

marginTopSuggested

boolean

Indicates if there was a suggested change to marginTop .

marginBottomSuggested

boolean

Indicates if there was a suggested change to marginBottom .

marginRightSuggested

boolean

Indicates if there was a suggested change to marginRight .

marginLeftSuggested

boolean

Indicates if there was a suggested change to marginLeft .

pageSizeSuggestionState

object ( SizeSuggestionState )

A mask that indicates which of the fields in [size] [google.apps.docs.v1.DocumentStyle.size] have been changed in this suggestion.

marginHeaderSuggested

boolean

Indicates if there was a suggested change to marginHeader .

flipPageOrientationSuggested

boolean

Optional. Indicates if there was a suggested change to flipPageOrientation .

BackgroundSuggestionState

A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value.

JSON representation 
{
  "backgroundColorSuggested": boolean
}
Поля
backgroundColorSuggested

boolean

Indicates whether the current background color has been modified in this suggestion.

SizeSuggestionState

A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value.

JSON representation 
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Поля
heightSuggested

boolean

Indicates if there was a suggested change to height .

widthSuggested

boolean

Indicates if there was a suggested change to width .

NamedStyles

The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles.

JSON representation 
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Поля
styles[]

object ( NamedStyle )

The named styles.

There's an entry for each of the possible named style types .

NamedStyle

A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.

JSON representation 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Поля
namedStyleType

enum ( NamedStyleType )

The type of this named style.

textStyle

object ( TextStyle )

The text style of this named style.

paragraphStyle

object ( ParagraphStyle )

The paragraph style of this named style.

SuggestedNamedStyles

A suggested change to the NamedStyles .

JSON representation 
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Поля
namedStyles

object ( NamedStyles )

A NamedStyles that only includes the changes made in this suggestion. This can be used along with the namedStylesSuggestionState to see which fields have changed and their new values.

namedStylesSuggestionState

object ( NamedStylesSuggestionState )

A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion.

NamedStylesSuggestionState

The suggestion state of a NamedStyles message.

JSON representation 
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Поля
stylesSuggestionStates[]

object ( NamedStyleSuggestionState )

A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion.

The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.

NamedStyleSuggestionState

A suggestion state of a NamedStyle message.

JSON representation 
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Поля
namedStyleType

enum ( NamedStyleType )

The named style type that this suggestion state corresponds to.

This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

paragraphStyleSuggestionState

object ( ParagraphStyleSuggestionState )

A mask that indicates which of the fields in paragraph style have been changed in this suggestion.

Список

A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet .

JSON representation 
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
listProperties

object ( ListProperties )

The properties of the list.

suggestedListPropertiesChanges

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

The suggested changes to the list properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this list.

ListProperties

The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.

JSON representation 
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Поля
nestingLevels[]

object ( NestingLevel )

Describes the properties of the bullets at the associated level.

A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.

NestingLevel

Contains properties describing the look and feel of a list bullet at a given level of nesting.

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

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
Поля
bulletAlignment

enum ( BulletAlignment )

The alignment of the bullet within the space allotted for rendering the bullet.

glyphFormat

string

The format string used by bullets at this level of nesting.

The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyphType or glyphSymbol . The placeholders follow the pattern %[nestingLevel] . Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern <prefix>%[nestingLevel]<suffix> . Note that the prefix and suffix are optional and can be arbitrary strings.

For example, the glyph format %0. indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format %0. at nesting level 0 will result in a list with rendered glyphs

A.

B.

C.

The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of %0. at nesting level 0 and a glyph format of %0.%1. at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs

1.

2.

2.1.

2.2.

3.

For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.

indentFirstLine

object ( Dimension )

The amount of indentation for the first line of paragraphs at this level of nesting.

indentStart

object ( Dimension )

The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.

textStyle

object ( TextStyle )

The text style of bullets at this level of nesting.

startNumber

integer

The number of the first list item at this nesting level.

A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at a and i respectively.

This value is ignored for nesting levels with unordered glyphs.

Union field glyph_kind . The kind of glyph used by bullets. This defines the bullet glyph that replaces the placeholders in the glyph_format . glyph_kind can be only one of the following:
glyphType

enum ( GlyphType )

The type of glyph used by bullets when paragraphs at this level of nesting is ordered.

The glyph type determines the type of glyph used to replace placeholders within the glyphFormat when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyphFormat is %0. and the glyph type is DECIMAL , then the rendered glyph would replace the placeholder %0 in the glyph format with a number corresponding to the list item's order within the list.

glyphSymbol

string

A custom glyph symbol used by bullets when paragraphs at this level of nesting is unordered.

The glyph symbol replaces placeholders within the glyphFormat . For example, if the glyphSymbol is the solid circle corresponding to Unicode U+25cf code point and the glyphFormat is %0 , the rendered glyph would be the solid circle.

BulletAlignment

The types of alignment for a bullet.

Перечисления
BULLET_ALIGNMENT_UNSPECIFIED The bullet alignment is unspecified.
START The bullet is aligned to the start of the space allotted for rendering the bullet. Left-aligned for LTR text, right-aligned otherwise.
CENTER The bullet is aligned to the center of the space allotted for rendering the bullet.
END The bullet is aligned to the end of the space allotted for rendering the bullet. Right-aligned for LTR text, left-aligned otherwise.

GlyphType

The types of glyphs used by bullets when paragraphs at this level of nesting is ordered.

Перечисления
GLYPH_TYPE_UNSPECIFIED The glyph type is unspecified or unsupported.
NONE Пустая строка.
DECIMAL A number, like 1 , 2 , or 3 .
ZERO_DECIMAL A number where single digit numbers are prefixed with a zero, like 01 , 02 , or 03 . Numbers with more than one digit are not prefixed with a zero.
UPPER_ALPHA An uppercase letter, like A , B , or C .
ALPHA A lowercase letter, like a , b , or c .
UPPER_ROMAN An uppercase Roman numeral, like I , II , or III .
ROMAN A lowercase Roman numeral, like i , ii , or iii .

SuggestedListProperties

A suggested change to ListProperties .

JSON representation 
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Поля
listProperties

object ( ListProperties )

A ListProperties that only includes the changes made in this suggestion. This can be used along with the listPropertiesSuggestionState to see which fields have changed and their new values.

listPropertiesSuggestionState

object ( ListPropertiesSuggestionState )

A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.

ListPropertiesSuggestionState

A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Поля
nestingLevelsSuggestionStates[]

object ( NestingLevelSuggestionState )

A mask that indicates which of the fields on the corresponding NestingLevel in nestingLevels have been changed in this suggestion.

The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.

NestingLevelSuggestionState

A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Поля
bulletAlignmentSuggested

boolean

Indicates if there was a suggested change to bulletAlignment .

glyphTypeSuggested

boolean

Indicates if there was a suggested change to glyphType .

glyphFormatSuggested

boolean

Indicates if there was a suggested change to glyphFormat .

glyphSymbolSuggested

boolean

Indicates if there was a suggested change to glyphSymbol .

indentFirstLineSuggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indentStartSuggested

boolean

Indicates if there was a suggested change to indentStart .

textStyleSuggestionState

object ( TextStyleSuggestionState )

A mask that indicates which of the fields in text style have been changed in this suggestion.

startNumberSuggested

boolean

Indicates if there was a suggested change to startNumber .

NamedRanges

A collection of all the NamedRange s in the document that share a given name.

JSON representation 
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Поля
name

string

The name that all the named ranges share.

namedRanges[]

object ( NamedRange )

The NamedRange s that share the same name.

NamedRange

A collection of Range s with the same named range ID.

Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID.

A named range is created with a single Range , and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges.

Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.

JSON representation 
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Поля
namedRangeId

string

The ID of the named range.

name

string

The name of the named range.

ranges[]

object ( Range )

The ranges that belong to this named range.

Диапазон

Specifies a contiguous range of text.

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

string

The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.

startIndex

integer

The zero-based start index of this range, in UTF-16 code units.

In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

endIndex

integer

The zero-based end index of this range, exclusive, in UTF-16 code units.

In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.

tabId

string

The tab that contains this range. When omitted, the request applies to the first tab.

In a document containing a single tab:

  • If provided, must match the singular tab's ID.

  • If omitted, the request applies to the singular tab.

In a document containing multiple tabs:

  • If provided, the request applies to the specified tab.

  • If omitted, the request applies to the first tab in the document.

InlineObject

An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.

JSON representation 
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
objectId

string

The ID of this inline object. Can be used to update an object's properties.

inlineObjectProperties

object ( InlineObjectProperties )

The properties of this inline object.

suggestedInlineObjectPropertiesChanges

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

The suggested changes to the inline object properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

InlineObjectProperties

Properties of an InlineObject .

JSON representation 
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Поля
embeddedObject

object ( EmbeddedObject )

The embedded object of this inline object.

EmbeddedObject

An embedded object in the document.

JSON representation 
{
  "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)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
Поля
title

string

The title of the embedded object. The title and description are both combined to display alt text.

description

string

The description of the embedded object. The title and description are both combined to display alt text.

embeddedObjectBorder

object ( EmbeddedObjectBorder )

The border of the embedded object.

size

object ( Size )

The visible size of the image after cropping.

marginTop

object ( Dimension )

The top margin of the embedded object.

marginBottom

object ( Dimension )

The bottom margin of the embedded object.

marginRight

object ( Dimension )

The right margin of the embedded object.

marginLeft

object ( Dimension )

The left margin of the embedded object.

linkedContentReference

object ( LinkedContentReference )

A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart.

If unset, then the embedded object is not linked.

Union field properties . The properties that are specific to each embedded object type. properties can be only one of the following:
embeddedDrawingProperties

object ( EmbeddedDrawingProperties )

The properties of an embedded drawing.

imageProperties

object ( ImageProperties )

The properties of an image.

EmbeddedDrawingProperties

Этот тип не имеет полей.

The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.

ImageProperties

The properties of an image.

JSON representation 
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Поля
contentUri

string

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

sourceUri

string

The source URI is the URI used to insert the image. The source URI can be empty.

brightness

number

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

contrast

number

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

transparency

number

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.

cropProperties

object ( CropProperties )

The crop properties of the image.

angle

number

The clockwise rotation angle of the image, in radians.

CropProperties

The crop properties of an image.

The crop rectangle is represented using fractional offsets from the original content's 4 edges.

  • If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle.
  • If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle.
  • If all offsets and rotation angles are 0, the image is not cropped.
JSON representation 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Поля
offsetLeft

number

The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.

offsetRight

number

The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.

offsetTop

number

The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.

offsetBottom

number

The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.

angle

number

The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.

EmbeddedObjectBorder

A border around an EmbeddedObject .

JSON representation 
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Поля
color

object ( OptionalColor )

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

width

object ( Dimension )

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

dashStyle

enum ( DashStyle )

The dash style of the border.

propertyState

enum ( PropertyState )

The property state of the border property.

PropertyState

The possible states of a property.

Перечисления
RENDERED If a property's state is RENDERED, then the element has the corresponding property when rendered in the document. This is the default value.
NOT_RENDERED If a property's state is NOT_RENDERED, then the element does not have the corresponding property when rendered in the document.

LinkedContentReference

A reference to the external linked source content.

JSON representation 
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
Поля
Union field reference . The reference specific to the type of linked content. reference can be only one of the following:
sheetsChartReference

object ( SheetsChartReference )

A reference to the linked chart.

SheetsChartReference

A reference to a linked chart embedded from Google Sheets.

JSON representation 
{
  "spreadsheetId": string,
  "chartId": integer
}
Поля
spreadsheetId

string

The ID of the Google Sheets spreadsheet that contains the source chart.

chartId

integer

The ID of the specific chart in the Google Sheets spreadsheet that's embedded.

SuggestedInlineObjectProperties

A suggested change to InlineObjectProperties .

JSON representation 
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Поля
inlineObjectProperties

object ( InlineObjectProperties )

An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inlineObjectPropertiesSuggestionState to see which fields have changed and their new values.

inlineObjectPropertiesSuggestionState

object ( InlineObjectPropertiesSuggestionState )

A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.

InlineObjectPropertiesSuggestionState

A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Поля
embeddedObjectSuggestionState

object ( EmbeddedObjectSuggestionState )

A mask that indicates which of the fields in embeddedObject have been changed in this suggestion.

EmbeddedObjectSuggestionState

A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "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 )

A mask that indicates which of the fields in embeddedDrawingProperties have been changed in this suggestion.

imagePropertiesSuggestionState

object ( ImagePropertiesSuggestionState )

A mask that indicates which of the fields in imageProperties have been changed in this suggestion.

titleSuggested

boolean

Indicates if there was a suggested change to title .

descriptionSuggested

boolean

Indicates if there was a suggested change to description .

embeddedObjectBorderSuggestionState

object ( EmbeddedObjectBorderSuggestionState )

A mask that indicates which of the fields in embeddedObjectBorder have been changed in this suggestion.

sizeSuggestionState

object ( SizeSuggestionState )

A mask that indicates which of the fields in size have been changed in this suggestion.

marginLeftSuggested

boolean

Indicates if there was a suggested change to marginLeft .

marginRightSuggested

boolean

Indicates if there was a suggested change to marginRight .

marginTopSuggested

boolean

Indicates if there was a suggested change to marginTop .

marginBottomSuggested

boolean

Indicates if there was a suggested change to marginBottom .

linkedContentReferenceSuggestionState

object ( LinkedContentReferenceSuggestionState )

A mask that indicates which of the fields in linkedContentReference have been changed in this suggestion.

EmbeddedDrawingPropertiesSuggestionState

Этот тип не имеет полей.

A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

ImagePropertiesSuggestionState

A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Поля
contentUriSuggested

boolean

Indicates if there was a suggested change to contentUri .

sourceUriSuggested

boolean

Indicates if there was a suggested change to [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Indicates if there was a suggested change to [brightness] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Indicates if there was a suggested change to [contrast] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Indicates if there was a suggested change to [transparency] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object ( CropPropertiesSuggestionState )

A mask that indicates which of the fields in cropProperties have been changed in this suggestion.

angleSuggested

boolean

Indicates if there was a suggested change to [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Поля
offsetLeftSuggested

boolean

Indicates if there was a suggested change to offsetLeft .

offsetRightSuggested

boolean

Indicates if there was a suggested change to offsetRight .

offsetTopSuggested

boolean

Indicates if there was a suggested change to offsetTop .

offsetBottomSuggested

boolean

Indicates if there was a suggested change to offsetBottom .

angleSuggested

boolean

Indicates if there was a suggested change to angle .

EmbeddedObjectBorderSuggestionState

A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Поля
colorSuggested

boolean

Indicates if there was a suggested change to [color] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Indicates if there was a suggested change to [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Indicates if there was a suggested change to [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Indicates if there was a suggested change to [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value.

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

object ( SheetsChartReferenceSuggestionState )

A mask that indicates which of the fields in sheetsChartReference have been changed in this suggestion.

SheetsChartReferenceSuggestionState

A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Поля
spreadsheetIdSuggested

boolean

Indicates if there was a suggested change to spreadsheetId .

chartIdSuggested

boolean

Indicates if there was a suggested change to chartId .

PositionedObject

An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.

JSON representation 
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Поля
objectId

string

The ID of this positioned object.

positionedObjectProperties

object ( PositionedObjectProperties )

The properties of this positioned object.

suggestedPositionedObjectPropertiesChanges

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

The suggested changes to the positioned object properties, keyed by suggestion ID.

suggestedInsertionId

string

The suggested insertion ID. If empty, then this is not a suggested insertion.

suggestedDeletionIds[]

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

PositionedObjectProperties

Properties of a PositionedObject .

JSON representation 
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Поля
positioning

object ( PositionedObjectPositioning )

The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.

embeddedObject

object ( EmbeddedObject )

The embedded object of this positioned object.

PositionedObjectPositioning

The positioning of a PositionedObject . The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.

JSON-представление 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Поля
layout

enum ( PositionedObjectLayout )

The layout of this positioned object.

leftOffset

object ( Dimension )

The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

topOffset

object ( Dimension )

The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.

PositionedObjectLayout

The possible layouts of a [PositionedObject][google.aps.docs.v1.PositionedObject].

Перечисления
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED The layout is unspecified.
WRAP_TEXT The text wraps around the positioned object.
BREAK_LEFT Breaks text such that the positioned object is on the left and text is on the right.
BREAK_RIGHT Breaks text such that the positioned object is on the right and text is on the left.
BREAK_LEFT_RIGHT Breaks text such that there's no text on the left or right of the positioned object.
IN_FRONT_OF_TEXT The positioned object is in front of the text.
BEHIND_TEXT The positioned object is behind the text.

SuggestedPositionedObjectProperties

A suggested change to PositionedObjectProperties .

JSON representation 
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Поля
positionedObjectProperties

object ( PositionedObjectProperties )

A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positionedObjectPropertiesSuggestionState to see which fields have changed and their new values.

positionedObjectPropertiesSuggestionState

object ( PositionedObjectPropertiesSuggestionState )

A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion.

PositionedObjectPropertiesSuggestionState

A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Поля
positioningSuggestionState

object ( PositionedObjectPositioningSuggestionState )

A mask that indicates which of the fields in positioning have been changed in this suggestion.

embeddedObjectSuggestionState

object ( EmbeddedObjectSuggestionState )

A mask that indicates which of the fields in embeddedObject have been changed in this suggestion.

PositionedObjectPositioningSuggestionState

A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value.

JSON representation 
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Поля
layoutSuggested

boolean

Indicates if there was a suggested change to layout .

leftOffsetSuggested

boolean

Indicates if there was a suggested change to leftOffset .

topOffsetSuggested

boolean

Indicates if there was a suggested change to topOffset .

SuggestionsViewMode

The suggestions view mode applied to the document that indicates how suggested changes are represented. It provides options for reading the document with all suggestions inline, accepted, or rejected.

Перечисления
DEFAULT_FOR_CURRENT_ACCESS The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
SUGGESTIONS_INLINE

The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_SUGGESTIONS_ACCEPTED

The returned document is a preview with all suggested changes accepted.

Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.

PREVIEW_WITHOUT_SUGGESTIONS The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.

Методы

batchUpdate

 Applies one or more updates to the document.

create

 Creates a blank document using the title given in the request.

get

 Gets the latest version of the specified document.