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

string

Только вывод. Идентификатор документа.

title

string

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

tabs[]

object ( Tab )

Вкладки, являющиеся частью документа.

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

revision Id

string

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

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

suggestions View Mode

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

document Style

object ( DocumentStyle )

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

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

suggested Document Style Changes

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

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

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

named Styles

object ( NamedStyles )

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

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

suggested Named Styles Changes

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

named Ranges

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

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

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

inline Objects

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

Только вывод. Встроенные объекты в документе, обозначенные идентификатором объекта.

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

positioned Objects

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.
}
Поля
tab Properties

object ( TabProperties )

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

child Tabs[]

object ( Tab )

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

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

object ( DocumentTab )

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

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

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

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

string

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

title

string

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

parent Tab Id

string

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

index

integer

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

nesting Level

integer

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

ДокументTab

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

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

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

document Style

object ( DocumentStyle )

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

suggested Document Style Changes

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

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

named Styles

object ( NamedStyles )

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

suggested Named Styles Changes

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

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

lists

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

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

named Ranges

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

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

inline Objects

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

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

positioned Objects

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.
}
Поля
start Index

integer

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

end Index

integer

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

content поля объединения. Содержание структурного элемента. content может быть только одним из следующих:
paragraph

object ( Paragraph )

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

section Break

object ( SectionBreak )

Тип разрыва сечения структурного элемента.

table

object ( Table )

Табличный тип структурного элемента.

table Of Contents

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 )

Содержание абзаца, разбитое на составные части.

paragraph Style

object ( ParagraphStyle )

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

suggested Paragraph Style Changes

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

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

bullet

object ( Bullet )

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

suggested Bullet Changes

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

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

positioned Object Ids[]

string

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

suggested Positioned Object Ids

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.
}
Поля
start Index

integer

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

end Index

integer

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

content поля объединения. Содержимое элемента абзаца. content может быть только одним из следующих:
text Run

object ( TextRun )

Элемент абзаца текстового фрагмента.

auto Text

object ( AutoText )

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

page Break

object ( PageBreak )

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

column Break

object ( ColumnBreak )

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

footnote Reference

object ( FootnoteReference )

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

horizontal Rule

object ( HorizontalRule )

Элемент абзаца горизонтального правила.

equation

object ( Equation )

Элемент абзаца уравнения.

inline Object Element

object ( InlineObjectElement )

Элемент абзаца встроенного объекта.

person

object ( Person )

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

ТекстРан

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

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

string

Текст этого пробега.

Все нетекстовые элементы в выполнении заменяются символом Юникода U+E907.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

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

suggested Text Style Changes

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

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

ТекстСтиль

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

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

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

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

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

boolean

Будет ли текст выделен жирным шрифтом.

italic

boolean

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

underline

boolean

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

strikethrough

boolean

Независимо от того, перечеркнут ли текст.

small Caps

boolean

Независимо от того, написан ли текст маленькими заглавными буквами.

background Color

object ( OptionalColor )

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

foreground Color

object ( OptionalColor )

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

font Size

object ( Dimension )

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

weighted Font Family

object ( WeightedFontFamily )

Семейство шрифтов и визуализируемый вес текста.

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

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

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

baseline Offset

enum ( BaselineOffset )

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

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

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

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

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

object ( Color )

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

Цвет

Сплошной цвет.

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

object ( RgbColor )

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

Цвет RGB

Цвет 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 дюйма.

Семейство взвешенных шрифтов

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

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

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)
  }
}
Поля
text Style

object ( TextStyle )

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

text Style Suggestion State

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
}
Поля
bold Suggested

boolean

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

italic Suggested

boolean

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

underline Suggested

boolean

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

strikethrough Suggested

boolean

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

small Caps Suggested

boolean

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

background Color Suggested

boolean

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

foreground Color Suggested

boolean

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

font Size Suggested

boolean

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

weighted Font Family Suggested

boolean

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

baseline Offset Suggested

boolean

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

Автотекст

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

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

enum ( Type )

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

Текстовый стиль этого автотекста.

suggested Text Style Changes

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

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

Тип

Виды автотекста.

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

Разрыв страницы

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

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

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

suggested Text Style Changes

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

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

Разрыв столбца

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

Текстовый стиль этого ColumnBreak.

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

suggested Text Style Changes

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

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

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

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

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

string

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

footnote Number

string

Отображаемый номер этой сноски.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

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

suggested Text Style Changes

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

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

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

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

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

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

