Requests

{

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

object ( ReplaceAllTextRequest )

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

object ( InsertTextRequest )

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

object ( UpdateTextStyleRequest )

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

object ( CreateParagraphBulletsRequest )

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

object ( DeleteParagraphBulletsRequest )

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

object ( CreateNamedRangeRequest )

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

object ( DeleteNamedRangeRequest )

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

object ( UpdateParagraphStyleRequest )

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

object ( DeleteContentRangeRequest )

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

object ( InsertInlineImageRequest )

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

object ( InsertTableRequest )

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

object ( InsertTableRowRequest )

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

object ( InsertTableColumnRequest )

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

object ( DeleteTableRowRequest )

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

object ( DeleteTableColumnRequest )

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

object ( InsertPageBreakRequest )

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

object ( DeletePositionedObjectRequest )

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

object ( UpdateTableColumnPropertiesRequest )

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

object ( UpdateTableCellStyleRequest )

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

object ( UpdateTableRowStyleRequest )

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

object ( ReplaceImageRequest )

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

object ( UpdateDocumentStyleRequest )

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

object ( MergeTableCellsRequest )

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

object ( UnmergeTableCellsRequest )

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

object ( CreateHeaderRequest )

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

object ( CreateFooterRequest )

Создает нижний колонтитул.

object ( CreateFootnoteRequest )

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

object ( ReplaceNamedRangeContentRequest )

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

object ( UpdateSectionStyleRequest )

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

object ( InsertSectionBreakRequest )

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

object ( DeleteHeaderRequest )

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

object ( DeleteFooterRequest )

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

object ( PinTableHeaderRowsRequest )

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

{
  "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.
}

string

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

object ( TabsCriteria )

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

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

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

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

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

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

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

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

object ( SubstringMatchCriteria )

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

{
  "text": string,
  "matchCase": boolean
}

string

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

boolean

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

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

{
  "tabIds": [
    string
  ]
}

string

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

{
  "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.
}

string

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

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

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

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

object ( Location )

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

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

object ( EndOfSegmentLocation )

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

{
  "segmentId": string,
  "index": integer,
  "tabId": string
}

string

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

integer

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

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

string

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

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

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

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

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

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

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

{
  "segmentId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "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.
}

object ( TextStyle )

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

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

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

string ( FieldMask format)

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

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

Например, чтобы изменить стиль текста на полужирный, установите fields значение "bold" .

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

object ( Range )

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

Диапазон может быть расширен за счет включения соседних символов новой строки.

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

Диапазоны нельзя вставлять внутри относительного UpdateTextStyleRequest.

{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}

object ( Range )

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

enum ( BulletGlyphPreset )

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

{
  "range": {
    object (Range)
  }
}

object ( Range )

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

{
  "name": string,
  "range": {
    object (Range)
  }
}

string

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

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

object ( Range )

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

{
  "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.
}

object ( TabsCriteria )

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

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

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

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

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

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

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

string

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

string

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

{
  "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.
}

object ( ParagraphStyle )

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

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

string ( FieldMask format)

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

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

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

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

object ( Range )

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

{
  "range": {
    object (Range)
  }
}

object ( Range )

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

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

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

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

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

{
  "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.
}

string

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

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

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

object ( Size )

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

object ( Location )

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

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

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

object ( EndOfSegmentLocation )

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

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

{
  "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.
}

integer

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

integer

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

object ( Location )

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

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

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

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

object ( EndOfSegmentLocation )

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

Таблицы не могут быть вставлены в сноску.

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}

object ( TableCellLocation )

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

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

boolean

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}

object ( Location )

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

integer

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

integer

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}

object ( TableCellLocation )

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

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

boolean

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

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object ( TableCellLocation )

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

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}

object ( TableCellLocation )

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

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

{

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

object ( Location )

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

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

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

object ( EndOfSegmentLocation )

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

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

{
  "objectId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}

object ( Location )

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

integer

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

object ( TableColumnProperties )

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

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

string ( FieldMask format)

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

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

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

{
  "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.
}

object ( TableCellStyle )

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

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

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

• borderRight
• borderLeft
• borderBottom
• borderTop

string ( FieldMask format)

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

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

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

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

object ( TableRange )

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

object ( Location )

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

{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}

object ( TableCellLocation )

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

integer

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

integer

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

{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}

object ( Location )

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

integer

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

object ( TableRowStyle )

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

string ( FieldMask format)

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

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

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

{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}

string

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

string

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

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

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

enum ( ImageReplaceMethod )

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

string

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

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

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

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

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

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

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

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}

object ( DocumentStyle )

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

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

string ( FieldMask format)

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

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

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

string

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

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

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

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

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

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

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

{
  "tableRange": {
    object (TableRange)
  }
}

object ( TableRange )

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

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

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

{
  "tableRange": {
    object (TableRange)
  }
}

object ( TableRange )

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

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

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

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum ( HeaderFooterType )

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

object ( Location )

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

{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}

enum ( HeaderFooterType )

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

object ( Location )

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

{

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

object ( Location )

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

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

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

object ( EndOfSegmentLocation )

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

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

{
  "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.
}

object ( TabsCriteria )

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

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

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

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

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

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

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

string

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

string

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

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

string

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

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

{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}

object ( Range )

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

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

object ( SectionStyle )

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

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

string ( FieldMask format)

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

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

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

{
  "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.
}

enum ( SectionType )

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

object ( Location )

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

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

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

object ( EndOfSegmentLocation )

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

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

{
  "headerId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "footerId": string,
  "tabId": string
}

string

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

string

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

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

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

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

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

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

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

{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}

object ( Location )

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

integer

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