Requests

Запрос

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

Представление 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)
  }
  // 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 )

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

createFootnote

object ( CreateFootnoteRequest )

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

replaceNamedRangeContent

object ( ReplaceNamedRangeContentRequest )

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

updateSectionStyle

object ( UpdateSectionStyleRequest )

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

insertSectionBreak

object ( InsertSectionBreakRequest )

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

deleteHeader

object ( DeleteHeaderRequest )

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

pinTableHeaderRows

object ( PinTableHeaderRowsRequest )

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

Заменить все текстовые запросы

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

Представление JSON
{
  "replaceText": string,

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

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

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

object ( SubstringMatchCriteria )

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

SubstringMatchCriteria

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

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

string

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

matchCase

boolean

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

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

Вставитьтекстрекуест

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

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

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

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

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

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

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

object ( Location )

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

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

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

string

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

index

integer

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

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

EndOfSegmentLocation

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

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

string

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

Обновлениетекстстилерекуест

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

Представление 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 )

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

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

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

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

BulletGlyphPreset

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

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

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

DeleteParagraphBulletsRequest

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

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

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

object ( Range )

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

CreateNamedRangeRequest

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

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

string

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

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

range

object ( Range )

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

УдалитьНамедРангерекуест

Удаляет NamedRange .

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

  // 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.
}
Поля
Поле объединения named_range_reference . Значение, определяющее, какой диапазон или диапазоны следует удалить. Точно один должен быть установлен. named_range_reference может быть только одним из следующих:
namedRangeId

string

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

name

string

Имя диапазона(ов) для удаления. Все именованные диапазоны с заданным именем будут удалены.

Обновление ПараграфСтилерекуест

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

Представление 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 )

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

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

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

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

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

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

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

object ( Range )

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

DeleteContentRangeRequest

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

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

object ( Range )

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

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

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

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

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

Инсернлайнимажерекуест

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

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

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 )

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

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

Инсертетаблерекуест

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

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

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

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

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

object ( Location )

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

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

Инсертетаблерекуест

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

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

object ( TableCellLocation )

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

Новая строка будет вставлена ​​выше (или ниже) строки, в которой находится эталонная ячейка. Если эталонная ячейка является объединенной ячейкой, новая строка будет вставлена ​​выше (или ниже) объединенной ячейки.

insertBelow

boolean

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

  • True : вставить под ячейку.
  • False : вставить над ячейкой.

ТаблицаЯчейкаРасположение

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

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

object ( Location )

Место, где начинается таблица в документе.

rowIndex

integer

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

columnIndex

integer

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

Инсертетаблеколумнрекуест

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

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

object ( TableCellLocation )

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

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

insertRight

boolean

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

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

УдалитьТаблеРоврекуест

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

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

object ( TableCellLocation )

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

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

Удалитьтаблеколумнрекуест

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

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

object ( TableCellLocation )

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

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

Инсерпейджбреакрекуест

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

Представление 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.
}
Поля
Поле объединения insertion_location . Место, где будет вставлен разрыв страницы. insertion_location может быть только одним из следующих:
location

object ( Location )

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

УдалитьПозиционедобжектрекуест

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

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

string

ID позиционируемого объекта, который нужно удалить.

Упдатаблеколумнпропертиесрекуест

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

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

object ( Location )

Место, где начинается таблица в документе.

columnIndices[]

integer

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

tableColumnProperties

object ( TableColumnProperties )

Свойства столбца таблицы для обновления.

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

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

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

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

Упдаттаблеллселстилерекуест

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

Представление 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 )

Стиль для установки в ячейках таблицы.

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string ( FieldMask format)

Поля, которые необходимо обновить.

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

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

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

Объединение cells поля. Ячейки, которые будут обновлены. cells могут быть только одним из следующих:
tableRange

object ( TableRange )

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

tableStartLocation

object ( Location )

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

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

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

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

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

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

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

object ( TableCellLocation )

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

rowSpan

integer

Диапазон строк диапазона таблицы.

columnSpan

integer

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

Упдаттаблеровстилерекуест

Обновляет 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" .

Запрос на замену изображения

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

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

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

string

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

uri

string

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

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

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

imageReplaceMethod

enum ( ImageReplaceMethod )

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

ImageReplaceMethod

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

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

ОбновлениеДокументСтилерекуест

Обновляет DocumentStyle .

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

object ( DocumentStyle )

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

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

fields

string ( FieldMask format)

Поля, которые необходимо обновить.

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

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

слияниетаблецеллсрекуест

Объединяет ячейки в Table .

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

object ( TableRange )

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

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

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

UnmergeTableCellsRequest

Разъединяет ячейки в Table .

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

object ( TableRange )

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

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

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

CreateHeaderRequest

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

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

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

enum ( HeaderFooterType )

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

sectionBreakLocation

object ( Location )

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

ЗаголовокFooterType

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

перечисления
DEFAULT Верхний/нижний колонтитул по умолчанию.

CreateFooterRequest

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

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

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

enum ( HeaderFooterType )

Тип нижнего колонтитула для создания.

sectionBreakLocation

object ( Location )

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

СоздатьСноскаЗапрос

Создает сегмент 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 должно быть пустым.

ЗаменитьИмедеранжконтентенрекуест

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

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

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

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

  // 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.
}
Поля
Поле объединения replacement_content . Содержимое, которым необходимо заменить существующее содержимое именованного диапазона. replacement_content может быть только одним из следующих:
text

string

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

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

string

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

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

namedRangeName

string

Имя NamedRanges , содержимое которого будет заменено.

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

апдейтсектионстилерекуест

Обновляет 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" .

Инсерсектионбреакрекуест

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

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

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

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

enum ( SectionType )

Тип раздела для вставки.

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

object ( Location )

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

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

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

endOfSegmentLocation

object ( EndOfSegmentLocation )

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

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

Удалить ЗаголовокЗапрос

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

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

string

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

УдалитьFooterRequest

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

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

string

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

PinTableHeaderRowsRequest

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

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

object ( Location )

Место, где начинается таблица в документе.

pinnedHeaderRowsCount

integer

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