このセクションでは、Google Docs API を使用してドキュメントを編集する際に理解しておく必要のある動作と制限事項について説明します。
一般に、ドキュメント内の要素の構造が無効になるような編集は実行できません。各 documents.batchUpdate
リクエスト メソッドについて、それらのリクエストに適用される制約とルールを確認します。
以降のセクションでは、これらの方法に共通する主なルールについて説明します。
テキストを挿入
- 改行文字を挿入すると、そのインデックスに
Paragraph
が暗黙的に作成されます。新しい段落の段落スタイルは、リストや箇条書きなど、現在の挿入インデックスにある段落からコピーされます。 - テキストは既存の
Paragraph
の境界内に挿入する必要があります。たとえば、テーブルの開始インデックスにテキストを挿入することはできません。テキストは前の段落に挿入する必要があります。 - API は、Unicode 書記素クラスタ内への挿入を防ぐために、暗黙的に位置を調整する場合があります。この場合、テキストは書記素クラスタの直後に挿入されます。
- 挿入されたテキストのテキスト スタイルは自動的に決定され、通常は隣接するテキストのスタイルが保持されます。通常、挿入されたテキストのテキスト スタイルは、挿入インデックスの直前のテキストと一致します。
- 一部の制御文字(
U+0000-U+0008, U+000C-U+001F
)と Unicode 基本多言語面私用領域(U+E000-U+F8FF
)の文字は、挿入されたテキストから削除されます。 - 詳しくは、テキストの挿入、削除、移動をご覧ください。
インライン画像を挿入する
- 画像のサイズは 50 MB 未満、2,500 万ピクセル以下で、PNG、JPEG、GIF のいずれかの形式である必要があります。
- 指定する URI は一般公開されており、長さが 2 KB 以下である必要があります。
- 画像は既存の
Paragraph
の境界内に挿入する必要があります。たとえば、テーブルの開始インデックスにテキストを挿入することはできません。 - 画像は脚注や数式の中に挿入できません。
- 詳細については、インライン画像を挿入するをご覧ください。
テキストの書式を設定する
- 段落レベルの書式設定を範囲に適用すると、その範囲に一部または完全に重なるすべての段落に書式設定が適用されます。
- 範囲が拡張され、隣接する改行が含まれることがあります。
- 範囲にリストに属する段落が完全に含まれている場合、段落の箇条書きも一致するテキスト スタイルで更新されます。
- 詳しくは、テキストの書式設定をご覧ください。
段落の箇条書きを作成する
- 指定された範囲と重複するすべての段落に箇条書きを作成します。
- 各段落のネストレベルは、各段落の先頭にあるタブの数によって決まります。
- 箇条書きを作成すると、先頭のタブが削除されるため、テキストの一部でインデックスが変更されることがあります。
- リストの直前の段落に、リストの箇条書きと一致する箇条書きを追加すると、その段落はリストに結合されます。
- 詳細については、リストの操作をご覧ください。
テキストを削除する
段落の境界を越えてテキストを削除すると、2 つの段落が結合されるため、段落スタイル、リスト、配置されたオブジェクト、ブックマークが変更されることがあります。
ドキュメント構造が無効になる削除は許可されません。無効な削除リクエストの例は次のとおりです。
サロゲート ペアの 1 つのコード単位を削除する。
Body
、Header
、Footer
、Footnote
、TableCell
、TableOfContents
の最後の改行文字を削除します。要素全体を削除せずに、
Table
、TableOfContents
、またはEquation
の開始または終了を削除します。要素を削除せずに、
Table
、TableOfContents
、またはSectionBreak
の前の改行文字を削除します。テーブルの個々の行またはセルを削除する。表のセル内のコンテンツを削除することは許可されています。
詳しくは、テキストの挿入、削除、移動をご覧ください。