テキストを挿入、削除、移動する

Google ドキュメント API を使用すると、ドキュメント内のテキストを挿入したり、削除したりできます。テキストの移動には、両方の操作があり、その後にコンテンツの get が続きます。

ドキュメントのセグメント（本文、ヘッダー、フッター、脚注）にテキストを挿入したり、削除したりできます。

テキストを挿入

ドキュメントにテキストを挿入するには、documents.batchUpdate メソッドを使用して、テキストと場所をペイロードとして InsertTextRequest を含めます。

次のコードサンプルは、ドキュメント本文内の指定されたインデックスの場所に一連のテキスト文字列を挿入する方法を示しています。この例では、3 つのターゲット オフセット（25、50、75）を使用し、各位置に 10 文字の文字列を挿入します。

Java

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

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

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

        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,
        ),
    ),
    'insertText' => array(
        'text' => $text2,
        'location' => array(
            'index' => 50,
        ),
    ),
    'insertText' => array(
        'text' => $text3,
        'location' => array(
            'index' => 75,
        ),
    ),
));

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

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

Python

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

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

挿入のたびに、挿入されたテキストのサイズだけ大きい番号のインデックスがすべて増加します。この例では、これらのインデックス変更の結果を事前に計算し、修正後の新しいオフセットで後続の挿入が行われるようにします。したがって、25、50、75 の元のターゲット オフセットに挿入する場合、実際の挿入インデックスは次のようになります。

  • 最初の挿入では、オフセット 25 で 10 文字が追加されます。
  • 2 回目の挿入では、オフセット 50+10=60 に 10 文字が追加されます。
  • 3 回目の挿入では、オフセット 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))
            ));

        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
        ),
    ),
));

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

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

Python

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

            }

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

逆算して問題を単純化する。挿入と同様に、テキストを削除すると、セグメント内のすべてのテキストのインデックスが変更されます。ここでも、逆書き込みすると、インデックスの処理が簡単になります。

テキストを移動

テキストを移動するには、ある場所でテキストを削除してから、別の場所に挿入します。コンテンツを削除しても、そのコピーは作成されません（クリップボードに相当する概念はありません）。テキスト挿入リクエストで使用できるように、最初に範囲のコンテンツを抽出する必要があります。