插入、删除和移动文本

借助 Google 文档 API，您可以在文档中插入或删除文本。移动文本涉及这两项操作，并且在内容之前会先执行 get。

您可以在文档标签页的任何部分（正文、页眉、页脚或脚注）中插入或删除文本。

插入文本

如需将文本插入文档，请使用 documents.batchUpdate 方法，并添加一个 InsertTextRequest，将文本和位置作为载荷。

以下代码示例展示了如何在文档正文的指定索引位置插入一系列文本字符串。该示例使用三个目标偏移量（25、50 和 75），并在每个位置插入一个十个字符的字符串。

Java

List<Request> requests = new ArrayList<>();
requests.add(new Request().setInsertText(new InsertTextRequest()
        .setText(text1)
        .setLocation(new Location().setIndex(25).setTabId(TAB_ID))));

requests.add(new Request().setInsertText(new InsertTextRequest()
        .setText(text2)
        .setLocation(new Location().setIndex(50).setTabId(TAB_ID))));

requests.add(new Request().setInsertText(new InsertTextRequest()
        .setText(text3)
        .setLocation(new Location().setIndex(75).setTabId(TAB_ID))));

BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response = docsService.documents()
        .batchUpdate(DOCUMENT_ID, body).execute();

PHP

$requests = array();
$requests[] = new Google_Service_Docs_Request(array(
    'insertText' => array(
        'text' => $text1,
        'location' => array(
            'index' => 25,
            'tabId' => TAB_ID,
        ),
    ),
    'insertText' => array(
        'text' => $text2,
        'location' => array(
            'index' => 50,
            'tabId' => TAB_ID,
        ),
    ),
    'insertText' => array(
        'text' => $text3,
        'location' => array(
            'index' => 75,
            'tabId' => TAB_ID,
        ),
    ),
));

$batchUpdateRequest = new Google_Service_Docs_BatchUpdateDocumentRequest(array(
    'requests' => $requests
));

$response = $service->documents->batchUpdate($documentId, $batchUpdateRequest);

Python

requests = [
        {
        'insertText': {
            'location': {
                'index': 25,
                'tabId': TAB_ID
            },
            'text': text1
        }
    },
                {
        'insertText': {
            'location': {
                'index': 50,
                'tabId': TAB_ID
            },
            'text': text2
        }
    },
                {
        'insertText': {
            'location': {
                'index': 75,
                'tabId': TAB_ID
            },
            'text': text3
        }
    },
]

result = service.documents().batchUpdate(
    documentId=DOCUMENT_ID, body={'requests': requests}).execute()

每次插入都会使所有编号较高的索引按插入文本的大小递增。该示例会预先计算这些索引更改的结果，以便后续插入操作在经过更正的新偏移量处进行。因此，如需在原始目标偏移量 25、50 和 75 处插入，实际插入索引为：

  • 第一次插入会在偏移量 25 处添加 10 个字符。
  • 第二次插入会在偏移量 50+10=60 处添加 10 个字符。
  • 第三次插入会在偏移量 75+10+10=95 处添加 10 个字符。

删除文字

如需从文档中删除文本，请先构建一个 Range，用于定义要删除的文本范围。然后，使用 documents.batchUpdate 方法并添加 DeleteContentRangeRequest。

以下代码示例展示了如何删除文档正文中索引 10 到索引 24 之间的文本。

Java

List<Request> requests = new ArrayList<>();
requests.add(new Request().setDeleteContentRange(
        new DeleteContentRangeRequest()
                .setRange(new Range()
                        .setStartIndex(10)
                        .setEndIndex(24)
                        .setTabId(TAB_ID))
    ));

BatchUpdateDocumentRequest body = new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response = docsService.documents()
        .batchUpdate(DOCUMENT_ID, body).execute();

PHP

$requests = array();
$requests[] = new Google_Service_Docs_Request(array(
    'deleteContentRange' => array(
        'range' => array(
            'startIndex' => 10,
            'endIndex' => 24,
            'tabId' => TAB_ID
        ),
    ),
));

$batchUpdateRequest = new Google_Service_Docs_BatchUpdateDocumentRequest(array(
    'requests' => $requests
));

$response = $service->documents->batchUpdate($documentId, $batchUpdateRequest);

Python

requests = [
    {
        'deleteContentRange': {
            'range': {
                'startIndex': 10,
                'endIndex': 24,
                'tabId': TAB_ID
            }

        }

    },
]
result = service.documents().batchUpdate(
    documentId=DOCUMENT_ID, body={'requests': requests}).execute()

通过从后往前编写来简化事项。 与插入一样，删除文本也会改变该片段中“下方”所有文本的索引。再次强调，向后写入可以简化索引的处理。

移动文本

如需移动文本，您需要先在一个位置将其删除，然后再将其插入到其他位置。删除内容不会为您提供内容的副本（没有等同于剪贴板的概念），因此您必须先提取范围的内容，然后才能在插入文本请求中使用。