您可以使用 Google 文档 API 编辑表格内容。您可以执行的操作 包括：
- 插入和删除行、列或整个表。
- 在表格单元格中插入内容。
- 读取表格单元格中的内容。
- 修改列属性和行的样式。
Google 文档中的表格是 表示为 StructuralElement 类型 。每个表格 包含一系列表中的行 其中每一行都包含一个 表格单元格。与所有 结构元素，那么表格就包含 开始索引和结束索引， 指示表格在文档中的位置。请参阅结构 。表格属性包括许多样式元素 例如列宽和内边距
以下 JSON 片段显示了一个简单的 2x2 表格，其中包含大部分详细信息 已移除：
"table": {
"columns": 2,
"rows": 2,
"tableRows": [
{ "tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
},
{
"tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
}
]
}
插入和删除表
要在文档中添加新表格，请使用 InsertTableRequest. 插入表时，您必须指定以下内容：
- 以行和列表示的表格维度。
- 插入新表的位置：可以是 segment，也可以是参数传递的 。其中任何一个都应包含指定标签页的 ID。
目前没有明确的方法可以删除表。要从表格中删除表格，请执行以下操作： 文档，像对待任何其他内容一样：使用 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().setTabId(TAB_ID))
.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': '',
'tabId': TAB_ID
}
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
以下相应示例展示了如何删除之前插入的表：
Java
// Delete a table that was inserted at the start of the body of the first tab.
// (The table is the second element in the body:
// documentTab.getBody().getContent().get(2).)
Document document = docsService.documents().get(DOCUMENT_ID).setIncludeTabsContent(true).execute();
String tabId = document.getTabs()[0].getTabProperties().getTabId();
DocumentTab documentTab = document.getTabs()[0].getDocumentTab();
StructuralElement table = documentTab.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())
.setTabId(tabId))));
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 of the first tab.
# (The table is the second element in the body: ['body']['content'][2].)
document = service.documents().get(documentId=DOCUMENT_ID, includeTabsContent=True).execute()
tab_id = document['tabs'][0]['tabProperties']['tabId']
document_tab = document['tabs'][0]['documentTab']
table = document_tab['body']['content'][2]
requests = [{
'deleteContentRange': {
'range': {
'segmentId': '',
'startIndex': table['startIndex'],
'endIndex': table['endIndex'],
'tabId': tab_id
}
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
因为您将表作为普通内容删除 - 方法是指定 start 和 end 索引，您需要从某个位置获取这些索引。该示例展示了 从文档内容中提取这些索引的一种方式。
插入和删除行
如果您的文档已包含表格，则 Google 文档 API 允许您将 和删除表格中的行。使用 InsertTableRowRequest 可在 使用指定的表单元格和 DeleteTableRowRequest 可移除跨指定单元格位置的行。
以下示例将文本插入表格的第一个表格单元格，并将文本添加到 表格行。
Java
List<Request> requests = new ArrayList<>();
requests.add(new Request().setInsertText(new InsertTextRequest()
.setText("Hello")
.setLocation(new Location().setIndex(5).setTabId(TAB_ID))));
requests.add(new Request().setInsertTableRow(new InsertTableRowRequest()
.setTableCellLocation(new TableCellLocation()
.setTableStartLocation(new Location()
.setIndex(2).setTabId(TAB_ID))
.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,
'tabId': TAB_ID
},
'text': 'Hello'
}
},
{
'insertTableRow': {
'tableCellLocation': {
'tableStartLocation': {
'index': 2,
'tabId': TAB_ID
},
'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).setTabId(TAB_ID))
.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,
'tabId': TAB_ID
},
'rowIndex': 0,
'columnIndex': 0
},
'insertRight': True
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
要删除列，请使用 DeleteTableColumnRequest. 如前所述，您可以在目标列中指定单元格位置 插入列。
读取表格单元格中的内容
表格单元格包含一系列结构元素； 所有这些结构元素都可以是包含文本或其他类型的段落 结构，甚至是另一个表格。要读取表格内容，您可以执行以下操作： 以递归方式检查每个元素，如 提取文本。
在表格单元格中插入内容
如需写入表单元格，请使用 InsertTextRequest 您要更新的单元格内的索引。表格索引将调整为 账号会获得更新后的文字。这同样适用于删除带有 DeleteContentRangeRequest.
修改列属性
通过 UpdateTableColumnPropertiesRequest 允许您修改表中一个或多个列的属性。
您必须提供表的起始索引和一个 TableColumnProperties 对象。要仅修改选定的列，请在 请求；要修改表中的所有列，请提供空列表。
以下示例更新了表格的列宽，将所有列都设置为 将第一列的宽度设置为 200pt：
Java
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setUpdateTableColumnProperties(
new UpdateTableColumnPropertiesRequest()
.setTableStartLocation(
new Location()
.setIndex(2)
.setTabId(TAB_ID))
.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)
.setTabId(TAB_ID))
.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, 'tabId': TAB_ID},
'columnIndices': [],
'tableColumnProperties': {
'widthType': 'FIXED_WIDTH',
'width': {
'magnitude': 100,
'unit': 'PT'
}
},
'fields': '*'
},
'updateTableColumnProperties': {
'tableStartLocation': {'index': 2, 'tabId': TAB_ID},
'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)
.setTabId(TAB_ID))
.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, 'tabId': TAB_ID},
'rowIndices': [3],
'tableRowStyle': {
'minRowHeight': {
'magnitude': 18,
'unit': 'PT'
}
},
'fields': '*'
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()