Текстовый стиль этого HorizontalRule.

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

suggested Text Style Changes

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

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

Уравнение

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

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

string

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

suggested Deletion Ids[]

string

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

ИнлайнОбжектЭлемент

ParagraphElement , содержащий InlineObject .

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

string

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

Текстовый стиль этого InlineObjectElement.

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

suggested Text Style Changes

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

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

Человек

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

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

string

Только вывод. Уникальный идентификатор этой ссылки.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

text Style

object ( TextStyle )

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

suggested Text Style Changes

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

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

person Properties

object ( PersonProperties )

Только вывод. Свойства этого Person . Это поле всегда присутствует.

Свойства человека

Свойства, специфичные для связанного Person .

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

string

Только вывод. Имя человека, если оно отображается в тексте ссылки вместо адреса электронной почты человека.

email

string

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

RichLinkСвойства

Свойства, специфичные для RichLink .

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

string

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

uri

string

Только вывод. URI для RichLink . Это всегда присутствует.

mime Type

string

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

Стиль абзаца

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

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

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

string

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

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

named Style Type

enum ( NamedStyleType )

Именованный тип стиля абзаца.

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

alignment

enum ( Alignment )

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

line Spacing

number

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

direction

enum ( ContentDirection )

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

spacing Mode

enum ( SpacingMode )

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

space Above

object ( Dimension )

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

space Below

object ( Dimension )

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

border Between

object ( ParagraphBorder )

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

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

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

border Top

object ( ParagraphBorder )

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

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

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

border Bottom

object ( ParagraphBorder )

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

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

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

border Left

object ( ParagraphBorder )

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

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

border Right

object ( ParagraphBorder )

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

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

indent First Line

object ( Dimension )

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

indent Start

object ( Dimension )

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

indent End

object ( Dimension )

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

tab Stops[]

object ( TabStop )

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

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

keep Lines Together

boolean

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

keep With Next

boolean

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

avoid Widow And Orphan

boolean

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

shading

object ( Shading )

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

page Break Before

boolean

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

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

Именедстилетипе

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

Перечисления
NAMED_STYLE_TYPE_UNSPECIFIED Тип именованного стиля не указан.
NORMAL_TEXT Нормальный текст.
TITLE Заголовок.
SUBTITLE Подзаголовок.
HEADING_1 Заголовок 1.
HEADING_2 Заголовок 2.
HEADING_3 Заголовок 3.
HEADING_4 Заголовок 4.
HEADING_5 Заголовок 5.
HEADING_6 Заголовок 6.

Выравнивание

Типы выравнивания текста абзаца.

Перечисления
ALIGNMENT_UNSPECIFIED Выравнивание абзаца наследуется от родительского элемента.
START Абзац выравнивается по началу строки. Выравнивание по левому краю для текста LTR, в противном случае — по правому краю.
CENTER Абзац центрируется.
END Абзац выравнивается по концу строки. Выравнивание по правому краю для текста LTR, в противном случае — по левому краю.
JUSTIFIED Абзац оправдан.

Контентдиректион

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

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

Режим интервала

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

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

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

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

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

object ( OptionalColor )

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

width

object ( Dimension )

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

padding

object ( Dimension )

Заполнение границы.

dash Style

enum ( DashStyle )

Пунктирный стиль границы.

ДашСтиль

Виды типов, с помощью которых можно отображать линейную геометрию. Эти значения основаны на «ST_PRESetlinedAshval» простого типа, описанного в разделе 20.1.10.48 «Office Open Open File File File Formats - Основы и ссылку на язык разметки», часть 1 4 -е издание ECMA -376 .

Перечисления
DASH_STYLE_UNSPECIFIED Нестандартный стиль приборной панели.
SOLID Сплошная линия. Соответствует ECMA-376 ST_PRESETLINEDASHVAL Значение 'SOLID'. Это стиль приборной панели по умолчанию.
DOT Пунктирная линия. Соответствует ECMA-376 ST_PRESETLINEDASHVAL Значение 'DOT'.
DASH Пунктирная линия. Соответствует ECMA-376 ST_PRESETLINEDASHVAL Значение 'DASH'.

Tabstop

Вкладка остановится в абзаце.

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

object ( Dimension )

Смещение между этой остановкой вкладки и заездом.

alignment

enum ( TabStopAlignment )

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

TabStopalenment

Выравнивание остановки вкладки.

