Эта страница переведена с помощью Cloud Translation API.

Requests

Запрос

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

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

JSON-представление
{ // Union field `request` can be only one of the following: "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`) }, "insertPerson": { object (`InsertPersonRequest`) } // End of list of possible types for union field `request`. }

{

  // Union field request can be only one of the following:
  "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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}

Поля
`request` на объединение полей. Конкретный запрос, который необходимо применить. Требуется только одно поле. `request` может быть только одним из следующих:
`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 )` Обновляет количество закрепленных строк заголовков в таблице.
`insertPerson`	`object ( InsertPersonRequest )` Вставляет упоминание о человеке.

ReplaceAllTextRequest

Заменяет все вхождения текста, соответствующего критерию, на replace text .

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

JSON-представление
{ "replaceText": string, "tabsCriteria": { object (`TabsCriteria`) }, // Union field `criteria` can be only one of the following: "containsText": { object (`SubstringMatchCriteria`) } // End of list of possible types for union field `criteria`. }

{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}

Поля
`replaceText`	`string` Текст, который заменит совпадающий текст.
`tabsCriteria`	`object ( TabsCriteria )` Необязательно. Критерии, используемые для указания вкладок, в которых происходит замена. Если этот параметр пропущен, замена применяется ко всем вкладкам. В документе, содержащем одну вкладку: Если указан, должен соответствовать идентификатору единственной вкладки. Если этот параметр пропущен, замена применяется к единственной вкладке. В документе, содержащем несколько вкладок: Если предусмотрено, замена применяется к указанным вкладкам. Если параметр пропущен, замена применяется ко всем вкладкам.
`criteria` поля объединения. Критерии, используемые для сопоставления текста для замены. `criteria` могут быть только одними из следующих:
`containsText`	`object ( SubstringMatchCriteria )` Находит текст в документе, соответствующий данной подстроке.

SubstringMatchCriteria

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

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

Поля

Поля
`text`	`string` Текст для поиска в документе.
`matchCase`	`boolean` Указывает, следует ли учитывать регистр при поиске: `True` : поиск чувствителен к регистру. `False` : поиск нечувствителен к регистру.
`searchByRegex`	`boolean` Необязательно. Значение true, если искомое значение следует обрабатывать как регулярное выражение. Любые обратные косые черты в шаблоне следует экранировать. `True` : искомый текст обрабатывается как регулярное выражение. `False` : искомый текст рассматривается как подстрока для сопоставления.

text

string

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

matchCase

boolean

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

True : поиск чувствителен к регистру.
False : поиск нечувствителен к регистру.

searchByRegex

boolean

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

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

ВкладкиКритерии

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

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

Поля

Поля
`tabIds[]`	`string` Список идентификаторов вкладок, в которых выполняется запрос.

tabIds[]

string

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

InsertTextRequest

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

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

JSON-представление
{ "text": string, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`text`	`string` Текст, который будет вставлен. Вставка символа новой строки автоматически создаст новый `Paragraph` с этой позицией. Стиль нового абзаца будет скопирован из абзаца с текущей позицией вставки, включая списки и маркеры. Стили текста для вставленного текста определяются автоматически, как правило, сохраняя стиль соседнего текста. В большинстве случаев стиль текста для вставленного текста будет соответствовать стилю текста непосредственно перед индексом вставки. Некоторые управляющие символы (U+0000–U+0008, U+000C–U+001F) и символы из области частного использования Unicode Basic Multilingual Plane (U+E000–U+F8FF) будут удалены из вставленного текста.
Поле объединения `insertion_location` . Место, куда будет вставлен текст. `insertion_location` может быть только одним из следующих:
`location`	`object ( Location )` Вставляет текст в указанную позицию документа. Текст должен быть вставлен внутри границ существующего `Paragraph` . Например, текст не может быть вставлен в начальный индекс таблицы (то есть между таблицей и предыдущим абзацем). Текст должен быть вставлен в предыдущий абзац.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Вставляет текст в конец верхнего колонтитула, нижнего колонтитула, сноски или тела документа.

Расположение

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

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

Поля

Поля
`segmentId`	`string` Идентификатор верхнего, нижнего колонтитула или сноски, в которой находится местоположение. Пустой идентификатор сегмента обозначает тело документа.
`index`	`integer` Индекс, отсчитываемый от нуля, в кодировке UTF-16. Индекс указывается относительно начала сегмента, указанного `segmentId` .
`tabId`	`string` Вкладка, в которой находится местоположение. Если этот параметр пропущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку: Если указан, должен соответствовать идентификатору единственной вкладки. Если этот параметр пропущен, запрос применяется к единственной вкладке. В документе, содержащем несколько вкладок: Если указано, запрос относится к указанной вкладке. Если этот параметр пропущен, запрос применяется к первой вкладке документа.

segmentId

string

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

index

integer

Индекс, отсчитываемый от нуля, в кодировке UTF-16.

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

tabId

string

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

В документе, содержащем одну вкладку:

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

В документе, содержащем несколько вкладок:

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

EndOfSegmentLocation

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

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

Поля

Поля
`segmentId`	`string` Идентификатор верхнего, нижнего колонтитула или сноски, в которой находится местоположение. Пустой идентификатор сегмента обозначает тело документа.
`tabId`	`string` Вкладка, в которой находится местоположение. Если этот параметр пропущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку: Если указан, должен соответствовать идентификатору единственной вкладки. Если этот параметр пропущен, запрос применяется к единственной вкладке. В документе, содержащем несколько вкладок: Если указано, запрос относится к указанной вкладке. Если этот параметр пропущен, запрос применяется к первой вкладке документа.

segmentId

string

tabId

string

В документе, содержащем одну вкладку:

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

В документе, содержащем несколько вкладок:

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

UpdateTextStyleRequest

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

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

JSON-представление
{ "textStyle": { object (`TextStyle`) }, "fields": string, // Union field `insertion_location` can be only one of the following: "range": { object (`Range`) } // End of list of possible types for union field `insertion_location`. }

{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`textStyle`	`object ( TextStyle )` Стили, применяемые к тексту. Если значение определенного стиля совпадает со значением родительского стиля, этот стиль будет установлен как наследование. Некоторые изменения стиля текста могут повлечь за собой другие изменения, чтобы отразить поведение редактора Docs. Подробнее см. в документации по `TextStyle` .
`fields`	`string ( FieldMask format)` Поля, которые следует обновить. Необходимо указать хотя бы одно поле. Корневой `textStyle` подразумевается и не должен быть указан. Для обозначения всех полей можно использовать один `"*"` . Например, чтобы сделать текст полужирным, установите для `fields` значение `"bold"` . Чтобы сбросить свойство до значения по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.
Поле объединения `insertion_location` . Тип диапазона, используемого для обновления стиля текста. `insertion_location` может быть только одним из следующих:
`range`	`object ( Range )` Диапазон текста для стилизации. Диапазон может быть расширен за счет включения смежных символов переноса строк. Если диапазон полностью содержит абзац, принадлежащий списку, маркер абзаца также обновляется с использованием соответствующего стиля текста. Диапазоны не могут быть вставлены внутрь относительного UpdateTextStyleRequest.

CreateParagraphBulletsRequest

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

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

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

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

Поля

Поля
`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 : ромб с символом «x», соответствующий кодовой точке Unicode U+2756.
HOLLOWDIAMOND : полый ромб, соответствующий кодовой точке Unicode U+25c7
DISC : сплошной круг, соответствующий кодовой точке Unicode U+25cf.
SQUARE : Закрашенный квадрат, соответствующий кодовой точке Unicode U+25a0.
STAR : Звезда, соответствующая кодовой точке Unicode U+2605.
ALPHA : строчная буква, например «а», «б» или «в».
UPPERALPHA : Заглавная буква, например «A», «B» или «C».
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 )` Диапазон, из которого следует удалить маркеры.

range

object ( Range )

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

CreateNamedRangeRequest

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

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

Поля

Поля
`name`	`string` Имя именованного диапазона. Имена не обязательно должны быть уникальными. Имена должны содержать не менее 1 и не более 256 символов в кодировке UTF-16.
`range`	`object ( Range )` Диапазон, к которому следует применить имя.

name

string

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

Имена должны содержать не менее 1 и не более 256 символов в кодировке UTF-16.

range

object ( Range )

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

DeleteNamedRangeRequest

Удаляет NamedRange .

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

JSON-представление
{ "tabsCriteria": { object (`TabsCriteria`) }, // Union field `named_range_reference` can be only one of the following: "namedRangeId": string, "name": string // End of list of possible types for union field `named_range_reference`. }

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}

Поля
`tabsCriteria`	`object ( TabsCriteria )` Необязательный. Критерий, используемый для указания вкладок, на которых должно произойти удаление диапазона. Если этот параметр не указан, удаление диапазона применяется ко всем вкладкам. В документе, содержащем одну вкладку: Если указан, должен соответствовать идентификатору единственной вкладки. Если этот параметр пропущен, удаление диапазона применяется к единственной вкладке. В документе, содержащем несколько вкладок: Если указано, удаление диапазона применяется к указанным вкладкам. Если не указано иное, удаление диапазона применяется ко всем вкладкам.
Поле объединения `named_range_reference` . Значение, определяющее, какой диапазон или диапазоны следует удалить. Необходимо указать только одно значение. `named_range_reference` может принимать только одно из следующих значений:
`namedRangeId`	`string` Идентификатор именованного диапазона, который необходимо удалить.
`name`	`string` Имя диапазона(ов), который нужно удалить. Все именованные диапазоны с заданным именем будут удалены.

UpdateParagraphStyleRequest

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

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

JSON-представление
{ "paragraphStyle": { object (`ParagraphStyle`) }, "fields": string, // Union field `insertion_location` can be only one of the following: "range": { object (`Range`) } // End of list of possible types for union field `insertion_location`. }

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`paragraphStyle`	`object ( ParagraphStyle )` Стили, устанавливаемые для абзацев. Некоторые изменения стиля абзаца могут повлечь за собой другие изменения, чтобы отразить поведение редактора Docs. Подробнее см. в документации `ParagraphStyle` .
`fields`	`string ( FieldMask format)` Поля, которые следует обновить. Необходимо указать хотя бы одно поле. Корневой `paragraphStyle` подразумевается и не должен быть указан. Для обозначения всех полей можно использовать один `"*"` . Например, чтобы обновить свойство выравнивания стиля абзаца, задайте `fields` значение `"alignment"` . Чтобы сбросить свойство до значения по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.
Поле объединения `insertion_location` . Тип диапазона, используемого для обновления стиля абзаца. `insertion_location` может быть только одним из следующих:
`range`	`object ( Range )` Диапазон перекрытия абзацев для стилизации.

DeleteContentRangeRequest

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

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

Поля

Поля
`range`	`object ( Range )` Диапазон удаляемого контента. Удаление текста, выходящего за границу абзаца, может привести к изменению стилей абзацев, списков, позиционированных объектов и закладок при объединении двух абзацев. Попытка удалить определенные диапазоны может привести к недопустимой структуре документа, в этом случае будет возвращена ошибка 400 (неверный запрос). Вот некоторые примеры недействительных запросов на удаление: Удаление одной кодовой единицы суррогатной пары. Удаление последнего символа новой строки в `Body` , `Header` , `Footer` , `Footnote` , `TableCell` или `TableOfContents` . Удаление начала или конца `Table` , `TableOfContents` или `Equation` без удаления всего элемента. Удаление символа новой строки перед `Table` , `TableOfContents` или `SectionBreak` без удаления элемента. Удаление отдельных строк или ячеек таблицы. Разрешено удаление содержимого ячеек таблицы.

range

object ( Range )

Диапазон удаляемого контента.

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

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

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

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

InsertInlineImageRequest

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

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

JSON-представление
{ "uri": string, "objectSize": { object (`Size`) }, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`uri`	`string` URI изображения. Изображение загружается один раз при вставке, и его копия сохраняется для отображения в документе. Размер изображения должен быть менее 50 МБ, разрешение не должно превышать 25 мегапикселей, а формат должен быть одним из PNG, JPEG или GIF. Предоставленный URI должен быть общедоступным и иметь длину не более 2 КБ. Сам URI сохраняется вместе с изображением и отображается через поле `ImageProperties.content_uri` .
`objectSize`	`object ( Size )` Размер, в котором изображение должно отображаться в документе. Это свойство необязательно, и окончательный размер изображения в документе определяется следующими правилами: * Если не указаны ни ширина, ни высота, то размер изображения по умолчанию рассчитывается на основе его разрешения. * Если указан один размер, то другой размер рассчитывается для сохранения соотношения сторон изображения. * Если указаны и ширина, и высота, изображение масштабируется до указанных размеров с сохранением соотношения сторон.
Поле объединения `insertion_location` . Место, куда будет вставлено изображение. `insertion_location` может быть только одним из следующих:
`location`	`object ( Location )` Вставляет изображение в указанную позицию документа. Изображение должно быть вставлено в границы существующего `Paragraph` . Например, его нельзя вставить в начальный индекс таблицы (то есть между таблицей и предшествующим ей абзацем). Встроенные изображения нельзя вставлять внутрь сноски или уравнения.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Вставляет текст в конец верхнего колонтитула или тела документа. Встроенные изображения нельзя вставлять внутрь сноски.

InsertTableRequest

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

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

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

JSON-представление
{ "rows": integer, "columns": integer, // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`rows`	`integer` Количество строк в таблице.
`columns`	`integer` Количество столбцов в таблице.
Поле объединения `insertion_location` . Место, куда будет вставлена таблица. `insertion_location` может быть только одним из следующих:
`location`	`object ( Location )` Вставляет таблицу в определенный модельный индекс. Перед вставленной таблицей будет вставлен символ новой строки, поэтому начальный индекс таблицы будет находиться в указанном месте index + 1. Таблица должна быть вставлена в границы существующего `Paragraph` . Например, её нельзя вставить в начальный индекс таблицы (т.е. между существующей таблицей и предшествующим ей абзацем). Таблицы нельзя вставлять внутрь сноски или уравнения.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Вставляет таблицу в конец указанного верхнего, нижнего колонтитула или тела документа. Перед вставленной таблицей будет вставлен символ новой строки. Таблицы не могут быть вставлены внутрь сноски.

InsertTableRowRequest

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

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

Поля

Поля
`tableCellLocation`	`object ( TableCellLocation )` Местоположение ячейки таблицы ссылок, из которой будут вставлены строки. Новая строка будет вставлена над (или под) строкой, где находится ячейка ссылки. Если ячейка ссылки является объединённой, новая строка будет вставлена над (или под) объединённой ячейкой.
`insertBelow`	`boolean` Вставлять ли новую строку под ячейкой ссылки. `True` : вставить под ячейкой. `False` : вставить над ячейкой.

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` : вставить слева.

tableCellLocation

object ( TableCellLocation )

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

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

insertRight

boolean

Вставлять ли новый столбец справа от опорной ячейки.

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

DeleteTableRowRequest

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

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

Поля

Поля
`tableCellLocation`	`object ( TableCellLocation )` Местоположение ячейки таблицы, из которой будет удалена строка. Строка, которую занимает эта ячейка, будет удалена. Если это объединённая ячейка, охватывающая несколько строк, все строки, которые занимает ячейка, будут удалены. Если после этого удаления в таблице не останется ни одной строки, удаляется вся таблица.

tableCellLocation

object ( TableCellLocation )

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

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

DeleteTableColumnRequest

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

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

Поля

Поля
`tableCellLocation`	`object ( TableCellLocation )` Местоположение ячейки таблицы, из которой будет удален столбец. Столбец, занимаемый этой ячейкой, будет удалён. Если это объединённая ячейка, занимающая несколько столбцов, все занимаемые ею столбцы будут удалены. Если после удаления в таблице не останется ни одного столбца, удаляется вся таблица.

tableCellLocation

object ( TableCellLocation )

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

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

InsertPageBreakRequest

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

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

JSON-представление
{ // Union field `insertion_location` can be only one of the following: "location": { object (`Location`) }, "endOfSegmentLocation": { object (`EndOfSegmentLocation`) } // End of list of possible types for union field `insertion_location`. }

{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля

Поля
Поле объединения `insertion_location` . Место, куда будет вставлен разрыв страницы. `insertion_location` может быть только одним из следующих:
`location`	`object ( Location )` Вставляет разрыв страницы в указанную позицию документа. Разрыв страницы должен быть вставлен внутри границ существующего `Paragraph` . Например, его нельзя вставить в начальный индекс таблицы (т. е. между таблицей и предшествующим ей абзацем). Разрывы страниц нельзя вставлять внутрь таблицы, формулы, сноски, верхнего или нижнего колонтитула. Поскольку разрывы страниц можно вставлять только внутри основного текста, поле `segment ID` должно быть пустым.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Вставляет разрыв страницы в конец текста документа. Разрывы страниц нельзя вставлять внутри сноски, верхнего или нижнего колонтитула. Поскольку разрывы страниц можно вставлять только внутри основного текста, поле `segment ID` должно быть пустым.

Поле объединения insertion_location . Место, куда будет вставлен разрыв страницы. insertion_location может быть только одним из следующих:

location

object ( Location )

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

DeletePositionedObjectRequest

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

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

Поля

Поля
`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-представление

JSON-представление
{ "tableCellStyle": { object (`TableCellStyle`) }, "fields": string, // Union field `cells` can be only one of the following: "tableRange": { object (`TableRange`) }, "tableStartLocation": { object (`Location`) } // End of list of possible types for union field `cells`. }

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}

Поля
`tableCellStyle`	`object ( TableCellStyle )` Стиль, устанавливаемый для ячеек таблицы. При обновлении границ, если ячейка имеет общую границу с соседней ячейкой, соответствующее свойство границы соседней ячейки также обновляется. Границы, которые объединены и невидимы, не обновляются. Поскольку обновление границы, общей для соседних ячеек в одном запросе, может привести к конфликтующим обновлениям границы, обновления границы применяются в следующем порядке: `borderRight` `borderLeft` `borderBottom` `borderTop`
`fields`	`string ( FieldMask format)` Поля, которые следует обновить. Необходимо указать хотя бы одно поле. Корневой `tableCellStyle` подразумевается и не должен быть указан. Для обозначения всех полей можно использовать один символ `"*"` . Например, чтобы обновить цвет фона ячейки таблицы, задайте `fields` значение `"backgroundColor"` . Чтобы сбросить свойство до значения по умолчанию, включите имя его поля в маску поля, но оставьте само поле неустановленным.
`cells` поля объединения. Ячейки, которые будут обновлены. `cells` могут быть только одними из следующих:
`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 из существующего изображения, чтобы отразить поведение редактора Docs.

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 )

Стили, устанавливаемые для документа.

Некоторые изменения стиля документа могут повлечь за собой другие изменения, чтобы отразить поведение редактора Docs. Подробнее см. в документации 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 )

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

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

Если в какой-либо из объединённых ячеек есть текст, он останется в «головной» ячейке результирующего блока необъединённых ячеек. «Головной» ячейкой считается верхняя левая ячейка, если содержимое направлено слева направо, и верхняя правая в противном случае.

CreateHeaderRequest

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

Если заголовок указанного типа уже существует, возвращается ошибка 400 bad request.

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

Поля

type

enum ( HeaderFooterType )

Тип создаваемого заголовка.

sectionBreakLocation

object ( Location )

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

HeaderFooterType

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

Перечисления
`HEADER_FOOTER_TYPE_UNSPECIFIED`	Тип верхнего/нижнего колонтитула не указан.
`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-представление

{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}

Поля

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

location

object ( Location )

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

ReplaceNamedRangeContentRequest

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

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

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

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

{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}

Поля
`tabsCriteria`	`object ( TabsCriteria )` Необязательный. Критерий, используемый для указания вкладок, в которых происходит замена. Если не указан, замена применяется ко всем вкладкам. В документе, содержащем одну вкладку: Если указан, должен соответствовать идентификатору единственной вкладки. Если этот параметр пропущен, замена применяется к единственной вкладке. В документе, содержащем несколько вкладок: Если предусмотрено, замена применяется к указанным вкладкам. Если параметр пропущен, замена применяется ко всем вкладкам.
Поле объединения `replacement_content` . Содержимое, которым заменяется существующее содержимое указанного диапазона. `replacement_content` может быть только одним из следующих:
`text`	`string` Заменяет содержимое указанного именованного диапазона(ов) заданным текстом.
Поле объединения `named_range_reference` . Ссылка на именованный(е) диапазон(ы), содержимое которого будет заменено. `named_range_reference` может быть только одним из следующих:
`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),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`sectionType`	`enum ( SectionType )` Тип раздела для вставки.
Поле объединения `insertion_location` . Место, куда будет вставлен разрыв. `insertion_location` может быть только одним из следующих:
`location`	`object ( Location )` Вставляет новую строку и разрыв раздела в указанной позиции документа. Разрыв раздела должен быть вставлен внутри границ существующего `Paragraph` . Например, его нельзя вставить в начальный индекс таблицы (то есть между таблицей и предшествующим ей абзацем). Разрывы разделов нельзя вставлять внутрь таблицы, формулы, сноски, верхнего или нижнего колонтитула. Поскольку разрывы разделов можно вставлять только внутри основного текста, поле `segment ID` должно быть пустым.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Вставляет новую строку и разрыв раздела в конец текста документа. Разрывы разделов нельзя вставлять внутри сноски, верхнего или нижнего колонтитула. Поскольку разрывы разделов можно вставлять только внутри основного текста, поле `segment ID` должно быть пустым.

DeleteHeaderRequest

Deletes a Header from the document.

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

Поля

headerId

string

The id of the header to delete. If this header is defined on DocumentStyle , the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle , the reference to this header is removed and the header of that type is now continued from the previous section.

tabId

string

The tab containing the header to delete. When omitted, the request is applied 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.

DeleteFooterRequest

Deletes a Footer from the document.

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

Поля

footerId

string

The id of the footer to delete. If this footer is defined on DocumentStyle , the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle , the reference to this footer is removed and the footer of that type is now continued from the previous section.

tabId

string

The tab that contains the footer to delete. When omitted, the request is applied 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.

PinTableHeaderRowsRequest

Updates the number of pinned table header rows in a table.

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

Поля

tableStartLocation

object ( Location )

The location where the table starts in the document.

pinnedHeaderRowsCount

integer

The number of table rows to pin, where 0 implies that all rows are unpinned.

InsertPersonRequest

Inserts a person mention.

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

{
  "personProperties": {
    object (PersonProperties)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}

Поля
`personProperties`	`object ( PersonProperties )` The properties of the person mention to insert.
Union field `insertion_location` . The location where the person mention will be inserted. `insertion_location` can be only one of the following:
`location`	`object ( Location )` Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing `Paragraph` . For instance, it cannot be inserted at a table's start index (ie between the table and its preceding paragraph). Person mentions cannot be inserted inside an equation.
`endOfSegmentLocation`	`object ( EndOfSegmentLocation )` Inserts the person mention at the end of a header, footer, footnote or the document body.

Requests Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Запрос

ReplaceAllTextRequest

SubstringMatchCriteria

ВкладкиКритерии

InsertTextRequest

Расположение

EndOfSegmentLocation

UpdateTextStyleRequest

CreateParagraphBulletsRequest

BulletGlyphPreset

DeleteParagraphBulletsRequest

CreateNamedRangeRequest

DeleteNamedRangeRequest

UpdateParagraphStyleRequest

DeleteContentRangeRequest

InsertInlineImageRequest

InsertTableRequest

InsertTableRowRequest

TableCellLocation

InsertTableColumnRequest

DeleteTableRowRequest

DeleteTableColumnRequest

InsertPageBreakRequest

DeletePositionedObjectRequest

UpdateTableColumnPropertiesRequest

UpdateTableCellStyleRequest

TableRange

UpdateTableRowStyleRequest

ReplaceImageRequest

ImageReplaceMethod

UpdateDocumentStyleRequest

MergeTableCellsRequest

UnmergeTableCellsRequest

CreateHeaderRequest

HeaderFooterType

CreateFooterRequest

CreateFootnoteRequest

ReplaceNamedRangeContentRequest

UpdateSectionStyleRequest

InsertSectionBreakRequest

DeleteHeaderRequest

DeleteFooterRequest

PinTableHeaderRowsRequest

InsertPersonRequest

Requests