Эта страница переведена с помощью 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`) }, "addDocumentTab": { object (`AddDocumentTabRequest`) }, "deleteTab": { object (`DeleteTabRequest`) }, "updateDocumentTabProperties": { object (`UpdateDocumentTabPropertiesRequest`) }, "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)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "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 )` Обновляет количество закрепленных строк заголовка в таблице.
`addDocumentTab`	`object ( AddDocumentTabRequest )` Добавляет вкладку документа.
`deleteTab`	`object ( DeleteTabRequest )` Удаляет вкладку документа.
`updateDocumentTabProperties`	`object ( UpdateDocumentTabPropertiesRequest )` Обновляет свойства вкладки документа.
`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 : поисковый текст рассматривается как подстрока для сопоставления.

TabsCriteria

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

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

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

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

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

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

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

КонецСегментЛокация

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

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 : Заглавная буква, например, «А», «В» или «С».
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` для первых 3 уровней вложенности списка.
`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` для первых 3 уровней вложенности списка.
`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` Имя именованного диапазона (NamedRange). Имена не обязательно должны быть уникальными. Имена должны содержать не менее 1 символа и не более 256 символов, измеренных в кодовых единицах UTF-16.
`range`	`object ( Range )` Диапазон, к которому применяется имя.

name

string

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

Имена должны содержать не менее 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 (bad request). Примерами недействительных запросов на удаление являются: Удаление одного кодового блока из суррогатной пары. Удаление последнего символа новой строки в элементах `Body` , `Header` , `Footer` , `Footnote` , `TableCell` или `TableOfContents` . Удаление начала или конца `Table` , `TableOfContents` или `Equation` без удаления всего элемента. Удаление символа новой строки перед `Table` , `TableOfContents` или `SectionBreak` без удаления самого элемента. Удаление отдельных строк или ячеек таблицы. Допускается удаление содержимого ячейки таблицы.

range

object ( Range )

Диапазон контента, подлежащего удалению.

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

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

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

Удаление одного кодового блока из суррогатной пары.
Удаление последнего символа новой строки в элементах 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 : вставить над ячейкой.

Расположение ячейки таблицы

Расположение отдельной ячейки в таблице.

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

Диапазон таблиц

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

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

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

Диапазон таблицы с параметрами table Cell Location = (tableStartLocation, row = 0, column = 0), row span = 3 и column span = 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` Вкладка, на которой находится изображение, подлежащее замене. Если этот параметр отсутствует, запрос применяется к первой вкладке. В документе, содержащем одну вкладку: Если указано, идентификатор должен совпадать с идентификатором вкладки в единственном числе. Если этот параметр отсутствует, запрос применяется к вкладке в единственном числе. В документе, содержащем несколько вкладок: Если запрос указан, он применяется к указанной вкладке. Если этот параметр отсутствует, запрос применяется к первой вкладке документа.

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

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

Перечисления

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 )

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

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

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

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

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

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 (bad request).
`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 )` Вставляет перевод строки и разрыв раздела в конец основного текста документа. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the `segment ID` field must be empty.

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.

AddDocumentTabRequest

Adds a document tab. When a tab is added at a given index, all subsequent tabs' indexes are incremented.

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

Поля

tabProperties

object ( TabProperties )

The properties of the tab to add. All properties are optional.

DeleteTabRequest

Deletes a tab. If the tab has child tabs, they are deleted as well.

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

Поля

tabId

string

The ID of the tab to delete.

UpdateDocumentTabPropertiesRequest

Update the properties of a document tab.

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

Поля

tabProperties

object ( TabProperties )

The tab properties to update.

fields

string ( FieldMask format)

The fields that should be updated.

At least one field must be specified. The root tabProperties is implied and should not be specified. A single "*" can be used as short-hand for listing every field.

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

TabsCriteria

InsertTextRequest

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

КонецСегментЛокация

UpdateTextStyleRequest

CreateParagraphBulletsRequest

BulletGlyphPreset

DeleteParagraphBulletsRequest

CreateNamedRangeRequest

DeleteNamedRangeRequest

UpdateParagraphStyleRequest

DeleteContentRangeRequest

InsertInlineImageRequest

InsertTableRequest

InsertTableRowRequest

Расположение ячейки таблицы

InsertTableColumnRequest

DeleteTableRowRequest

DeleteTableColumnRequest

InsertPageBreakRequest

DeletePositionedObjectRequest

UpdateTableColumnPropertiesRequest

UpdateTableCellStyleRequest

Диапазон таблиц

UpdateTableRowStyleRequest

ReplaceImageRequest

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

UpdateDocumentStyleRequest

MergeTableCellsRequest

UnmergeTableCellsRequest

CreateHeaderRequest

HeaderFooterType

CreateFooterRequest

CreateFootnoteRequest

ReplaceNamedRangeContentRequest

UpdateSectionStyleRequest

InsertSectionBreakRequest

DeleteHeaderRequest

DeleteFooterRequest

PinTableHeaderRowsRequest

AddDocumentTabRequest

DeleteTabRequest

UpdateDocumentTabPropertiesRequest

InsertPersonRequest

Requests