Перечисления
TAB_STOP_ALIGNMENT_UNSPECIFIED Выравнивание остановки вкладки не указано.
START Остановка вкладки выровнена с началом строки. Это дефолт.
CENTER Остановка вкладки выровнен в центр линии.
END Остановка вкладки выровнена до конца линии.

Затенение

Затенение абзаца.

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

object ( OptionalColor )

Фоновый цвет этого абзаца затенения.

Предлагаемый параграфстиль

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

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

object ( ParagraphStyle )

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

paragraph Style Suggestion State

object ( ParagraphStyleSuggestionState )

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

FaragraphStylesuggestionState

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

Представление JSON 
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Поля
heading Id Suggested

boolean

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

named Style Type Suggested

boolean

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

alignment Suggested

boolean

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

line Spacing Suggested

boolean

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

direction Suggested

boolean

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

spacing Mode Suggested

boolean

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

space Above Suggested

boolean

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

space Below Suggested

boolean

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

border Between Suggested

boolean

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

border Top Suggested

boolean

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

border Bottom Suggested

boolean

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

border Left Suggested

boolean

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

border Right Suggested

boolean

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

indent First Line Suggested

boolean

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

indent Start Suggested

boolean

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

indent End Suggested

boolean

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

keep Lines Together Suggested

boolean

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

keep With Next Suggested

boolean

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

avoid Widow And Orphan Suggested

boolean

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

shading Suggestion State

object ( ShadingSuggestionState )

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

page Break Before Suggested

boolean

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

ShadingSuggestionState

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

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

boolean

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

Пуля

Описывает пулю абзаца.

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

string

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

nesting Level

integer

Уровень гнездования этого абзаца в списке.

text Style

object ( TextStyle )

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

Предлагаемый буллет

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

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

object ( Bullet )

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

bullet Suggestion State

object ( BulletSuggestionState )

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

BulletsuggestionState

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

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

boolean

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

nesting Level Suggested

boolean

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

text Style Suggestion State

object ( TextStyleSuggestionState )

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

Objectreferences

Коллекция идентификаторов объекта.

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

string

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

Секция

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

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

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

string

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

suggested Deletion Ids[]

string

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

section Style

object ( SectionStyle )

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

Секция

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

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

object ( SectionColumnProperties )

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

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приведет к ошибке плохого запроса 400.

column Separator Style

enum ( ColumnSeparatorStyle )

Стиль разделителей колонн.

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

content Direction

enum ( ContentDirection )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

margin Top

object ( Dimension )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

margin Bottom

object ( Dimension )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

margin Right

object ( Dimension )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

margin Left

object ( Dimension )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

margin Header

object ( Dimension )

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

section Type

enum ( SectionType )

Только вывод. Тип раздела.

default Header Id

string

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

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

first Page Header Id

string

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

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

first Page Footer Id

string

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

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

even Page Header Id

string

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

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

even Page Footer Id

string

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

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

use First Page Header Footer

boolean

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

page Number Start

integer

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

flip Page Orientation

boolean

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

При обновлении этого свойства требуется настройка конкретного значения. Отсутствие этого свойства приводит к ошибке 400 плохих запросов.

SectionColumnProperties

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

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

object ( Dimension )

Только вывод. Ширина колонны.

padding End

object ( Dimension )

Прокладка в конце колонны.

ColumnSeparatorStyle

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

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

SECETTYPE

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

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

Стол

StructuralElement представляющее таблицу.

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

integer

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

columns

integer

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

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

table Rows[]

object ( TableRow )

Содержимое и стиль каждого ряда.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

table Style

object ( TableStyle )

Стиль стола.

Таблетка

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

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

integer

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

end Index

integer

Зоронный конечный индекс этой строки, эксклюзивный, в кодовых единицах UTF-16.

table Cells[]

object ( TableCell )

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

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

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

table Row Style

object ( TableRowStyle )

Стиль стола.

suggested Table Row Style Changes

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

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

Табличка

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

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

integer

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

end Index

integer

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

content[]

object ( StructuralElement )

Содержание ячейки.

table Cell Style

object ( TableCellStyle )

Стиль ячейки.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

suggested Table Cell Style Changes

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

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

Tablecellstyle

Стиль TableCell .

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

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

integer

Строка ячейки.

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

column Span

integer

Размещение колонны ячейки.

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

background Color

object ( OptionalColor )

Фоновый цвет ячейки.

border Left

object ( TableCellBorder )

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

border Right

object ( TableCellBorder )

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

border Top

object ( TableCellBorder )

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

border Bottom

