前回(第52回)は、Googleドキュメント内のプレースホルダー(例:{請求先会社名} や {請求日})を探し出し、一括で文字を置き換える Body.replaceText() について解説しました。テンプレート文章の一部を動的に書き換えるテクニックは、請求書や契約書の自動生成で大活躍しますよね!
しかし、実際の業務では「テンプレートの置換」だけでは対応できない場面もたくさんあります。 例えば、以下のようなケースです。
- 「請求書の下部に、取引先ごとに異なる『振込先口座案内』や『特記事項』を動的に追記したい」
- 「日次レポートの末尾に、今日の業務日誌やメモを1段落追加したい」
- 「ドキュメントの最後に、注意事項の文章をサッと付け加えたい」
あらかじめテンプレート側に文字が入っていなくても、GAS(Google Apps Script)を使えばドキュメントの一番最後に新しい「段落(文章のまとまり)」をいくらでも自動追加できます。
そのために使用するのが、今回マスターする Body.appendParagraph() です!
今回は、この appendParagraph() の基本的な仕組みから、実際のコード例、実務で使える応用パターン、そして初心者が必ずハマる注意点まで、どこよりも分かりやすく徹底解説していきます!
1. そもそも Body.appendParagraph() とは?
Body.appendParagraph() は、Googleドキュメントの「本文(Body)」に対して、一番最後の部分(末尾)に新しい段落(Paragraph)を追加する命令(メソッド)です。
まずは英単語を分解して、意味を整理してみましょう。
- Body(ボディ):Googleドキュメントの「本文エリア」全体を指すオブジェクトです。
- .append(アペンド):第7回(
Sheet.appendRow())でも登場した言葉ですね。「(末尾に)追加する・付け加える」という意味があります。 - Paragraph(パラグラフ):文章の「段落」のことです。Googleドキュメントでは、Enterキーで改行したひとまとまりの文章を1つの段落として扱います。
つまり、「ドキュメントの本文の末尾に、新しい段落を1つ追加してね!」とGASに指示を出しているわけです。
「ノートの最後の行への書き加え」でイメージしよう!
手帳やノートをイメージしてみてください。
- 第52回の
replaceText()= ノートに書いてある既存の文字を消しゴムで消して、新しい文字に書き直す操作 - 今回の
appendParagraph()= ノートの最後の行まで移動して、新しい行から文章を書き始める操作
既存の文章を一切壊すことなく、安全に新しいテキストを後ろへ後ろへと積み重ねていくことができるのが、appendParagraph() の大きな特徴です。
2. STEP1:準備!「札幌オフィスの請求書ドキュメント」を用意しよう
それでは、実際にGASから操作するための練習用ドキュメントを用意しましょう! 今回は「札幌オフィス」で発行する請求書の下部に、振込先案内や冬期の配送注意点を追記するシチュエーションを想定します。
手順
- Googleドライブを開く
ブラウザでGoogleドライブを開き、左上の「新規」>「Googleドキュメント」をクリックして、新しいドキュメントを作成します。 - ドキュメント名を変更する
画面左上の「無題のドキュメント」をクリックし、「【札幌オフィス】請求書テンプレート」 に変更します。 - 本文に適当なサンプル文章を入力しておく
ドキュメントの本文に、以下のようなテキストを入力しておきましょう。
御請求書
株式会社デジタルワンダーランド 御中
平素は格別のご高配を賜り、厚く御礼申し上げます。
下記の通りご請求申し上げます。
ご請求金額:¥150,000-
- ドキュメントIDをコピーする
第51回でお伝えした通り、ブラウザのアドレスバー(URL)からドキュメントIDを取得します。https://docs.google.com/document/d/1A2B3C4D5E6F7G8H9I0J_ExampleID_1234567/edit
URLの/d/と/editの間にある長英数字の文字列(ドキュメントID)をコピーしておいてください。
3. STEP2:【実践】請求書の下部に「振込先口座案内」の段落を追加してみよう!
準備ができたら、GASのエディタを開いてコードを書いていきましょう!
1. コードを入力する
任意のGoogleスプレッドシートや、スタンドアロンスクリプトからGASのエディタを開き、以下のコードを貼り付けます。(YOUR_DOCUMENT_ID_HERE の部分は、先ほどコピーしたご自身のドキュメントIDに書き換えてください)
function addNoticeToInvoice() {
// ① 操作したいGoogleドキュメントをIDで開く(第51回)
var docId = "YOUR_DOCUMENT_ID_HERE";
var doc = DocumentApp.openById(docId);
// ② ドキュメントの本文エリア(Body)を取得する
var body = doc.getBody();
// ③ ドキュメントの末尾に新しい段落(振込先案内)を追加する!
body.appendParagraph("【お振込先口座のご案内】");
body.appendParagraph("北洋銀行 札幌駅前支店 普通口座 1234567 カ)デジタルワンダーランド");
body.appendParagraph("※恐れ入りますが、振込手数料は貴社にてご負担願います。");
body.appendParagraph("※北海道内の冬期悪天候に伴う配送遅延等の特記事項につきましては、弊社カスタマーサポートまでお問い合わせください。");
// ④ 実行ログで完了を確認する
Logger.log("請求書の末尾に振込先案内と特記事項を追加しました!");
}
2. コードを1行ずつ徹底解説!
初心者向けに、プログラムの動きを紐解いていきます。
var doc = DocumentApp.openById(docId);- 第51回で学んだ命令ですね!指定したIDのGoogleドキュメント全体を開いて、変数
docに読み込んでいます。
- 第51回で学んだ命令ですね!指定したIDのGoogleドキュメント全体を開いて、変数
var body = doc.getBody();- ドキュメント全体(
doc)の中から、「本文エリア(body)」を取り出しています。appendParagraph()はドキュメント本体に対してではなく、このbodyオブジェクトに対して実行する必要があるため、必ずこの1行が必要になります。
- ドキュメント全体(
body.appendParagraph("【お振込先口座のご案内】");- 本日の主役です!
bodyに対し.appendParagraph("文字列")を呼び出しています。カッコの中に渡した文字列が、ドキュメントの一番最後に「新しい段落」として自動追加されます。
- 本日の主役です!
3. 保存して実行してみよう!
- エディタ上部の 「保存アイコン(フロッピーディスク)」 をクリックします。
- 関数が
addNoticeToInvoiceになっていることを確認し、「実行」 ボタンをクリックします。(初回実行時はGoogleアカウントのアクセス許可ポップアップが出ますので、画面の指示に従って許可してください) - 実行完了後、Googleドキュメントの画面を開いて確認してみましょう!
【実行結果の確認】
元々書いてあった「ご請求金額:¥150,000-」の下に、改行されて新しい段落(お振込先口座のご案内…)が整然と追加されていれば大成功です!
1行ずつ appendParagraph() を呼び出すだけで、文章の塊が順番に末尾へ積み重なっていく感覚が掴めたでしょうか?
4. STEP3:実務で使える!appendParagraph() の応用パターン3選
単に1行のテキストを足すだけでなく、実務で頻繁に使う3つの発展テクニックをご紹介します。
応用①:改行コード \n を使って複数行をまとめて1つの段落で追加する
appendParagraph() を何回も書くのが大変な場合、文字列の中に改行コード \n(バックスラッシュ + n、または 円マーク + n) を挟むことで、1回の命令で複数行の文章をまとめて追加できます。
function addMultiLineNotice() {
var doc = DocumentApp.openById("YOUR_DOCUMENT_ID_HERE");
var body = doc.getBody();
// \n を挟んで長い文章を一気に準備する
var noticeText = "【特記事項】\n" +
"1. 本請求書の発行日より30日以内にお振込みください。\n" +
"2. 札幌本社へのご来社による現金でのお支払いは受け付けておりません。";
// 1回の appendParagraph で追加!
body.appendParagraph(noticeText);
}
応用②:返り値(Paragraphオブジェクト)を受け取って、文字装飾の準備をする
実は appendParagraph() は、文章を追加するだけでなく、「追加された新しい段落オブジェクト(Paragraph)」を戻り値として返してくれます。
変数でその段落を受け取っておくことで、後続の処理で「その段落の見出しレベルを変える」「文字サイズや色を変える」といったカスタマイズが可能になります!
function addStyledParagraph() {
var doc = DocumentApp.openById("YOUR_DOCUMENT_ID_HERE");
var body = doc.getBody();
// 追加した段落を変数 p に受け取る!
var p = body.appendParagraph("ご請求明細");
// 変数 p(Paragraphオブジェクト)に対して、次回以降に学ぶ装飾命令を実行できる!
// 例:見出し2に設定する(第54回で詳しく解説!)
// p.setHeading(DocumentApp.ParagraphHeading.HEADING2);
}
このように、「追加して終わり」ではなく「追加した段落を掴んで装飾する」という流れを作れるのがGASの強みです。
応用③:配列とループ処理(forEach)を使って箇条書きテキストを一括追加する
複数の注意事項や案内文がある場合、配列に入れて繰返し処理を行うとスマートなコードになります。
function addListNotes() {
var doc = DocumentApp.openById("YOUR_DOCUMENT_ID_HERE");
var body = doc.getBody();
// 追加したい項目を配列で準備する
var notes = [
"・納品物に関するお問い合わせは発行より7日以内にお願いいたします。",
"・領収書につきましては振込明細書をもって代えさせていただきます。",
"・札幌オフィスの冬期休業期間(12/29〜1/3)はサポート窓口がお休みとなります。"
];
// 配列の要素を1つずつ順番に末尾へ追加する
notes.forEach(function(note) {
body.appendParagraph(note);
});
}
5. 超重要!初心者が絶対につまずく「5大トラップ」と完全対処法
Body.appendParagraph() を使う際、プログラミング初心者やGAS学習者がよく遭遇するトラブルと解決策をまとめました。
トラップ1:doc.appendParagraph() と書いて TypeError になる
初心者事故率No.1のミスです!
// ✕ エラーになる書き方
var doc = DocumentApp.openById(docId);
doc.appendParagraph("テスト");
// エラー:TypeError: doc.appendParagraph is not a function
【原因】
appendParagraph() は Document(ファイル全体)のメソッドではなく、Body(本文エリア)のメソッドです。
【解決策】
必ず var body = doc.getBody(); を挟んでから、body.appendParagraph(...) と呼び出しましょう!
トラップ2:appendParagraph のスペルミス(タイポ)
JavaScript / GAS は大文字と小文字を厳密に区別します。
- ✕
appendparagraph(pが小文字) - ✕
AppendParagraph(先頭のAが大文字) - ✕
appendParagraphs(最後にsがついている) - ◯
appendParagraph(Pのみ大文字)
エディタで body.append... まで入力した時に出てくる予測変換(補完機能)をEnterキーで選択して入力するのが最も安全です。
トラップ3:スプレッドシートの appendRow() と混同して配列を渡してしまう
スプレッドシート操作(第7回)で学んだ Sheet.appendRow(["データ1", "データ2"]) のイメージが強いと、ついつい appendParagraph にも配列 ["文字1", "文字2"] を渡したくなってしまいます。
しかし、appendParagraph() のカッコ内に渡せるのは 原則として「文字列(テキスト)」 です。配列をそのまま渡すと、カンマ区切りの記号ごと文字として追加されてしまったり、思わぬ挙動の原因になります。
トラップ4:「文章の途中」に挿入しようとして appendParagraph を使ってしまう
append という単語の通り、このメソッドは「常にドキュメントの一番最後(末尾)」に段落を追加します。
「2行目と3行目のあいだに文章を割り込ませたい!」という時に appendParagraph() を使っても、途中には入らず一番下に追記されてしまいます。
※ドキュメントの途中に段落を割り込ませたい(挿入したい)場合は、今後学習する Body.insertParagraph(index, text) を使用しますので、まずは「append = 一番最後!」と覚えておきましょう。
トラップ5:数値や日付を直接渡してエラーになる
数値(例:150000)や日付オブジェクト(例:new Date())をそのまま appendParagraph() に渡すと、エラーになったり予期せぬフォーマットで出力されることがあります。
文字以外のデータを追加したい場合は、必ず String(150000) や "" + 150000 のように文字列型に変換してから渡す癖をつけておくと安全です。
6. まとめ&次回予告
今回は、Googleドキュメントの末尾にテキストを追加する Body.appendParagraph() について解説しました。
今日の重要ポイントおさらい
appendParagraph()はドキュメント本文(Body)の末尾に新しい段落を追加する命令doc.getBody()で本文エリアを取得してから呼び出す- 改行コード
\nを使えば、1回の実行で複数行のテキストを一気に追加可能 - 追加された段落(Paragraphオブジェクト)を変数に受け取ることで、今後の文字装飾に活用できる
これで、「テンプレートの文字を置き換える(replaceText)」だけでなく、「文書の最後に動的な情報をどんどん追記する(appendParagraph)」ことができるようになりましたね!
しかし、ただ黒色の標準テキストが追加されるだけでは、どれが「見出し」でどれが「重要なお知らせ」なのか、パッと見て分かりづらいですよね。
そこで次回(第54回)は、今回追加した段落に対して「見出しスタイル」を適用する Paragraph.setHeading() を解説します!
請求書内の「ご請求明細」や「お振込先」の文字を、プロっぽい見出しデザイン(Heading 2など)に一瞬で切り替えるテクニックを学んでいきましょう。ぜひお楽しみに!
