Requests

Запрос

Одно изменение, которое нужно применить к документу.

JSON-представление 
{

  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  },
  "createDropdownDefinition": {
    object (CreateDropdownDefinitionRequest)
  },
  "updateDropdownDefinitionProperties": {
    object (UpdateDropdownDefinitionPropertiesRequest)
  },
  "insertDropdown": {
    object (InsertDropdownRequest)
  },
  "updateDropdownProperties": {
    object (UpdateDropdownPropertiesRequest)
  },
  "deleteDropdownDefinition": {
    object (DeleteDropdownDefinitionRequest)
  }
}
Поля
Конкретный запрос на применение. Требуется указать ровно одно поле. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
replaceAllText

object (ReplaceAllTextRequest)

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

insertText

object (InsertTextRequest)

Вставляет текст в указанное место.

updateTextStyle

object (UpdateTextStyleRequest)

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

createParagraphBullets

object (CreateParagraphBulletsRequest)

Создает маркеры для абзацев.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Удаляет маркеры из абзацев.

createNamedRange

object (CreateNamedRangeRequest)

Создает именованный диапазон.

deleteNamedRange

object (DeleteNamedRangeRequest)

Удаляет именованный диапазон.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Обновляет стиль абзаца в указанном диапазоне.

deleteContentRange

object (DeleteContentRangeRequest)

Удаляет контент из документа.

insertInlineImage

object (InsertInlineImageRequest)

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

insertTable

object (InsertTableRequest)

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

insertTableRow

object (InsertTableRowRequest)

Вставляет в таблицу пустую строку.

insertTableColumn

object (InsertTableColumnRequest)

Вставляет пустой столбец в таблицу.

deleteTableRow

object (DeleteTableRowRequest)

Удаляет строку из таблицы.

deleteTableColumn

object (DeleteTableColumnRequest)

Удаляет столбец из таблицы.

insertPageBreak

object (InsertPageBreakRequest)

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

deletePositionedObject

object (DeletePositionedObjectRequest)

Удаляет из документа объект с заданным положением.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Обновляет свойства столбцов в таблице.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Обновляет стиль ячеек таблицы.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Обновляет стиль строки в таблице.

replaceImage

object (ReplaceImageRequest)

Заменяет изображение в документе.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

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

mergeTableCells

object (MergeTableCellsRequest)

Объединяет ячейки в таблице.

unmergeTableCells

object (UnmergeTableCellsRequest)

Разъединяет ячейки в таблице.

createHeader

object (CreateHeaderRequest)

Создает заголовок.

createFootnote

object (CreateFootnoteRequest)

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

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Заменяет содержимое в именованном диапазоне.

updateSectionStyle

object (UpdateSectionStyleRequest)

Обновляет стиль раздела в указанном диапазоне.

insertSectionBreak

object (InsertSectionBreakRequest)

Вставляет разрыв раздела в указанном месте.

deleteHeader

object (DeleteHeaderRequest)

Удаляет заголовок из документа.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Обновляет количество закрепленных строк заголовка в таблице.

addDocumentTab

object (AddDocumentTabRequest)

Добавляет вкладку документа.

deleteTab

object (DeleteTabRequest)

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

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

Обновляет свойства вкладки документа.

insertPerson

object (InsertPersonRequest)

Вставляет упоминание пользователя.

updateNamedStyle

object (UpdateNamedStyleRequest)

Обновляет именованный стиль.

insertDate

object (InsertDateRequest)

Вставляет дату.

insertComment

object (InsertCommentRequest)

Вставляет в документ символ CommentThread.

addCommentReply

object (AddCommentReplyRequest)

Добавляет ответ на CommentThread или SuggestionThread.

updateCommentPost

object (UpdateCommentPostRequest)

Обновляет существующую запись (основную или ответ) в CommentThread или SuggestionThread.

deleteComment

object (DeleteCommentRequest)

Удаляет CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

Удаляет ответ Post из CommentThread или SuggestionThread.

acceptSuggestion

object (AcceptSuggestionRequest)

Принимает предложение.

rejectSuggestion

object (RejectSuggestionRequest)

Отклоняет предложение.

deleteSuggestion

object (DeleteSuggestionRequest)

Удаляет подсказку.

createDropdownDefinition

object (CreateDropdownDefinitionRequest)

Создает DropdownDefinition.

updateDropdownDefinitionProperties