object ( TableCellBorder )

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

padding Left

object ( Dimension )

Левая прокладка ячейки.

padding Right

object ( Dimension )

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

padding Top

object ( Dimension )

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

padding Bottom

object ( Dimension )

Нижняя прокладка ячейки.

content Alignment

enum ( ContentAlignment )

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

Tablecellborder

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

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

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

object ( OptionalColor )

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

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

width

object ( Dimension )

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

dash Style

enum ( DashStyle )

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

Контентат

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

Получен из подмножества значений «ST_TEXTANCHORYTYPE» простого типа в разделе 20.1.10.59 «Офис открытый форматы файлов XML - Основы и ссылка на язык разметки», часть 1 4 -е издание ECMA -376 .

Перечисления
CONTENT_ALIGNMENT_UNSPECIFIED Неуказанное выравнивание контента. Выравнивание контента унаследовано от родителя, если он существует.
CONTENT_ALIGNMENT_UNSUPPORTED Неподдерживаемое выравнивание контента.
TOP Выравнивание, которое выравнивает контент в верхнюю часть держателя контента. Соответствует ECMA-376 ST_TEXTANCHORYTYPE 'T'.
MIDDLE Выравнивание, которое выравнивает контент с серединой держателя контента. Соответствует ECMA-376 ST_TEXTANCHORYTYPE 'CTR'.
BOTTOM Выравнивание, которое выравнивает контент в нижнюю часть держателя контента. Соответствует ECMA-376 ST_TEXTANCHORYTYPE 'B'.

Предлагается, что

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

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

object ( TableCellStyle )

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

table Cell Style Suggestion State

object ( TableCellStyleSuggestionState )

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

TablecellStylesuggestionState

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

Представление JSON 
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
Поля
row Span Suggested

boolean

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

column Span Suggested

boolean

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

background Color Suggested

boolean

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

border Left Suggested

boolean

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

border Right Suggested

boolean

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

border Top Suggested

boolean

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

border Bottom Suggested

boolean

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

padding Left Suggested

boolean

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

padding Right Suggested

boolean

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

padding Top Suggested

boolean

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

padding Bottom Suggested

boolean

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

content Alignment Suggested

boolean

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

Таблероустиль

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

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

object ( Dimension )

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

table Header

boolean

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

prevent Overflow

boolean

Не может ли строка переполняться по границам страниц или столбца.

Предложенный таблероустиль

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

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

object ( TableRowStyle )

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

table Row Style Suggestion State

object ( TableRowStyleSuggestionState )

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

TableStylesuggestionState

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

Представление JSON 
{
  "minRowHeightSuggested": boolean
}
Поля
min Row Height Suggested

boolean

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

Планшет

Стили, которые применяются к столу.

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

object ( TableColumnProperties )

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

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

TableColumnProperties

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

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

enum ( WidthType )

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

width

object ( Dimension )

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

Ширина

Тип ширины колонны.

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

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

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

