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