object (UpdateDropdownDefinitionPropertiesRequest)

Обновляет свойства DropdownDefinition.

insertDropdown

object (InsertDropdownRequest)

Вставляет Dropdown в указанное место.

updateDropdownProperties

object (UpdateDropdownPropertiesRequest)

Обновляет свойства Dropdown.

deleteDropdownDefinition

object (DeleteDropdownDefinitionRequest)

Удаляет DropdownDefinition.

Конец взаимоисключающих полей.

ReplaceAllTextRequest

Заменяет все экземпляры текста, соответствующие критерию, на replace text.

JSON-представление 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
Поля
replaceText

string

Текст, который заменит найденный.

tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

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

object (SubstringMatchCriteria)

Находит в документе текст, соответствующий этой подстроке.

Конец взаимоисключающих полей.

SubstringMatchCriteria

Критерий, соответствующий определенной текстовой строке в документе.

JSON-представление 
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
Поля
text

string

Текст, который нужно найти в документе.

matchCase

boolean

Указывает, нужно ли учитывать регистр при поиске:

  • True – поиск с учетом регистра.
  • False – поиск не учитывает регистр.
searchByRegex

boolean

Необязательное поле. Значение True, если значение поиска должно рассматриваться как регулярное выражение. Обратные косые черты в шаблоне должны быть экранированы.

  • True : текст поиска обрабатывается как регулярное выражение.
  • False – поисковый текст рассматривается как подстрока для сопоставления.

TabsCriteria

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

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

string

Список идентификаторов вкладок, в которых выполняется запрос.

InsertTextRequest

Вставляет текст в указанное место.

JSON-представление 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
text

string

Текст, который нужно вставить.

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

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

Некоторые управляющие символы (U+0000-U+0008, U+000C-U+001F) и символы из частной области базовой многоязычной плоскости Unicode (U+E000-U+F8FF) будут удалены из вставленного текста.

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

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Конец взаимоисключающих полей.

Местоположение

Определенное место в документе.

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

string

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

index

integer

Индекс на основе нуля в единицах кода UTF-16.

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

tabId

string

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

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

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

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

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

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

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

EndOfSegmentLocation

В конце основного текста, верхнего или нижнего колонтитула или сноски. Местоположение находится непосредственно перед последним символом новой строки в сегменте документа.

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

string

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

tabId

string

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

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

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

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

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

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

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

UpdateTextStyleRequest

Изменить стиль текста.

JSON-представление 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
Поля
textStyle

object (TextStyle)

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

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

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент textStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы сделать текст полужирным, задайте для атрибута fields значение "bold".

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

Тип диапазона, в котором будет обновлен стиль текста. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
range

object (Range)

Диапазон текста, к которому применяется стиль.

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

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

Диапазоны нельзя вставлять в относительный запрос UpdateTextStyleRequest.

Конец взаимоисключающих полей.

CreateParagraphBulletsRequest

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

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

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

JSON-представление 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Поля
range

object (Range)

Диапазон, к которому нужно применить шаблон маркированного списка.

bulletPreset

enum (BulletGlyphPreset)

Типы маркеров.

BulletGlyphPreset

Готовые шаблоны глифов маркеров для списков.

В этих шаблонах используются следующие маркеры:

  • ARROW : стрелка, соответствующая кодовой точке Unicode U+2794
  • ARROW3D : Стрелка с трехмерным затенением, соответствующая кодовой точке Unicode U+27a2
  • CHECKBOX : пустой квадрат, соответствующий кодовой точке Unicode U+274f
  • CIRCLE : пустой круг, соответствующий кодовой точке Unicode U+25cb.
  • DIAMOND : сплошной ромб, соответствующий кодовой точке Unicode U+25c6.
  • DIAMONDX : ромб с крестиком, соответствующий кодовой точке Юникода U+2756.
  • HOLLOWDIAMOND : пустой ромб, соответствующий кодовой точке Unicode U+25c7.
  • DISC – сплошной круг, соответствующий кодовой точке Unicode U+25cf.
  • SQUARE : сплошной квадрат, соответствующий кодовой точке Unicode U+25a0.
  • STAR : Звездочка, соответствующая кодовой точке Unicode U+2605
  • ALPHA : строчная буква, например "a", "b" или "c".
  • UPPERALPHA – прописная буква, например "А", "Б" или "В".
  • DECIMAL : число, например "1", "2" или "3".
  • ZERODECIMAL: число, в котором однозначные числа дополняются нулем в начале, например "01", "02" или "03". Перед числами, состоящими из нескольких цифр, ноль не ставится.
  • ROMAN : строчное римское число, например i, ii или iii.
  • UPPERROMAN: римская цифра, например I, II или III.
  • LEFTTRIANGLE – треугольник, направленный влево, соответствующий кодовой точке Unicode U+25c4.