FIXED_WIDTH Фиксированная ширина столбца. [Width] [ google.apps.docs.v1.TableColumnProperties.width содержит ширину столбца.

Оглавление

StructuralElement представляющий содержимое.

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

object ( StructuralElement )

Содержание содержания.

suggested Insertion Ids[]

string

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

suggested Deletion Ids[]

string

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

Сноска

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

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

string

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

content[]

object ( StructuralElement )

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

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

DocumentStyle

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

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

object ( Background )

Фон документа. Документы не могут иметь прозрачный цвет фона.

default Header Id

string

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

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

even Page Header Id

string

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

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

even Page Footer Id

string

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

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

first Page Header Id

string

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

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

first Page Footer Id

string

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

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

use First Page Header Footer

boolean

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

use Even Page Header Footer

boolean

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

page Number Start

integer

Номер страницы, с которого начинает подсчитывать количество страниц.

margin Top

object ( Dimension )

Окраска верхней страницы.

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

margin Bottom

object ( Dimension )

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

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

margin Right

object ( Dimension )

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

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

margin Left

object ( Dimension )

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

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

page Size

object ( Size )

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

margin Header

object ( Dimension )

Количество пространства между верхней частью страницы и содержимым заголовка.

flip Page Orientation

boolean

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

Фон

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

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

object ( OptionalColor )

Цвет фона.

Размер

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

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

object ( Dimension )

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

width

object ( Dimension )

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

Предлагается, что далее

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

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

object ( DocumentStyle )

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

document Style Suggestion State

object ( DocumentStyleSuggestionState )

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

DocumentStylesuggestionState

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

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

object ( BackgroundSuggestionState )

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

default Header Id Suggested

boolean

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

even Page Header Id Suggested

boolean

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

even Page Footer Id Suggested

boolean

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

first Page Header Id Suggested

boolean

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

first Page Footer Id Suggested

boolean

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

use First Page Header Footer Suggested

boolean

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

use Even Page Header Footer Suggested

boolean

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

page Number Start Suggested

boolean

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

margin Top Suggested

boolean

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

margin Bottom Suggested

boolean

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

margin Right Suggested

boolean

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

margin Left Suggested

boolean

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

page Size Suggestion State

object ( SizeSuggestionState )

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

margin Header Suggested

boolean

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

flip Page Orientation Suggested

boolean

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

Фоновая задача

Маска, которая указывает, какое из полей на базовом Background была изменена в этом предложении. Для любого поля, установленного в True, Backgound имеет новое предлагаемое значение.

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

boolean

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

SizesuggestionState

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

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

boolean

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

width Suggested

boolean

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

Названные

Названные стили. Параграфы в документе могут наследовать их TextStyle и ParagraphStyle от этих названных стилей.

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

object ( NamedStyle )

Названные стили.

Есть запись для каждого из возможных named style types .

Названный

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

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

enum ( NamedStyleType )

Тип этого названного стиля.

text Style

object ( TextStyle )

Текстовый стиль этого названного стиля.

paragraph Style

object ( ParagraphStyle )

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

Предлагаемые стиль

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

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

object ( NamedStyles )

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

named Styles Suggestion State

object ( NamedStylesSuggestionState )

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

NateStylessuggestionState

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

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

object ( NamedStyleSuggestionState )

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

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

NateStylesuggestionState

Предложение состояния NamedStyle сообщения.

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

enum ( NamedStyleType )

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

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

text Style Suggestion State

object ( TextStyleSuggestionState )

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

paragraph Style Suggestion State

object ( ParagraphStyleSuggestionState )

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

Список

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

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

object ( ListProperties )

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

suggested List Properties Changes

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

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

suggested Insertion Id

string

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

suggested Deletion Ids[]

string

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

ListProperties

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

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

object ( NestingLevel )

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

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

НИСЛИНГЕЛЬ

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

Представление 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.
}
Поля
bullet Alignment

enum ( BulletAlignment )

Выравнивание пули в пространстве, выделенном для визуализации пули.

glyph Format

string

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

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

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

A.

B.

C.

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

1.

2.

2.1.

2.2.

3.

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

indent First Line

object ( Dimension )

Количество отступления для первой линии параграфов на этом уровне гнездования.

indent Start

object ( Dimension )

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

text Style

object ( TextStyle )

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

start Number

integer

Количество первого элемента списка на этом уровне гнездования.

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

Это значение игнорируется для уровней гнездования с неупорядоченными глифами.

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

enum ( GlyphType )

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

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

glyph Symbol

string

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

Символ глифа заменяет заполнители в glyphFormat . Например, если Glyphsymbol является твердым кругом, соответствующим точке кода Unicode U+25CF, а glyphFormat равна %0 , визуализированный глиф был бы твердый круг.

Бэллетализация

Типы выравнивания для пули.

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

Глифтип

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

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

SuggestedListProperties

A suggested change to ListProperties .

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

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.

list Properties Suggestion State

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)
    }
  ]
}
Поля
nesting Levels Suggestion States[]

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
}
Поля
bullet Alignment Suggested

boolean

Indicates if there was a suggested change to bulletAlignment .

glyph Type Suggested

boolean

Indicates if there was a suggested change to glyphType .

glyph Format Suggested

boolean

Indicates if there was a suggested change to glyphFormat .

glyph Symbol Suggested

boolean

Indicates if there was a suggested change to glyphSymbol .

indent First Line Suggested

boolean

Indicates if there was a suggested change to indentFirstLine .

indent Start Suggested

boolean

Indicates if there was a suggested change to indentStart .

text Style Suggestion State

object ( TextStyleSuggestionState )

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

start Number Suggested

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.

named Ranges[]

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)
    }
  ]
}
Поля
named Range Id

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 representation 
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer,
  "tabId": string
}
Поля
segment Id

string

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

start Index

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.

end Index

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.

tab Id

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
  ]
}
Поля
object Id

string

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

inline Object Properties

object ( InlineObjectProperties )

The properties of this inline object.

