Запрос
Одно обновление для применения к документу.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
request поля объединения. Конкретный запрос для подачи заявления. Требуется ровно одно поле. request может быть только одним из следующих: | |
replaceAllText | Заменяет все экземпляры указанного текста. |
insertText | Вставляет текст в указанное место. |
updateTextStyle | Обновляет стиль текста в указанном диапазоне. |
createParagraphBullets | Создает маркеры для абзацев. |
deleteParagraphBullets | Удаляет маркеры из абзацев. |
createNamedRange | Создает именованный диапазон. |
deleteNamedRange | Удаляет именованный диапазон. |
updateParagraphStyle | Обновляет стиль абзаца в указанном диапазоне. |
deleteContentRange | Удаляет содержимое из документа. |
insertInlineImage | Вставляет встроенное изображение в указанное место. |
insertTable | Вставляет таблицу в указанное место. |
insertTableRow | Вставляет пустую строку в таблицу. |
insertTableColumn | Вставляет пустой столбец в таблицу. |
deleteTableRow | Удаляет строку из таблицы. |
deleteTableColumn | Удаляет столбец из таблицы. |
insertPageBreak | Вставляет разрыв страницы в указанном месте. |
deletePositionedObject | Удаляет позиционированный объект из документа. |
updateTableColumnProperties | Обновляет свойства столбцов в таблице. |
updateTableCellStyle | Обновляет стиль ячеек таблицы. |
updateTableRowStyle | Обновляет стиль строк в таблице. |
replaceImage | Заменяет изображение в документе. |
updateDocumentStyle | Обновляет стиль документа. |
mergeTableCells | Объединяет ячейки в таблице. |
unmergeTableCells | Разъединяет ячейки в таблице. |
createHeader | Создает заголовок. |
createFooter | Создает нижний колонтитул. |
createFootnote | Создает сноску. |
replaceNamedRangeContent | Заменяет содержимое в именованном диапазоне. |
updateSectionStyle | Обновляет стиль раздела указанного диапазона. |
insertSectionBreak | Вставляет разрыв раздела в указанном месте. |
deleteHeader | Удаляет заголовок из документа. |
deleteFooter | Удаляет нижний колонтитул из документа. |
pinTableHeaderRows | Обновляет количество закрепленных строк заголовков в таблице. |
ЗаменитьAllTextRequest
Заменяет все экземпляры текста, соответствующие критерию, на replace text
.
JSON-представление |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Поля | |
---|---|
replaceText | Текст, который заменит совпавший текст. |
tabsCriteria | Необязательный. Критерии, используемые для указания, на каких вкладках происходит замена. Если этот параметр опущен, замена применяется ко всем вкладкам. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
criteria поля Союза. Критерии, используемые для сопоставления заменяемого текста. criteria может быть только один из следующих: | |
containsText | Находит текст в документе, соответствующий этой подстроке. |
ПодстрокаMatchCriteria
Критерий, соответствующий определенной строке текста в документе.
JSON-представление |
---|
{ "text": string, "matchCase": boolean } |
Поля | |
---|---|
text | Текст для поиска в документе. |
matchCase | Указывает, должен ли поиск учитывать регистр:
|
ВкладкиКритерии
Критерий, определяющий, на каких вкладках выполняется запрос.
JSON-представление |
---|
{ "tabIds": [ string ] } |
Поля | |
---|---|
tabIds[] | Список идентификаторов вкладок, в которых выполняется запрос. |
Вставитьтекстовый запрос
Вставляет текст в указанное место.
JSON-представление |
---|
{ "text": string, // Union field |
Поля | |
---|---|
text | Текст, который необходимо вставить. Вставка символа новой строки неявно создаст новый Стили текста для вставленного текста будут определяться автоматически, как правило, с сохранением стиля соседнего текста. В большинстве случаев стиль вставленного текста будет соответствовать тексту непосредственно перед индексом вставки. Некоторые управляющие символы (U+0000–U+0008, U+000C–U+001F) и символы из области частного использования базовой многоязычной плоскости Unicode (U+E000–U+F8FF) будут удалены из вставленного текста. |
Поле объединения insertion_location . Место, куда будет вставлен текст. insertion_location может быть только одним из следующих: | |
location | Вставляет текст по определенному индексу в документе. Текст должен быть вставлен внутри границ существующего |
endOfSegmentLocation | Вставляет текст в конец верхнего, нижнего колонтитула, сноски или тела документа. |
Расположение
Определенное место в документе.
JSON-представление |
---|
{ "segmentId": string, "index": integer, "tabId": string } |
Поля | |
---|---|
segmentId | Идентификатор верхнего, нижнего колонтитула или сноски, в которой находится местоположение. Пустой идентификатор сегмента обозначает тело документа. |
index | Индекс, отсчитываемый от нуля, в кодовых единицах UTF-16. Индекс задается относительно начала сегмента, указанного в |
tabId | Вкладка, на которой находится местоположение. Если этот параметр опущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
КонецОфСегментЛокейшн
Расположение в конце тела, заголовка, нижнего колонтитула или сноски. Это расположение находится непосредственно перед последней новой строкой в сегменте документа.
JSON-представление |
---|
{ "segmentId": string, "tabId": string } |
Поля | |
---|---|
segmentId | Идентификатор верхнего, нижнего колонтитула или сноски, в которой находится местоположение. Пустой идентификатор сегмента обозначает тело документа. |
tabId | Вкладка, на которой находится местоположение. Если этот параметр опущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
UpdateTextStyleRequest
Обновите стиль текста.
JSON-представление |
---|
{ "textStyle": { object ( |
Поля | |
---|---|
textStyle | Стили, которые можно установить для текста. Если значение определенного стиля совпадает со значением родительского стиля, этот стиль будет наследовать. Определенные изменения стиля текста могут привести к другим изменениям, отражающим поведение редактора Документов. Дополнительную информацию смотрите в документации |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы изменить стиль текста на полужирный, установите для Чтобы вернуть свойству значение по умолчанию, включите имя его поля в маску поля, но оставьте само поле незаданным. |
Поле объединения insertion_location . Тип диапазона, в котором будет обновляться стиль текста. insertion_location может быть только одним из следующих: | |
range | Диапазон текста для стиля. Диапазон может быть расширен за счет включения соседних символов новой строки. Если диапазон полностью содержит абзац, принадлежащий списку, маркер абзаца также обновляется с использованием соответствующего стиля текста. Диапазоны нельзя вставлять внутри относительного UpdateTextStyleRequest. |
CreateParagraphBulletsRequest
Создает маркеры для всех абзацев, пересекающихся с заданным диапазоном.
Уровень вложенности каждого абзаца будет определяться путем подсчета табуляции перед каждым абзацем. Чтобы избежать лишнего пространства между маркером и соответствующим абзацем, эти ведущие табуляции удаляются по этому запросу. При этом могут измениться индексы частей текста.
Если абзац непосредственно перед обновляемыми абзацами находится в списке с соответствующим набором настроек, обновляемые абзацы добавляются к этому предыдущему списку.
JSON-представление |
---|
{ "range": { object ( |
Поля | |
---|---|
range | Диапазон, к которому будет применена предустановка маркера. |
bulletPreset | Виды маркеров, которые будут использоваться. |
ПуляГлифПресет
Предустановленные шаблоны глифов для списков.
В этих шаблонах используются следующие типы маркеров:
-
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 цифровыми глифами для первых трех уровней вложенности списка, за которыми следуют точки. |
Удалить абзац. Запрос маркеров.
Удаляет маркеры из всех абзацев, пересекающихся с заданным диапазоном.
Уровень вложенности каждого абзаца будет визуально сохранен путем добавления отступа в начало соответствующего абзаца.
JSON-представление |
---|
{
"range": {
object ( |
Поля | |
---|---|
range | Диапазон, из которого удаляются пули. |
CreateNamedRangeRequest
Создает NamedRange
ссылающийся на заданный диапазон.
JSON-представление |
---|
{
"name": string,
"range": {
object ( |
Поля | |
---|---|
name | Имя NamedRange. Имена не обязательно должны быть уникальными. Имена должны содержать не менее 1 символа и не более 256 символов, измеряемых в кодовых единицах UTF-16. |
range | Диапазон, к которому нужно применить имя. |
Удалитьимедранжерекуест
Удаляет NamedRange
.
JSON-представление |
---|
{ "tabsCriteria": { object ( |
Поля | |
---|---|
tabsCriteria | Необязательный. Критерии, используемые для указания вкладок, на которых должно происходить удаление диапазона. Если этот параметр опущен, удаление диапазона применяется ко всем вкладкам. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
Поле объединения named_range_reference . Значение, определяющее, какой диапазон или диапазоны следует удалить. Должен быть установлен именно один. named_range_reference может быть только одним из следующих: | |
namedRangeId | Идентификатор именованного диапазона, который необходимо удалить. |
name | Имя диапазона(ов), которые необходимо удалить. Все именованные диапазоны с данным именем будут удалены. |
Запрос обновления абзаца стиля
Обновите стиль всех абзацев, пересекающихся с заданным диапазоном.
JSON-представление |
---|
{ "paragraphStyle": { object ( |
Поля | |
---|---|
paragraphStyle | Стили, устанавливаемые для абзацев. Определенные изменения стиля абзаца могут привести к другим изменениям, отражающим поведение редактора Документов. Дополнительную информацию смотрите в документации |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить свойство выравнивания стиля абзаца, установите для Чтобы вернуть свойству значение по умолчанию, включите имя его поля в маску поля, но оставьте само поле незаданным. |
Поле объединения insertion_location . Тип диапазона, в котором будет обновлен стиль абзаца. insertion_location может быть только одним из следующих: | |
range | Диапазон, перекрывающий абзацы, подлежащие стилизации. |
Удалеконтентранжерекуест
Удаляет содержимое из документа.
JSON-представление |
---|
{
"range": {
object ( |
Поля | |
---|---|
range | Диапазон содержимого, которое необходимо удалить. Удаление текста, пересекающего границу абзаца, может привести к изменению стилей абзаца, списков, расположенных объектов и закладок при объединении двух абзацев. Попытка удалить определенные диапазоны может привести к недопустимой структуре документа, и в этом случае будет возвращена ошибка 400 неверного запроса. Некоторые примеры недействительных запросов на удаление включают в себя:
|
Инлайнимажерекуест
Вставляет InlineObject
содержащий изображение в заданном месте.
JSON-представление |
---|
{ "uri": string, "objectSize": { object ( |
Поля | |
---|---|
uri | URI изображения. Изображение извлекается один раз во время вставки, а копия сохраняется для отображения внутри документа. Изображения должны иметь размер менее 50 МБ, не превышать 25 мегапикселей и быть в формате PNG, JPEG или GIF. Предоставленный URI должен быть общедоступным и иметь длину не более 2 КБ. Сам URI сохраняется вместе с изображением и отображается через поле |
objectSize | Размер, в котором изображение должно выглядеть так же, как в документе. Это свойство является необязательным, и окончательный размер изображения в документе определяется по следующим правилам: * Если не указаны ни ширина, ни высота, то размер изображения по умолчанию рассчитывается на основе его разрешения. * Если указано одно измерение, то вычисляется другое измерение, чтобы сохранить соотношение сторон изображения. * Если указаны и ширина, и высота, изображение масштабируется в соответствии с указанными размерами, сохраняя при этом соотношение сторон. |
Поле объединения insertion_location . Место, куда будет вставлено изображение. insertion_location может быть только одним из следующих: | |
location | Вставляет изображение по определенному индексу в документе. Изображение должно быть вставлено внутри границ существующего Встроенные изображения нельзя вставлять внутри сноски или уравнения. |
endOfSegmentLocation | Вставляет текст в конец верхнего, нижнего колонтитула или тела документа. Встроенные изображения не могут быть вставлены в сноску. |
Инсертаблерекуест
Вставляет таблицу в указанное место.
Перед вставленной таблицей будет вставлен символ новой строки.
JSON-представление |
---|
{ "rows": integer, "columns": integer, // Union field |
Поля | |
---|---|
rows | Количество строк в таблице. |
columns | Количество столбцов в таблице. |
Поле объединения insertion_location . Место, куда будет вставлена таблица. insertion_location может быть только одним из следующих: | |
location | Вставляет таблицу по определенному индексу модели. Перед вставленной таблицей будет вставлен символ новой строки, поэтому начальный индекс таблицы будет находиться в указанном индексе местоположения + 1. Таблица должна быть вставлена внутри границ существующего Таблицы нельзя вставлять внутри сноски или уравнения. |
endOfSegmentLocation | Вставляет таблицу в конец указанного верхнего, нижнего колонтитула или тела документа. Перед вставленной таблицей будет вставлен символ новой строки. Таблицы не могут быть вставлены в сноску. |
Инсертаблероврекуест
Вставляет пустую строку в таблицу.
JSON-представление |
---|
{
"tableCellLocation": {
object ( |
Поля | |
---|---|
tableCellLocation | Местоположение ячейки ссылочной таблицы, из которой будут вставлены строки. Новая строка будет вставлена выше (или ниже) строки, в которой находится ссылочная ячейка. Если эталонная ячейка является объединенной ячейкой, новая строка будет вставлена над (или под) объединенной ячейкой. |
insertBelow | Вставлять ли новую строку ниже исходной ячейки.
|
TableCellLocation
Расположение одной ячейки в таблице.
JSON-представление |
---|
{
"tableStartLocation": {
object ( |
Поля | |
---|---|
tableStartLocation | Место начала таблицы в документе. |
rowIndex | Индекс строки, отсчитываемый от нуля. Например, вторая строка таблицы имеет индекс строки 1. |
columnIndex | Индекс столбца, отсчитываемый от нуля. Например, второй столбец таблицы имеет индекс столбца 1. |
Инсертаблеколумнреквест
Вставляет пустой столбец в таблицу.
JSON-представление |
---|
{
"tableCellLocation": {
object ( |
Поля | |
---|---|
tableCellLocation | Местоположение ячейки ссылочной таблицы, из которой будут вставлены столбцы. Новый столбец будет вставлен слева (или справа) от столбца, в котором находится ссылочная ячейка. Если эталонная ячейка является объединенной ячейкой, новый столбец будет вставлен слева (или справа) от объединенной ячейки. |
insertRight | Вставлять ли новый столбец справа от местоположения ссылочной ячейки.
|
Удалитьтаблероврекуест
Удаляет строку из таблицы.
JSON-представление |
---|
{
"tableCellLocation": {
object ( |
Поля | |
---|---|
tableCellLocation | Местоположение ячейки ссылочной таблицы, из которой будет удалена строка. Строка, охватываемая этой ячейкой, будет удалена. Если это объединенная ячейка, охватывающая несколько строк, все строки, охватываемые ячейкой, будут удалены. Если после удаления в таблице не осталось ни одной строки, удаляется вся таблица. |
Делететаблеколумнреквест
Удаляет столбец из таблицы.
JSON-представление |
---|
{
"tableCellLocation": {
object ( |
Поля | |
---|---|
tableCellLocation | Местоположение ячейки ссылочной таблицы, из которой будет удален столбец. Столбец, охватываемый этой ячейкой, будет удален. Если это объединенная ячейка, охватывающая несколько столбцов, все столбцы, охватываемые ячейкой, будут удалены. Если после удаления в таблице не осталось ни одного столбца, удаляется вся таблица. |
Вставитьпажебрекреквест
Вставляет разрыв страницы, за которым следует новая строка, в указанном месте.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения insertion_location . Место, куда будет вставлен разрыв страницы. insertion_location может быть только одним из следующих: | |
location | Вставляет разрыв страницы по определенному индексу в документе. Разрыв страницы должен быть вставлен внутри границ существующего Разрывы страниц не могут быть вставлены внутри таблицы, уравнения, сноски, верхнего или нижнего колонтитула. Поскольку разрывы страниц можно вставлять только внутри тела, поле |
endOfSegmentLocation | Вставляет разрыв страницы в конец тела документа. Разрывы страниц не могут быть вставлены внутри сноски, верхнего или нижнего колонтитула. Поскольку разрывы страниц можно вставлять только внутри тела, поле |
Запрос УдалитьПозиционедОбжект
Удаляет PositionedObject
из документа.
JSON-представление |
---|
{ "objectId": string, "tabId": string } |
Поля | |
---|---|
objectId | Идентификатор позиционированного объекта, который необходимо удалить. |
tabId | Вкладка, на которой находится позиционированный объект, подлежащий удалению. Если этот параметр опущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
UpdateTableColumnPropertiesRequest
Обновляет TableColumnProperties
столбцов в таблице.
JSON-представление |
---|
{ "tableStartLocation": { object ( |
Поля | |
---|---|
tableStartLocation | Место начала таблицы в документе. |
columnIndices[] | Список индексов столбцов, отсчитываемых от нуля, свойство которых необходимо обновить. Если индексы не указаны, все столбцы будут обновлены. |
tableColumnProperties | Свойства столбца таблицы, которые необходимо обновить. Если значение |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить ширину столбца, установите для |
UpdateTableCellStyleRequest
Обновляет стиль диапазона ячеек таблицы.
JSON-представление |
---|
{ "tableCellStyle": { object ( |
Поля | |
---|---|
tableCellStyle | Стиль, устанавливаемый для ячеек таблицы. При обновлении границ, если ячейка имеет общую границу с соседней ячейкой, соответствующее свойство границы соседней ячейки также обновляется. Объединенные и невидимые границы не обновляются. Поскольку обновление границы, общей для соседних ячеек в одном запросе, может привести к конфликту обновлений границ, обновления границ применяются в следующем порядке:
|
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить цвет фона ячейки таблицы, установите для Чтобы вернуть свойству значение по умолчанию, включите имя его поля в маску поля, но оставьте само поле незаданным. |
Объединение полевых cells . Ячейки, которые будут обновлены. cells могут быть только одним из следующих: | |
tableRange | Диапазон таблицы, представляющий подмножество таблицы, к которой применяются обновления. |
tableStartLocation | Место начала таблицы в документе. Если указано, обновления применяются ко всем ячейкам таблицы. |
ТаблицаДиапазон
Диапазон таблицы представляет собой ссылку на подмножество таблицы.
Важно отметить, что ячейки, указанные в диапазоне таблицы, не обязательно образуют прямоугольник. Например, предположим, что у нас есть таблица 3 x 3, в которой все ячейки последней строки объединены вместе. Таблица выглядит следующим образом:
[ ][ ][ ]
[ ][ ][ ]
[ ]
Диапазон таблицы с расположением ячейки таблицы = (tableStartLocation, row = 0, columns = 0), диапазоном строк = 3 и диапазоном столбцов = 2 определяет следующие ячейки:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
JSON-представление |
---|
{
"tableCellLocation": {
object ( |
Поля | |
---|---|
tableCellLocation | Местоположение ячейки, где начинается диапазон таблицы. |
rowSpan | Диапазон строк диапазона таблицы. |
columnSpan | Диапазон столбцов диапазона таблицы. |
UpdateTableRowStyleRequest
Обновляет TableRowStyle
строк в таблице.
JSON-представление |
---|
{ "tableStartLocation": { object ( |
Поля | |
---|---|
tableStartLocation | Место начала таблицы в документе. |
rowIndices[] | Список индексов строк, отсчитываемых от нуля, стиль которых следует обновить. Если индексы не указаны, все строки будут обновлены. |
tableRowStyle | Стили, которые будут установлены в строках. |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить минимальную высоту строки, установите для |
ЗаменитьImageRequest
Заменяет существующее изображение новым изображением.
При замене изображения из существующего изображения удаляются некоторые image effects
, чтобы отразить поведение редактора Документов.
JSON-представление |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
Поля | |
---|---|
imageObjectId | Идентификатор существующего изображения, которое будет заменено. Идентификатор можно получить из ответа на запрос получения. |
uri | URI нового изображения. Изображение извлекается один раз во время вставки, а копия сохраняется для отображения внутри документа. Изображения должны иметь размер менее 50 МБ, не превышать 25 мегапикселей и быть в формате PNG, JPEG или GIF. Длина предоставленного URI не может превышать 2 КБ. URI сохраняется вместе с изображением и отображается через поле |
imageReplaceMethod | Метод замены. |
tabId | Вкладка, на которой находится заменяемое изображение. Если этот параметр опущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
Метод замены изображения
Метод замены изображения.
Перечисления | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED | Неуказанный метод замены изображения. Это значение нельзя использовать. |
CENTER_CROP | Масштабирует и центрирует изображение, чтобы заполнить границы исходного изображения. Изображение можно обрезать, чтобы заполнить границы исходного изображения. Размер визуализированного изображения будет таким же, как и исходное изображение. |
ОбновлениеДокументСтильЗапрос
Обновляет DocumentStyle
.
JSON-представление |
---|
{
"documentStyle": {
object ( |
Поля | |
---|---|
documentStyle | Стили, устанавливаемые в документе. Определенные изменения стиля документа могут привести к другим изменениям, отражающим поведение редактора Документов. Дополнительную информацию см. в документации |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить фон, установите для |
tabId | Вкладка, содержащая обновляемый стиль. Если этот параметр опущен, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
Запрос MergeTableCells
Объединяет ячейки в Table
.
JSON-представление |
---|
{
"tableRange": {
object ( |
Поля | |
---|---|
tableRange | Диапазон таблицы, определяющий, какие ячейки таблицы необходимо объединить. Любой текст в объединяемых ячейках будет объединен и сохранен в «головной» ячейке диапазона. Это верхняя левая ячейка диапазона, если направление содержимого слева направо, и правая верхняя ячейка диапазона в противном случае. Если диапазон непрямоугольный (что может произойти в некоторых случаях, когда диапазон охватывает уже объединенные ячейки или если таблица непрямоугольная), возвращается ошибка 400 неверного запроса. |
UnmergeTableCellsRequest
Разъединяет ячейки в Table
.
JSON-представление |
---|
{
"tableRange": {
object ( |
Поля | |
---|---|
tableRange | Диапазон таблицы, определяющий, какие ячейки таблицы следует объединить. Все объединенные ячейки в этом диапазоне будут объединены, а уже несвязанные ячейки не будут затронуты. Если в диапазоне нет объединенных ячеек, запрос ничего не сделает. Если в какой-либо из объединенных ячеек есть текст, он останется в «головной» ячейке полученного блока необъединенных ячеек. Ячейка «голова» — это верхняя левая ячейка, если направление содержимого слева направо, и верхняя правая в противном случае. |
Создатьзаголовок запроса
Создает Header
. Новый заголовок применяется к SectionStyle
в расположении SectionBreak
, если он указан, в противном случае он применяется к DocumentStyle
.
Если заголовок указанного типа уже существует, возвращается ошибка 400 неверного запроса.
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Тип создаваемого заголовка. |
sectionBreakLocation | Местоположение раздела |
Создать запрос сноски
Создает сегмент Footnote
и вставляет в него новую FootnoteReference
в заданном месте.
Новый сегмент Footnote
будет содержать пробел, за которым следует символ новой строки.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения footnote_reference_location . Место для вставки ссылки на сноску. footnote_reference_location может быть только одним из следующих: | |
location | Вставляет ссылку на сноску в определенный индекс документа. Ссылка на сноску должна быть вставлена внутри границ существующего Ссылки на сноски не могут быть вставлены внутри уравнения, заголовка, нижнего колонтитула или сноски. Поскольку ссылки на сноски можно вставлять только в тело, поле |
endOfSegmentLocation | Вставляет ссылку на сноску в конце тела документа. Ссылки на сноски не могут быть вставлены внутри верхнего, нижнего колонтитула или сноски. Поскольку ссылки на сноски можно вставлять только в тело, поле |
Резаменамедранжеконтентрекуест
Заменяет содержимое указанного NamedRange
или NamedRanges
заданным замещающим содержимым.
Обратите внимание, что отдельный NamedRange
может состоять из нескольких прерывистых ranges
. В этом случае будет заменено только содержимое первого диапазона. Остальные диапазоны и их содержимое будут удалены.
В тех случаях, когда замена или удаление каких-либо диапазонов приведет к недопустимой структуре документа, возвращается ошибка 400 неверного запроса.
JSON-представление |
---|
{ "tabsCriteria": { object ( |
Поля | |
---|---|
tabsCriteria | Необязательный. Критерии, используемые для указания, на каких вкладках происходит замена. Если этот параметр опущен, замена применяется ко всем вкладкам. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
Поле объединения replacement_content . Содержимое, на которое необходимо заменить существующее содержимое именованного диапазона. replacement_content может быть только одним из следующих: | |
text | Заменяет содержимое указанных именованных диапазонов заданным текстом. |
Поле объединения named_range_reference . Ссылка на именованный диапазон(ы), содержимое которых будет заменено. named_range_reference может быть только одним из следующих: | |
namedRangeId | Идентификатор именованного диапазона, содержимое которого будет заменено. Если именованного диапазона с данным идентификатором нет, возвращается ошибка 400 неверного запроса. |
namedRangeName | Имя Если существует несколько |
UpdateSectionStyleRequest
Обновляет SectionStyle
.
JSON-представление |
---|
{ "range": { object ( |
Поля | |
---|---|
range | Диапазон, перекрывающий разделы, подлежащие стилизации. Поскольку разрывы разделов можно вставлять только внутри тела, поле |
sectionStyle | Стили, которые будут установлены в разделе. Определенные изменения стиля раздела могут привести к другим изменениям, отражающим поведение редактора Документов. Дополнительную информацию смотрите в документации по |
fields | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой Например, чтобы обновить левое поле, установите для |
InsertSectionBreakRequest
Вставляет разрыв раздела в заданном месте.
Перед разрывом раздела будет вставлен символ новой строки.
JSON-представление |
---|
{ "sectionType": enum ( |
Поля | |
---|---|
sectionType | Тип раздела для вставки. |
Поле объединения insertion_location . Место, где будет вставлен разрыв. insertion_location может быть только одним из следующих: | |
location | Вставляет новую строку и разрыв раздела по определенному индексу в документе. Разрыв раздела должен быть вставлен внутри границ существующего Разрывы разделов нельзя вставлять внутри таблицы, уравнения, сноски, верхнего или нижнего колонтитула. Поскольку разрывы секций могут быть вставлены только в тело, поле |
endOfSegmentLocation | Встает новая линия и разрыв секции в конце тела документа. Разрывы секции не могут быть вставлены в сноску, заголовок или нижний колонтитул. Поскольку разрывы секций могут быть вставлены только в корпус, поле |
DeleteHeaderRequest
Удаляет Header
из документа.
Представление JSON |
---|
{ "headerId": string, "tabId": string } |
Поля | |
---|---|
headerId | Идентификатор заголовка для удаления. Если этот заголовок определяется на |
tabId | Вкладка, содержащая заголовок для удаления. При опущенной, запрос применяется к первой вкладке. В документе, содержащем одну вкладку:
В документе, содержащем несколько вкладок:
|
PintableHeaderRowsRequest
Обновляет количество закрепленных рядов заголовков таблицы в таблице.
Представление JSON |
---|
{
"tableStartLocation": {
object ( |
Поля | |
---|---|
tableStartLocation | Место, где таблица начинается в документе. |
pinnedHeaderRowsCount | Количество рядов таблиц для прикрепления, где 0 подразумевает, что все строки не являются. |