Перечисления
BULLET_GLYPH_PRESET_UNSPECIFIED Не указан набор настроек для глифа маркера.
BULLET_DISC_CIRCLE_SQUARE Маркированный список с глифами DISC, CIRCLE и SQUARE для первых трех уровней вложенности.
BULLET_DIAMONDX_ARROW3D_SQUARE Маркированный список с глифами DIAMONDX, ARROW3D и SQUARE для первых трех уровней вложенности.
BULLET_CHECKBOX Маркированный список с глифами маркеров CHECKBOX для всех уровней вложенности.
BULLET_ARROW_DIAMOND_DISC Маркированный список с глифами ARROW, DIAMOND и DISC для первых трех уровней вложенности.
BULLET_STAR_CIRCLE_SQUARE Маркированный список с глифами STAR, CIRCLE и SQUARE для первых трех уровней вложенности.
BULLET_ARROW3D_CIRCLE_SQUARE Маркированный список с глифами ARROW3D, CIRCLE и SQUARE для первых трех уровней вложенности.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Маркированный список с глифами LEFTTRIANGLE, DIAMOND и DISC для первых трех уровней вложенности.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Маркированный список с глифами DIAMONDX, HOLLOWDIAMOND и SQUARE для первых трех уровней вложенности.
BULLET_DIAMOND_CIRCLE_SQUARE Маркированный список с глифами DIAMOND, CIRCLE и SQUARE для первых трех уровней вложенности.
NUMBERED_DECIMAL_ALPHA_ROMAN Нумерованный список с числовыми глифами DECIMAL, ALPHA и ROMAN для первых трех уровней вложенности, за которыми следуют точки.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Нумерованный список с числовыми глифами DECIMAL, ALPHA и ROMAN для первых трех уровней вложенности, за которыми следуют скобки.
NUMBERED_DECIMAL_NESTED Нумерованный список с DECIMAL цифровыми глифами, разделенными точками, где каждый уровень вложенности использует глиф предыдущего уровня в качестве префикса. Примеры: "1.", '1.1.', "2.", 2.2.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Нумерованный список с числовыми глифами UPPERALPHA, ALPHA и ROMAN для первых трех уровней вложенности списка, за которыми следуют точки.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Нумерованный список с числовыми глифами UPPERROMAN, UPPERALPHA и DECIMAL для первых трех уровней вложенности, за которыми следуют точки.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Нумерованный список с числовыми глифами ZERODECIMAL, ALPHA и ROMAN для первых трех уровней вложенности, за которыми следуют точки.

DeleteParagraphBulletsRequest

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

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

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

object (Range)

Диапазон, из которого нужно удалить маркеры.

CreateNamedRangeRequest

Создает NamedRange, ссылающийся на указанный диапазон.

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

string

Название именованного диапазона. Названия не обязательно должны быть уникальными.

Названия должны содержать не менее одного и не более 256 символов, измеренных в единицах кода UTF-16.

range

object (Range)

Диапазон, к которому применяется имя.

DeleteNamedRangeRequest

Удаляет NamedRange.

JSON-представление 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "namedRangeId": string,
  "name": string
}
Поля
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

string

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

name

string

Название удаляемого диапазона. Все именованные диапазоны с указанным названием будут удалены.

Конец взаимоисключающих полей.

UpdateParagraphStyleRequest

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

JSON-представление 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  "range": {
    object (Range)
  }
}
Поля
paragraphStyle

object (ParagraphStyle)

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

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент paragraphStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить выравнивание абзаца, задайте для свойства fields значение "alignment".

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

Тип диапазона, в котором будет обновлен стиль абзаца. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
range

object (Range)

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

Конец взаимоисключающих полей.

DeleteContentRangeRequest

Удаляет контент из документа.

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

object (Range)

Диапазон контента, который нужно удалить.

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

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