suggested Inline Object Properties Changes

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

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

suggested Insertion Id

string

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

suggested Deletion Ids[]

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)
  }
}
Поля
embedded Object

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.

embedded Object Border

object ( EmbeddedObjectBorder )

The border of the embedded object.

size

object ( Size )

The visible size of the image after cropping.

margin Top

object ( Dimension )

The top margin of the embedded object.

margin Bottom

object ( Dimension )

The bottom margin of the embedded object.

margin Right

object ( Dimension )

The right margin of the embedded object.

margin Left

object ( Dimension )

The left margin of the embedded object.

linked Content Reference

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:
embedded Drawing Properties

object ( EmbeddedDrawingProperties )

The properties of an embedded drawing.

image Properties

object ( ImageProperties )

The properties of an image.

EmbeddedDrawingProperties

This type has no fields.

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

ImageProperties

The properties of an image.

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

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.

source Uri

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.

crop Properties

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 angle are 0, the image is not cropped.
JSON representation 
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Поля
offset Left

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.

offset Right

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.

offset Top

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.

offset Bottom

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 )

The color of the border.

width

object ( Dimension )

The width of the border.

dash Style

enum ( DashStyle )

The dash style of the border.

property State

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:
sheets Chart Reference

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
}
Поля
spreadsheet Id

string

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

chart Id

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)
  }
}
Поля
inline Object Properties

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.

inline Object Properties Suggestion State

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)
  }
}
Поля
embedded Object Suggestion State

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)
  }
}
Поля
embedded Drawing Properties Suggestion State

object ( EmbeddedDrawingPropertiesSuggestionState )

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

image Properties Suggestion State

object ( ImagePropertiesSuggestionState )

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

title Suggested

boolean

Indicates if there was a suggested change to title .

description Suggested

boolean

Indicates if there was a suggested change to description .

embedded Object Border Suggestion State

object ( EmbeddedObjectBorderSuggestionState )

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

size Suggestion State

object ( SizeSuggestionState )

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

margin Left Suggested

boolean

Indicates if there was a suggested change to marginLeft .

margin Right Suggested

boolean

Indicates if there was a suggested change to marginRight .

margin Top Suggested

boolean

Indicates if there was a suggested change to marginTop .

margin Bottom Suggested

boolean

Indicates if there was a suggested change to marginBottom .

linked Content Reference Suggestion State

object ( LinkedContentReferenceSuggestionState )

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

EmbeddedDrawingPropertiesSuggestionState

This type has no fields.

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

ImagePropertiesSuggestionState

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

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

boolean

Indicates if there was a suggested change to contentUri .

source Uri Suggested

boolean

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

brightness Suggested

boolean

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

contrast Suggested

boolean

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

transparency Suggested

boolean

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

crop Properties Suggestion State

object ( CropPropertiesSuggestionState )

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

angle Suggested

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
}
Поля
offset Left Suggested

boolean

Indicates if there was a suggested change to offsetLeft .

offset Right Suggested

boolean

Indicates if there was a suggested change to offsetRight .

offset Top Suggested

boolean

Indicates if there was a suggested change to offsetTop .

offset Bottom Suggested

boolean

Indicates if there was a suggested change to offsetBottom .

angle Suggested

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
}
Поля
color Suggested

boolean

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

width Suggested

boolean

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

dash Style Suggested

boolean

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

property State Suggested

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 representation 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Поля
sheets Chart Reference Suggestion State

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
}
Поля
spreadsheet Id Suggested

boolean

Indicates if there was a suggested change to spreadsheetId .

chart Id Suggested

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
  ]
}
Поля
object Id

string

The ID of this positioned object.

positioned Object Properties

object ( PositionedObjectProperties )

The properties of this positioned object.

suggested Positioned Object Properties Changes

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

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

suggested Insertion Id

string

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

suggested Deletion Ids[]

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.

embedded Object

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 representation 
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Поля
layout

enum ( PositionedObjectLayout )

The layout of this positioned object.

left Offset

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.

top Offset

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)
  }
}
Поля
positioned Object Properties

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.

positioned Object Properties Suggestion State

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)
  }
}
Поля
positioning Suggestion State

object ( PositionedObjectPositioningSuggestionState )

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

embedded Object Suggestion State

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
}
Поля
layout Suggested

boolean

Indicates if there was a suggested change to layout .

left Offset Suggested

boolean

Indicates if there was a suggested change to leftOffset .

top Offset Suggested

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.

Методы

batch Update

 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.