您可以使用 Google 文档 API 编辑表格内容。您可以执行的操作包括:
- 插入和删除行、列或整个表格。
- 在表格单元格中插入内容。
- 读取表格单元格中的内容。
- 修改列属性和行样式。
Google 文档中的表在文档中表示为一种 StructuralElement。每个表均包含一个表行列表,其中每行包含一个表单元格列表。与所有结构元素一样,该表也具有起始索引和结束索引,以指示表格在文档中的位置。如需详细了解索引,请参阅结构。表格属性包括许多样式元素,例如列宽和内边距。
以下 JSON 片段显示了一个简单的 2x2 表,其中大部分详细信息已移除:
"table": {
"columns": 2,
"rows": 2,
"tableRows": [
{ "tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
},
{
"tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
}
]
}
插入和删除表
如需向文档中添加新表,请使用 InsertTableRequest。插入表时,必须指定以下内容:
- 以行和列表示的表格维度。
- 插入新表的位置:可以是段内的索引,也可以是段的末尾。
没有明确的方法来删除表。如需从文档中删除表,请像对待任何其他内容一样对待该表:使用 DeleteContentRangeRequest,并指定涵盖整个表的范围。
以下示例将在空文档的末尾插入一个 3x3 的表格:
Java
// Insert a table at the end of the body. // (An empty or unspecified segmentId field indicates the document's body.) List<Request> requests = new ArrayList<>(); requests.add( new Request() .setInsertTable( new InsertTableRequest() .setEndOfSegmentLocation( new EndOfSegmentLocation()) .setRows(3) .setColumns(3))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Python
# Insert a table at the end of the body. # (An empty or unspecified segmentId field indicates the document's body.) requests = [{ 'insertTable': { 'rows': 3, 'columns': 3, 'endOfSegmentLocation': { 'segmentId': '' } }, } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
以下相应示例展示了如何删除之前插入的表:
Java
// Delete a table that was inserted at the start of the body. // (The table is the second element in the body: // document.getBody().getContent().get(2).) Document document = docsService.documents().get(DOCUMENT_ID).execute(); StructuralElement table = document.getBody().getContent().get(2); List<Request> requests = new ArrayList<>(); requests.add( new Request() .setDeleteContentRange( new DeleteContentRangeRequest() .setRange( new Range() .setStartIndex(table.getStartIndex()) .setEndIndex(table.getEndIndex())))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Python
# Delete a table that was inserted at the start of the body. # (The table is the second element in the body: ['body']['content'][2].) document = service.documents().get(documentId=DOCUMENT_ID).execute() table = document['body']['content'][2] requests = [{ 'deleteContentRange': { 'range': { 'segmentId': '', 'startIndex': table['startIndex'], 'endIndex': table['endIndex'] } }, } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
由于通过指定起始索引和结束索引将表作为普通内容删除,因此需要从某个位置获取这些索引。该示例展示了从文档内容中提取这些索引的一种方法。
插入和删除行
如果您的文档已包含表格,则可以使用 Google Docs API 插入和删除表格行。使用 InsertTableRowRequest,可在指定表格单元格上方或下方插入行,可使用 DeleteTableRowRequest 移除跨越指定单元格位置的行。
以下示例会将文本插入表格的第一个表格单元格,并添加一个表格行。
Java
List<Request> requests = new ArrayList<>(); requests.add(new Request().setInsertText(new InsertTextRequest() .setText("Hello") .setLocation(new Location().setIndex(5)))); requests.add(new Request().setInsertTableRow(new InsertTableRowRequest() .setTableCellLocation(new TableCellLocation() .setTableStartLocation(new Location() .setIndex(2)) .setRowIndex(1) .setColumnIndex(1)) .setInsertBelow(true))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents() .batchUpdate(DOCUMENT_ID, body).execute();
Python
requests = [{ 'insertText': { 'location': { 'index': 5 }, 'text': 'Hello' } }, { 'insertTableRow': { 'tableCellLocation': { 'tableStartLocation': { 'index': 2 }, 'rowIndex': 1, 'columnIndex': 1 }, 'insertBelow': 'true' } } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
插入和删除列
如需在现有表中插入列,请使用 InsertTableColumnRequest。您必须指定以下各项:
- 要在其旁边插入新列的单元格。
- 要在哪一侧(左侧或右侧)插入新列。
以下示例展示了如何在前面所示的 2x2 表中插入一列:
Java
List<Request> requests = new ArrayList<>(); requests.add( new Request() .setInsertTableColumn( new InsertTableColumnRequest() .setTableCellLocation( new TableCellLocation() .setTableStartLocation( new Location().setIndex(2)) .setRowIndex(0) .setColumnIndex(0)) .setInsertRight(true))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Python
requests = [{ 'insertTableColumn': { 'tableCellLocation': { 'tableStartLocation': { 'segmentId': '', 'index': 2 }, 'rowIndex': 0, 'columnIndex': 0 }, 'insertRight': True }, } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
如需删除列,请使用 DeleteTableColumnRequest。您可以按照前面插入列的说明,在目标列中指定单元格位置。
读取表格单元格中的内容
表格单元格包含一系列结构元素;其中每个结构元素可以是包含文本的段落或其他类型的结构,甚至可以是另一个表格。如需读取表格内容,您可以递归检查每个元素,如提取文本中所示。
正在将内容插入表格单元格
如需写入表单元格,请对您想更新的单元格中的索引使用 InsertTextRequest。表索引会调整以考虑更新后的文本。这同样适用于使用 DeleteContentRangeRequest 删除单元格文本。
修改列属性
通过 UpdateTableColumnPropertiesRequest,您可以修改表中一个或多个列的属性。
您必须提供表的起始索引以及 TableColumnProperties 对象。如需仅修改所选列,请在请求中包含列号列表;如需修改表中的所有列,请提供空列表。
以下示例更新了表格的列宽,将所有列宽设置为 100pt,然后将第一列的宽度设置为 200pt:
Java
List<Request> requests = new ArrayList<>(); requests.add( new Request() .setUpdateTableColumnProperties( new UpdateTableColumnPropertiesRequest() .setTableStartLocation(new Location().setIndex(2)) .setColumnIndices(null) .setTableColumnProperties( new TableColumnProperties() .setWidthType("FIXED_WIDTH") .setWidth( new Dimension().setMagnitude(100d).setUnit("PT"))) .setFields("*"))); List<Integer> columnIndices = new ArrayList<>(); columnIndices.add(0); requests.add( new Request() .setUpdateTableColumnProperties( new UpdateTableColumnPropertiesRequest() .setTableStartLocation(new Location().setIndex(2)) .setColumnIndices(columnIndices) .setTableColumnProperties( new TableColumnProperties() .setWidthType("FIXED_WIDTH") .setWidth( new Dimension().setMagnitude(200d).setUnit("PT"))) .setFields("*"))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Python
requests = [{ 'updateTableColumnProperties': { 'tableStartLocation': {'index': 2}, 'columnIndices': [], 'tableColumnProperties': { 'widthType': 'FIXED_WIDTH', 'width': { 'magnitude': 100, 'unit': 'PT' } }, 'fields': '*' }, 'updateTableColumnProperties': { 'tableStartLocation': {'index': 2}, 'columnIndices': [0], 'tableColumnProperties': { 'widthType': 'FIXED_WIDTH', 'width': { 'magnitude': 200, 'unit': 'PT' } }, 'fields': '*' }, } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
修改行样式
通过 UpdateTableRowsStyleRequest,您可以修改表中一个或多个行的样式。
您必须提供表的起始索引以及 TableRowStyle 对象。如需仅修改所选行,请在请求中包含行号列表;如需修改表中的所有行,请提供空列表。
以下示例设置了表第 3 行的最小高度:
Java
List<Integer> rowIndices = new ArrayList<>(); rowIndices.add(3); List<Request> requests = new ArrayList<>(); requests.add( new Request() .setUpdateTableRowStyle( new UpdateTableRowStyleRequest() .setTableStartLocation(new Location().setIndex(2)) .setRowIndices(rowIndices) .setTableRowStyle( new TableRowStyle() .setMinRowHeight( new Dimension().setMagnitude(18d).setUnit("PT"))) .setFields("*"))); BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests); BatchUpdateDocumentResponse response = docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Python
requests = [{ 'updateTableRowStyle': { 'tableStartLocation': {'index': 2}, 'rowIndices': [3], 'tableRowStyle': { 'minRowHeight': { 'magnitude': 18, 'unit': 'PT' } }, 'fields': '*' }, } ] result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()