Вот несколько примеров недействительных запросов на удаление:

  • Удаление одной единицы кода из суррогатной пары.
  • Удаление последнего символа новой строки в Body, Header, Footer, Footnote, TableCell или TableOfContents.
  • Удаление начала или конца элемента Table, TableOfContents или Equation без удаления всего элемента.
  • Удаление символа новой строки перед элементом Table, TableOfContents или SectionBreak без удаления самого элемента.
  • Удаление отдельных строк или ячеек таблицы. Удалять контент в ячейках таблицы разрешено.

InsertInlineImageRequest

Вставляет объект InlineObject, содержащий изображение, в указанное место.

JSON-представление 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
uri

string

URI изображения.

Изображение загружается один раз при вставке, и его копия сохраняется для показа в документе. Размер изображения должен быть не более 50 МБ, разрешение – не более 25 Мпкс, а формат – PNG, JPEG или GIF.

Указанный URI должен быть общедоступным и не превышать 2 КБ. URI сохраняется вместе с изображением и доступен через поле ImageProperties.content_uri.

objectSize

object (Size)

Размер, в котором изображение должно отображаться в документе. Это свойство необязательно. Окончательный размер изображения в документе определяется по следующим правилам: * Если не указаны ни ширина, ни высота, размер изображения по умолчанию рассчитывается на основе его разрешения. * Если указан один размер, второй рассчитывается автоматически, чтобы сохранить соотношение сторон изображения. * Если указаны и ширина, и высота, изображение масштабируется так, чтобы вписаться в заданные размеры с сохранением соотношения сторон.

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

object (Location)

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

Изображение должно быть вставлено в существующий элемент Paragraph. Например, его нельзя вставить в начало таблицы (то есть между таблицей и предыдущим абзацем).

Встроенные изображения нельзя вставлять в сноски или уравнения.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Встроенные изображения нельзя вставлять в сноски.

Конец взаимоисключающих полей.

InsertTableRequest

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

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
rows

integer

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

columns

integer

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

Место, куда будет вставлена таблица. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

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

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

Таблица должна быть вставлена в границах существующего элемента Paragraph. Например, его нельзя вставить в начальный индекс таблицы (то есть между существующей таблицей и предшествующим ей абзацем).

Таблицы нельзя вставлять в сноски или уравнения.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Таблицы нельзя вставлять в сноски.

Конец взаимоисключающих полей.

InsertTableRowRequest

Вставляет в таблицу пустую строку.

JSON-представление 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Поля
tableCellLocation

object (TableCellLocation)

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

Новая строка будет вставлена над (или под) строкой, в которой находится референсная ячейка. Если референсная ячейка является объединенной, новая строка будет вставлена над (или под) объединенной ячейкой.

insertBelow

boolean

Нужно ли вставлять новую строку под ячейкой, на которую указывает ссылка.

  • True : вставить ниже ячейки.
  • False : вставить выше ячейки.

TableCellLocation

Положение одной ячейки в таблице.

JSON-представление 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Поля
tableStartLocation

object (Location)

Местоположение таблицы в документе.

rowIndex

integer

Индекс строки, начиная с нуля. Например, у второй строки в таблице индекс 1.

columnIndex

integer

Индекс столбца, начиная с нуля. Например, у второго столбца в таблице индекс 1.

InsertTableColumnRequest

Вставляет пустой столбец в таблицу.

JSON-представление 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Поля
tableCellLocation

object (TableCellLocation)

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

Новый столбец будет вставлен слева (или справа) от столбца, в котором находится ячейка, на которую указывает ссылка. Если ячейка, на которую указывает ссылка, объединена с другими, новый столбец будет вставлен слева (или справа) от объединенной ячейки.

insertRight

boolean

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

  • True – вставить справа.
  • False : вставить слева.

DeleteTableRowRequest

Удаляет строку из таблицы.

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

object (TableCellLocation)

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

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

DeleteTableColumnRequest

Удаляет столбец из таблицы.

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

object (TableCellLocation)

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

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

InsertPageBreakRequest

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

JSON-представление 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
Место, куда будет вставлен разрыв страницы. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

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

Разрыв страницы должен быть вставлен в границах существующего элемента Paragraph. Например, его нельзя вставить в начало таблицы (то есть между таблицей и предыдущим абзацем).

