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 может быть только одним из следующих:
replace All Text

object ( ReplaceAllTextRequest )

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

insert Text

object ( InsertTextRequest )

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

update Text Style

object ( UpdateTextStyleRequest )

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

create Paragraph Bullets

object ( CreateParagraphBulletsRequest )

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

delete Paragraph Bullets

object ( DeleteParagraphBulletsRequest )

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

create Named Range

object ( CreateNamedRangeRequest )

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

delete Named Range

object ( DeleteNamedRangeRequest )

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

update Paragraph Style

object ( UpdateParagraphStyleRequest )

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

delete Content Range

object ( DeleteContentRangeRequest )

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

insert Inline Image

object ( InsertInlineImageRequest )

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

insert Table

object ( InsertTableRequest )

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

insert Table Row

object ( InsertTableRowRequest )

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

insert Table Column

object ( InsertTableColumnRequest )

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

delete Table Row

object ( DeleteTableRowRequest )

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

delete Table Column

object ( DeleteTableColumnRequest )

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

insert Page Break

object ( InsertPageBreakRequest )

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

delete Positioned Object

object ( DeletePositionedObjectRequest )

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

update Table Column Properties

object ( UpdateTableColumnPropertiesRequest )

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

update Table Cell Style

object ( UpdateTableCellStyleRequest )

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

update Table Row Style

object ( UpdateTableRowStyleRequest )

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

replace Image

object ( ReplaceImageRequest )

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

update Document Style

object ( UpdateDocumentStyleRequest )

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

merge Table Cells

object ( MergeTableCellsRequest )

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

unmerge Table Cells

object ( UnmergeTableCellsRequest )

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

create Header

object ( CreateHeaderRequest )

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

create Footnote

object ( CreateFootnoteRequest )

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

replace Named Range Content

object ( ReplaceNamedRangeContentRequest )

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

update Section Style

object ( UpdateSectionStyleRequest )

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

insert Section Break

object ( InsertSectionBreakRequest )

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

delete Header

object ( DeleteHeaderRequest )

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

pin Table Header Rows

object ( PinTableHeaderRowsRequest )

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

ЗаменитьAllTextRequest

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

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.
}
Поля
replace Text

string

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

tabs Criteria

object ( TabsCriteria )

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

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

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

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

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

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

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

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

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

object ( SubstringMatchCriteria )

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

ПодстрокаMatchCriteria

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

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

string

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

match Case

boolean

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

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

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

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

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

string

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

Вставитьтекстовый запрос

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

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 (U+E000–U+F8FF) будут удалены из вставленного текста.

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

object ( Location )

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

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

end Of Segment Location

object ( EndOfSegmentLocation )

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

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

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

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

string

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

index

integer

Индекс, начинающийся с нуля, в кодовых единицах UTF-16.

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

tab Id

string

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

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

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

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

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

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

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

КонецОфСегментЛокейшн

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

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

string

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

tab Id

string

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

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

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

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

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

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

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

UpdateTextStyleRequest

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

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.
}
Поля
text Style

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 )

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

bullet Preset

enum ( BulletGlyphPreset )

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

ПуляГлифПресет

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

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

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

Удалить абзац. Запрос маркеров.

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

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

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-представление
{
  "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.
}
Поля
tabs Criteria

object ( TabsCriteria )

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

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

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

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

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

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

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

Поле объединения named_range_reference . Значение, определяющее, какой диапазон или диапазоны следует удалить. Должен быть установлен именно один. named_range_reference может быть только одним из следующих:
named Range Id

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.
}
Поля
paragraph Style

object ( ParagraphStyle )

Стили, устанавливаемые для абзацев.

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

fields

string ( FieldMask format)

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

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

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

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

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

object ( Range )

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

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

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

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 .

object Size

object ( Size )

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

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

object ( Location )

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

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

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

end Of Segment Location

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

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

end Of Segment Location

object ( EndOfSegmentLocation )

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

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

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

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

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

object ( TableCellLocation )

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

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

insert Below

boolean

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

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

TableCellLocation

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

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

object ( Location )

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

row Index

integer

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

column Index

integer

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

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

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

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

object ( TableCellLocation )

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

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

insert Right

boolean

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

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

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

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

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

object ( TableCellLocation )

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

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

Удалитьтаблеколонквест

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

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

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

end Of Segment Location

object ( EndOfSegmentLocation )

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

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

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

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

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

string

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

tab Id

string

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

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

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

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

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

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

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

UpdateTableColumnPropertiesRequest

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

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

object ( Location )

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

column Indices[]

integer

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

table Column Properties

object ( TableColumnProperties )

Свойства столбца таблицы, которые необходимо обновить.

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

fields

string ( FieldMask format)

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

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

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

UpdateTableCellStyleRequest

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

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.
}
Поля
table Cell Style

object ( TableCellStyle )

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

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string ( FieldMask format)

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

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

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

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

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

object ( TableRange )

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

table Start Location

object ( Location )

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

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

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

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

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

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

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

object ( TableCellLocation )

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

row Span

integer

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

column Span

integer

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

UpdateTableRowStyleRequest

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

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

object ( Location )

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

row Indices[]

integer

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

table Row Style

object ( TableRowStyle )

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

fields

string ( FieldMask format)

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

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

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

ЗаменитьImageRequest

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

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

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

string

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

uri

string

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

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

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

image Replace Method

enum ( ImageReplaceMethod )

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

tab Id

string

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

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

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

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

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

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

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

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

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

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

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

Обновляет DocumentStyle .

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

object ( DocumentStyle )

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

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

fields

string ( FieldMask format)

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

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

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

tab Id

string

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

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

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

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

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

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

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

Запрос MergeTableCells

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

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

object ( TableRange )

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

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

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

UnmergeTableCellsRequest

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

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

object ( TableRange )

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

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

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

Создатьзаголовок запроса

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

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

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

enum ( HeaderFooterType )

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

section Break Location

object ( Location )

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

Тип заголовка или колонтитула

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

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

Создать запрос нижнего колонтитула

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

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

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

enum ( HeaderFooterType )

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

section Break Location

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

end Of Segment Location

object ( EndOfSegmentLocation )

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

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

Резаменамедранжеконтентрекуест

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

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

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

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

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

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

object ( TabsCriteria )

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

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

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

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

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

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

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

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

string

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

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

string

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

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

named Range Name

string

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

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

UpdateSectionStyleRequest

Обновляет SectionStyle .

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

object ( Range )

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

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

section Style

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.
}
Поля
section Type

enum ( SectionType )

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

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

object ( Location )

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

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

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

end Of Segment Location

object ( EndOfSegmentLocation )

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

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

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

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

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

string

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

tab Id

string

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

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

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

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

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

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

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

DeleteFooterRequest

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

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

string

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

tab Id

string

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

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

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

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

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

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

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

PintableHeaderRowsRequest

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

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

object ( Location )

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

pinned Header Rows Count

integer

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