Разрывы страниц нельзя вставлять в таблицы, уравнения, сноски, верхние и нижние колонтитулы. Поскольку разрывы страниц можно вставлять только в основную часть документа, поле segment ID должно быть пустым.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Разрывы страниц нельзя вставлять в сноски, верхние и нижние колонтитулы. Поскольку разрывы страниц можно вставлять только в основную часть документа, поле segment ID должно быть пустым.

Конец взаимоисключающих полей.

DeletePositionedObjectRequest

Удаляет элемент PositionedObject из документа.

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

string

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

tabId

string

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

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

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

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

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

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

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

UpdateTableColumnPropertiesRequest

Обновляет TableColumnProperties столбцов в таблице.

JSON-представление 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Поля
tableStartLocation

object (Location)

Местоположение таблицы в документе.

columnIndices[]

integer

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

tableColumnProperties

object (TableColumnProperties)

Свойства столбца таблицы, которые нужно обновить.

Если значение tableColumnProperties#width меньше 5 пунктов (5/72 дюйма), возвращается ошибка 400 "Недопустимый запрос".

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент tableColumnProperties подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить ширину столбца, задайте для параметра fields значение "width".

UpdateTableCellStyleRequest

Обновляет стиль диапазона ячеек таблицы.

JSON-представление 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
Поля
tableCellStyle

object (TableCellStyle)

Стиль, который нужно задать для ячеек таблицы.

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент tableCellStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить цвет фона ячейки таблицы, задайте для параметра fields значение "backgroundColor".

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

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

object (TableRange)

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

tableStartLocation

object (Location)

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

Конец взаимоисключающих полей.

TableRange

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

Важно отметить, что ячейки, указанные в диапазоне таблицы, не обязательно образуют прямоугольник. Предположим, у нас есть таблица 3 x 3, в которой все ячейки последнего ряда объединены. Таблица выглядит следующим образом: 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Диапазон таблицы с расположением ячейки таблицы = (tableStartLocation, row = 0, column = 0), охватом строк = 3 и охватом столбцов = 2 указывает на следующие ячейки: 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON-представление 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Поля
tableCellLocation

object (TableCellLocation)

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

rowSpan

integer

Количество строк в диапазоне таблицы.

columnSpan

integer

Диапазон столбцов таблицы.

UpdateTableRowStyleRequest

Обновляет TableRowStyle строк в таблице.

JSON-представление 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Поля
tableStartLocation

object (Location)

Местоположение таблицы в документе.

rowIndices[]

integer

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

tableRowStyle

object (TableRowStyle)

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент tableRowStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить минимальную высоту строки, задайте для параметра fields значение "minRowHeight".

ReplaceImageRequest

Заменяет существующее изображение новым.

При замене изображения некоторые image effects из существующего изображения удаляются, чтобы поведение было таким же, как в редакторе Документов.

JSON-представление 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Поля
imageObjectId

string

Идентификатор существующего изображения, которое будет заменено. Идентификатор можно получить из ответа на GET-запрос.

uri

string

URI нового изображения.

Изображение загружается один раз при вставке, и его копия сохраняется для показа в документе. Размер изображений не должен превышать 50 МБ, разрешение – 25 Мпкс, а формат – PNG, JPEG или GIF.

Длина URI не может превышать 2 КБ. URI сохраняется вместе с изображением и доступен через поле ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Метод замены.

tabId

string

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

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

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

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

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

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

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

ImageReplaceMethod

Метод замены изображения.

Перечисления
IMAGE_REPLACE_METHOD_UNSPECIFIED Метод замены изображения не указан. Это значение использовать нельзя.
CENTER_CROP Масштабирует и центрирует изображение, чтобы заполнить границы исходного изображения. Изображение может быть обрезано, чтобы заполнить границы исходного изображения. Размер изображения будет таким же, как у исходного.

UpdateDocumentStyleRequest

Обновляет DocumentStyle.

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

object (DocumentStyle)

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

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент documentStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить фон, задайте для параметра fields значение "background".

tabId

string

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

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

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

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

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

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

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

MergeTableCellsRequest

Объединяет ячейки в диапазоне Table.

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

object (TableRange)

Диапазон таблицы, указывающий, какие ячейки таблицы нужно объединить.

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

Если диапазон не прямоугольный (что может произойти, если он охватывает уже объединенные ячейки или если таблица не прямоугольная), возвращается ошибка 400 "Недопустимый запрос".

UnmergeTableCellsRequest

Отменяет объединение ячеек в диапазоне Table.

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

object (TableRange)

Диапазон таблицы, указывающий, какие ячейки нужно разъединить.

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

Если в объединенных ячейках есть текст, он останется в первой ячейке полученного блока. Ячейка "head" – это верхняя левая ячейка, если контент расположен слева направо, и верхняя правая ячейка в противном случае.

CreateHeaderRequest

Создает Header. Новый заголовок применяется к элементу SectionStyle в местоположении элемента SectionBreak, если он указан, или к элементу DocumentStyle.

Если заголовок указанного типа уже существует, возвращается ошибка 400 (недопустимый запрос).

JSON-представление 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Поля
type

enum (HeaderFooterType)

Тип заголовка, который нужно создать.

sectionBreakLocation

object (Location)

Местоположение тега SectionBreak, который начинает раздел, к которому должен относиться заголовок. Если параметр `sectionBreakLocation` не задан или относится к первому разрыву раздела в основном тексте документа, заголовок применяется к DocumentStyle

HeaderFooterType

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

Перечисления
DEFAULT Колонтитул по умолчанию.

CreateFooterRequest

Создает Footer. Новый нижний колонтитул применяется к элементу SectionStyle в месте элемента SectionBreak, если он указан, или к элементу DocumentStyle.

Если нижний колонтитул указанного типа уже существует, возвращается ошибка 400 (недопустимый запрос).

JSON-представление 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Поля
type

enum (HeaderFooterType)

Тип нижнего колонтитула, который нужно создать.

sectionBreakLocation

object (Location)

Местоположение тега SectionBreak , который непосредственно предшествует разделу, к которому SectionStyle относится нижний колонтитул. Если этот параметр не задан или относится к первому разрыву раздела в документе, нижний колонтитул применяется к стилю документа.

CreateFootnoteRequest

Создает сегмент Footnote и вставляет в него новый элемент FootnoteReference в указанном месте.

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

JSON-представление 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
Место, куда нужно вставить ссылку на сноску. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

Вставляет ссылку на сноску в определенном месте документа.

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

Вставляет ссылку на сноску в конце основного текста документа.

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

Конец взаимоисключающих полей.

ReplaceNamedRangeContentRequest

Заменяет содержимое указанного элемента NamedRange или NamedRanges на заданный контент.

Обратите внимание, что один пользователь NamedRange может состоять из нескольких непоследовательных ranges. В этом случае будет заменен только контент в первом диапазоне. Остальные диапазоны и их содержимое будут удалены.

Если замена или удаление каких-либо диапазонов приведет к нарушению структуры документа, возвращается ошибка 400 (недопустимый запрос).

JSON-представление 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
Поля
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

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

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

string

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

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

string

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

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

namedRangeName

string

Название объекта NamedRanges, контент которого будет заменен.

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

Конец взаимоисключающих полей.

UpdateSectionStyleRequest

Обновляет SectionStyle.

JSON-представление 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Поля
range

object (Range)

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

Поскольку разрывы разделов можно вставлять только в основную часть документа, поле segment ID должно быть пустым.

sectionStyle

object (SectionStyle)

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

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент sectionStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить левое поле, задайте для параметра fields значение "marginLeft".

InsertSectionBreakRequest

Вставляет разрыв раздела в указанном месте.

Перед разрывом раздела будет вставлен символ новой строки.

JSON-представление 
{
  "sectionType": enum (SectionType),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
sectionType

enum (SectionType)

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

Место, куда будет вставлена рекламная пауза. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

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

Разрыв раздела должен быть вставлен в границах существующего элемента Paragraph. Например, его нельзя вставить в начало таблицы (то есть между таблицей и предыдущим абзацем).

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

Конец взаимоисключающих полей.

DeleteHeaderRequest

Удаляет элемент Header из документа.

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

string

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

tabId

string

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

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

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

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

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

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

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

DeleteFooterRequest

Удаляет элемент Footer из документа.

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

string

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

tabId

string

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

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

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

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

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

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

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

PinTableHeaderRowsRequest

Обновляет количество закрепленных строк заголовка таблицы.

JSON-представление 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Поля
tableStartLocation

object (Location)

Местоположение таблицы в документе.

pinnedHeaderRowsCount

integer

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

AddDocumentTabRequest

Добавляет вкладку документа. Когда вкладка добавляется по определенному индексу, индексы всех последующих вкладок увеличиваются.

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

object (TabProperties)

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

DeleteTabRequest

Удаляет вкладку. Если у вкладки есть дочерние вкладки, они также будут удалены.

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

string

Идентификатор вкладки, которую нужно удалить.

UpdateDocumentTabPropertiesRequest

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

JSON-представление 
{
  "tabProperties": {
    object (TabProperties)
  },
  "fields": string
}
Поля
tabProperties

object (TabProperties)

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

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент tabProperties подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

InsertPersonRequest

Вставляет упоминание пользователя.

JSON-представление 
{
  "personProperties": {
    object (PersonProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
personProperties

object (PersonProperties)

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

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

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

Вставляет упоминание пользователя в конце колонтитула, сноски или основного текста документа.

Конец взаимоисключающих полей.

UpdateNamedStyleRequest

Обновляет именованный стиль.

JSON-представление 
{
  "namedStyle": {
    object (NamedStyle)
  },
  "fields": string,
  "tabId": string
}
Поля
namedStyle

object (NamedStyle)

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

fields

string (FieldMask format)

Поля NamedStyle, которые нужно обновить.

Необходимо указать хотя бы namedStyleType. Корневой элемент namedStyle подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

Например, чтобы изменить стиль текста на полужирный, добавьте в fields следующие элементы: "textStyle" и "textStyle.bold". Чтобы изменить выравнивание абзаца, задайте для свойства fields значение "paragraphStyle" или "paragraphStyle.alignment".

Чтобы сбросить значение свойства до значения по умолчанию, укажите название поля в маске, но не задавайте значение самого поля. Если указать "textStyle" или "paragraphStyle" с пустым TextStyle или ParagraphStyle, все вложенные поля будут сброшены.

tabId

string

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

InsertRichLinkRequest

Вставляет RichLink в указанное место.

JSON-представление 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
Место, куда будет вставлена расширенная ссылка. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
location

object (Location)

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

Расширенная ссылка должна быть вставлена в существующий элемент Paragraph. Например, его нельзя вставить в начало таблицы (то есть между таблицей и предыдущим абзацем).

Расширенную ссылку нельзя вставить в уравнение.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Конец взаимоисключающих полей.

InsertDateRequest

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
dateElementProperties

object (DateElementProperties)

Свойства даты, которую нужно вставить.

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

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Конец взаимоисключающих полей.

InsertCommentRequest

Вставляет в документ символ CommentThread.

JSON-представление 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
Поля
content

string

Текст комментария в виде обычного текста.

Текст будет обрабатываться так же, как комментарии, созданные в редакторе Документов. Она будет работать так же, как и текущая версия, в том числе в отношении форматирования и уведомлений.

Это поле обязательно для заполнения. Его длина не должна превышать 2048 единиц кода UTF-8.

assigneeEmailAddress

string

Необязательное поле. Адрес электронной почты назначенного исполнителя комментария.

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

Не более 2048 единиц кода UTF-8.

Место в документе, связанное с комментарием. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
range

object (Range)

Range в документе, связанный с этим комментарием.

Конец взаимоисключающих полей.

AddCommentReplyRequest

Вставляет ответ Post в CommentThread или SuggestionThread.

JSON-представление 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
Поля
post

object (Post)

Post, представляющий ответ.

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

string

Идентификатор CommentThread, к которому нужно добавить ответ.

suggestionId

string

Идентификатор SuggestionThread, к которому нужно добавить ответ.

Конец взаимоисключающих полей.

UpdateCommentPostRequest

Обновляет Post в CommentThread или SuggestionThread.

Возвращает ошибку 400 (неверный запрос), если:

  • Запись является headPost обсуждения.

  • Пользователь, отправивший запрос, не является автором записи.

JSON-представление 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
Поля
postId

string

Идентификатор записи, которую нужно обновить.

content

string

Новый текст комментария в формате обычного текста.

Текст будет обрабатываться так же, как комментарии, созданные в редакторе Документов. Она будет работать так же, как и текущая версия, в том числе в отношении форматирования и уведомлений.

Это поле обязательно для заполнения. Его длина не должна превышать 2048 символов в кодировке UTF-8.

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

string

Идентификатор CommentThread , к которому относится запись.

suggestionId

string

Идентификатор SuggestionThread , к которому относится запись.

Конец взаимоисключающих полей.

DeleteCommentRequest

Удаляет CommentThread.

Возвращает ошибку 400 (недопустимый запрос), если пользователь, отправивший запрос, не является автором headPost.

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

string

Идентификатор объекта CommentThread, который удаляется.

DeleteCommentReplyRequest

Удаляет ответ Post из CommentThread или SuggestionThread.

Возвращает ошибку 400 (неверный запрос), если:

  • Пользователь, отправивший запрос, не является автором записи.

  • Запись ответа содержит [действие][google.apps.docs.v1.Post.action].

  • Ответ содержит assignee.

JSON-представление 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
Поля
postId

string

Идентификатор удаляемого ответа. Post

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

string

Идентификатор CommentThread , к которому относится запись.

suggestionId

string

Идентификатор SuggestionThread , к которому относится запись.

Конец взаимоисключающих полей.

AcceptSuggestionRequest

Принимает предложение.

Возвращает ошибку 403 (запрещено), если у пользователя, отправившего запрос, нет прав на редактирование документа.

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

string

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

RejectSuggestionRequest

Отклоняет предложение.

Возвращает ошибку 403 (запрещено), если у пользователя, отправившего запрос, нет прав на редактирование документа и он не является автором предложения.

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

string

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

DeleteSuggestionRequest

Удаляет подсказку.

Возвращает ошибку 403 (запрещено), если пользователь, отправивший запрос, не является автором предложения.

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

string

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

CreateDropdownDefinitionRequest

Создает новый объект DropdownDefinition в документе.

JSON-представление 
{
  "dropdownDefinition": {
    object (DropdownDefinition)
  },
  "tabId": string
}
Поля
dropdownDefinition

object (DropdownDefinition)

Обязательно. DropdownDefinition.

tabId

string

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

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

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

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

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

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

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

UpdateDropdownDefinitionPropertiesRequest

Обновляет свойства DropdownDefinition.

JSON-представление 
{
  "dropdownDefinitionId": string,
  "tabId": string,
  "dropdownDefinitionProperties": {
    object (DropdownDefinitionProperties)
  },
  "selectedOptionIdReplacements": {
    string: string,
    ...
  },
  "fields": string
}
Поля
dropdownDefinitionId

string

Идентификатор объекта DropdownDefinition, который нужно обновить.

tabId

string

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

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

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

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

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

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

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

dropdownDefinitionProperties

object (DropdownDefinitionProperties)

Свойства, которые нужно обновить.

selectedOptionIdReplacements

map (key: string, value: string)

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

Ключи – это идентификаторы удаляемых вариантов, а значения – идентификаторы вариантов, которыми они заменяются. Если удаляемый вариант выбран в одном или нескольких чипах Dropdown в документе, в этой карте необходимо указать замену для этого варианта, а идентификатор варианта замены должен существовать в обновленном чипе DropdownDefinition. Если замена обязательна, но не указана, возвращается ошибка 400 (недопустимый запрос). Варианты, которые удаляются, но не выбраны ни в одном из чипов, не требуют замены.Dropdown

Например, если вариант А заменяется вариантом Б, карта должна быть следующей: {"A": "B"}.

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент dropdownDefinitionProperties подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

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

InsertDropdownRequest

Вставляет Dropdown в указанное место.

JSON-представление 
{
  "dropdownDefinitionId": string,
  "selectedOptionId": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Поля
dropdownDefinitionId

string

Обязательно. Идентификатор DropdownDefinition.

selectedOptionId

string

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

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

object (Location)

Объект Location в документе, в который нужно вставить раскрывающийся список.

endOfSegmentLocation

object (EndOfSegmentLocation)

Объект EndOfSegmentLocation в документе, в который нужно вставить раскрывающийся список.

Конец взаимоисключающих полей.

UpdateDropdownPropertiesRequest

Обновляет свойства Dropdown.

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

string

Обязательно. Идентификатор.Dropdown

tabId

string

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

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

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

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

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

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

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

dropdownProperties

object (DropdownProperties)

Свойства, которые нужно обновить.

fields

string (FieldMask format)

Поля, которые нужно обновить.

Укажите хотя бы одно поле. Корневой элемент dropdownProperties подразумевается и не должен быть указан. Один тег "*" можно использовать вместо перечисления всех полей.

DeleteDropdownDefinitionRequest

Удаляет DropdownDefinition.

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

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

string

Идентификатор объекта DropdownDefinition, который нужно удалить.

tabId

string

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

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

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

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

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

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

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