このページは Cloud Translation API によって翻訳されました。

Class Body

Google ドキュメントドキュメントのタブの内容。Body には、ListItem、Paragraph、Table、TableOfContents の各要素を含めることができます。ドキュメント構造の詳細については、Google ドキュメントの拡張に関するガイドをご覧ください。

通常、Body には、HeaderSection、FooterSection、FootnoteSection 要素を除くタブのコンテンツ全体が含まれます。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

メソッド

メソッド	戻り値の型	概要
`appendHorizontalRule()`	`HorizontalRule`	新しい `HorizontalRule` を作成して追加します。
`appendImage(image)`	`InlineImage`	指定されたイメージブロブから新しい `InlineImage` を作成して追加します。
`appendImage(image)`	`InlineImage`	指定された `InlineImage` を追加します。
`appendListItem(listItem)`	`ListItem`	指定された `ListItem` を追加します。
`appendListItem(text)`	`ListItem`	指定されたテキストコンテンツを含む新しい `ListItem` を作成して追加します。
`appendPageBreak()`	`PageBreak`	新しい `PageBreak` を作成して追加します。
`appendPageBreak(pageBreak)`	`PageBreak`	指定された `PageBreak` を追加します。
`appendParagraph(paragraph)`	`Paragraph`	指定された `Paragraph` を追加します。
`appendParagraph(text)`	`Paragraph`	指定されたテキストコンテンツを含む新しい `Paragraph` を作成して追加します。
`appendTable()`	`Table`	新しい `Table` を作成して追加します。
`appendTable(cells)`	`Table`	指定された文字列値ごとに `TableCell` を含む新しい `Table` を追加します。
`appendTable(table)`	`Table`	指定された `Table` を追加します。
`clear()`	`Body`	要素の内容を消去します。
`copy()`	`Body`	現在の要素の切断されたディープコピーを返します。
`editAsText()`	`Text`	編集用に現在の要素の `Text` バージョンを取得します。
`findElement(elementType)`	`RangeElement`	要素の内容で、指定したタイプの子孫を検索します。
`findElement(elementType, from)`	`RangeElement`	指定された `RangeElement` から、指定されたタイプの子孫を要素の内容で検索します。
`findText(searchPattern)`	`RangeElement`	正規表現を使用して、要素のコンテンツで指定されたテキストパターンを検索します。
`findText(searchPattern, from)`	`RangeElement`	指定された検索結果から、要素のコンテンツで指定されたテキストパターンを検索します。
`getAttributes()`	`Object`	要素の属性を取得します。
`getChild(childIndex)`	`Element`	指定された子インデックスの子要素を取得します。
`getChildIndex(child)`	`Integer`	指定された子要素の子インデックスを取得します。
`getHeadingAttributes(paragraphHeading)`	`Object`	指定された `ParagraphHeading` の属性セットを取得します。
`getImages()`	`InlineImage[]`	セクションに含まれるすべての `InlineImages` を取得します。
`getListItems()`	`ListItem[]`	セクションに含まれるすべての `ListItems` を取得します。
`getMarginBottom()`	`Number`	下部余白（ポイント単位）を取得します。
`getMarginLeft()`	`Number`	左側余白（ポイント単位）を取得します。
`getMarginRight()`	`Number`	右余白を取得します。
`getMarginTop()`	`Number`	上余白を取得します。
`getNumChildren()`	`Integer`	子の数を取得します。
`getPageHeight()`	`Number`	ページの高さをポイント単位で取得します。
`getPageWidth()`	`Number`	ページの幅（ポイント単位）を取得します。
`getParagraphs()`	`Paragraph[]`	セクションに含まれるすべての `Paragraphs`（`ListItems` を含む）を取得します。
`getParent()`	`ContainerElement`	要素の親要素を取得します。
`getTables()`	`Table[]`	セクションに含まれるすべての `Tables` を取得します。
`getText()`	`String`	要素のコンテンツをテキスト文字列として取得します。
`getTextAlignment()`	`TextAlignment`	テキストの配置を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	指定したインデックスに新しい `HorizontalRule` を作成して挿入します。
`insertImage(childIndex, image)`	`InlineImage`	指定されたイメージブロブから `InlineImage` を作成して、指定されたインデックスに挿入します。
`insertImage(childIndex, image)`	`InlineImage`	指定された `InlineImage` を指定されたインデックスに挿入します。
`insertListItem(childIndex, listItem)`	`ListItem`	指定された `ListItem` を指定されたインデックスに挿入します。
`insertListItem(childIndex, text)`	`ListItem`	指定されたインデックスに、指定されたテキストコンテンツを含む新しい `ListItem` を作成して挿入します。
`insertPageBreak(childIndex)`	`PageBreak`	指定したインデックスに新しい `PageBreak` を作成して挿入します。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	指定された `PageBreak` を指定されたインデックスに挿入します。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	指定された `Paragraph` を指定されたインデックスに挿入します。
`insertParagraph(childIndex, text)`	`Paragraph`	指定されたインデックスに、指定されたテキストコンテンツを含む新しい `Paragraph` を作成して挿入します。
`insertTable(childIndex)`	`Table`	指定したインデックスに新しい `Table` を作成して挿入します。
`insertTable(childIndex, cells)`	`Table`	指定されたセルを含む新しい `Table` を作成して、指定されたインデックスに挿入します。
`insertTable(childIndex, table)`	`Table`	指定された `Table` を指定されたインデックスに挿入します。
`removeChild(child)`	`Body`	指定された子要素を削除します。
`replaceText(searchPattern, replacement)`	`Element`	正規表現を使用して、指定したテキストパターンのすべての出現を指定された置換文字列に置き換えます。
`setAttributes(attributes)`	`Body`	要素の属性を設定します。
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	指定された `ParagraphHeading` の属性を設定します。
`setMarginBottom(marginBottom)`	`Body`	下余白をポイント単位で設定します。
`setMarginLeft(marginLeft)`	`Body`	左余白をポイント単位で設定します。
`setMarginRight(marginRight)`	`Body`	右余白をポイント単位で設定します。
`setMarginTop(marginTop)`	`Body`	上余白を設定します。
`setPageHeight(pageHeight)`	`Body`	ページの高さをポイント単位で設定します。
`setPageWidth(pageWidth)`	`Body`	ページの幅をポイント単位で設定します。
`setText(text)`	`Body`	コンテンツをプレーンテキストとして設定します。
`setTextAlignment(textAlignment)`	`Body`	テキストの配置を設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getFootnotes()`	`Footnote[]`	セクションに含まれるすべての `Footnotes` を取得します。
`getLinkUrl()`	`String`	リンクの URL を取得します。
`getNextSibling()`	`Element`	要素の次の兄弟要素を取得します。
`getPreviousSibling()`	`Element`	要素の前の兄弟要素を取得します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の末尾にあるかどうかを判断します。
`setLinkUrl(url)`	`Body`	リンク URL を設定します。

詳細なドキュメント

`appendHorizontalRule()`

新しい HorizontalRule を作成して追加します。

HorizontalRule は新しい Paragraph に含まれます。

戻る

HorizontalRule - 新しい横線。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

指定されたイメージブロブから新しい InlineImage を作成して追加します。

イメージは新しい Paragraph に格納されます。

パラメータ

名前	型	説明
`image`	`BlobSource`	画像データ。

戻る

InlineImage - 追加された画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

指定された InlineImage を追加します。

InlineImage は新しい Paragraph に含まれます。

既存の InlineImage のコピーを追加する場合は、このバージョンの appendImage を使用します。

パラメータ

名前	型	説明
`image`	`InlineImage`	画像データ。

戻る

InlineImage - 追加された画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(listItem)`

指定された ListItem を追加します。

既存の ListItem のコピーを追加する場合は、このバージョンの appendListItem を使用します。

パラメータ

名前	型	説明
`listItem`	`ListItem`	追加するリストアイテム。

戻る

ListItem - 追加されたリストアイテム。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(text)`

指定されたテキストコンテンツを含む新しい ListItem を作成して追加します。

連続するリストアイテムは、同じリストの一部として追加されます。

パラメータ

名前	型	説明
`text`	`String`	リストアイテムのテキストコンテンツ。

戻る

ListItem - 新しいリストアイテム。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak()`

新しい PageBreak を作成して追加します。

PageBreak は新しい Paragraph に含まれます。

戻る

PageBreak - 新しい改ページ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak(pageBreak)`

指定された PageBreak を追加します。

PageBreak は新しい Paragraph に含まれます。

既存の PageBreak のコピーを追加する場合は、このバージョンの appendPageBreak を使用します。

パラメータ

名前	型	説明
`pageBreak`	`PageBreak`	追加する改ページ。

戻る

PageBreak - 追加された改ページ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(paragraph)`

指定された Paragraph を追加します。

既存の Paragraph のコピーを追加する場合は、このバージョンの appendParagraph を使用します。

パラメータ

名前	型	説明
`paragraph`	`Paragraph`	追加する段落。

戻る

Paragraph - 追加された段落。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(text)`

指定されたテキストコンテンツを含む新しい Paragraph を作成して追加します。

パラメータ

名前	型	説明
`text`	`String`	段落のテキストコンテンツ。

戻る

Paragraph - 新しい段落。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable()`

新しい Table を作成して追加します。

また、Google ドキュメントのドキュメントは表で終わることができないため、この方法では表の後に空の段落も追加されます。

戻る

Table - 新しいテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(cells)`

指定された文字列値ごとに TableCell を含む新しい Table を追加します。

また、Google ドキュメントのドキュメントは表で終わることができないため、この方法では表の後に空の段落も追加されます。

パラメータ

名前	型	説明
`cells`	`String[][]`	新しいテーブルに追加する表セルのテキストコンテンツ。

戻る

Table - 追加されたテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(table)`

指定された Table を追加します。

既存の Table のコピーを追加する場合は、このバージョンの appendTable を使用します。また、Google ドキュメントのドキュメントは表で終わることができないため、この方法では表の後に空の段落も追加されます。

パラメータ

名前	型	説明
`table`	`Table`	追加するテーブル。

戻る

Table - 追加されたテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`clear()`

要素の内容を消去します。

戻る

Body - 現在の要素。

`copy()`

現在の要素の切断されたディープコピーを返します。

要素に存在する子要素もコピーされます。新しい要素に親がありません。

戻る

Body - 新しいコピー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`editAsText()`

編集用に現在の要素の Text バージョンを取得します。

要素の内容をリッチテキストとして操作するには、editAsText を使用します。editAsText モードでは、テキスト以外の要素（InlineImage や HorizontalRule など）は無視されます。

削除されたテキスト範囲に完全に含まれる子要素は、要素から削除されます。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

戻る

Text - 現在の要素のテキストバージョン

`findElement(elementType)`

要素の内容で、指定したタイプの子孫を検索します。

パラメータ

名前	型	説明
`elementType`	`ElementType`	検索する要素のタイプ。

戻る

RangeElement - 検索要素の位置を示す検索結果。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findElement(elementType, from)`

指定された RangeElement から、指定されたタイプの子孫を要素の内容で検索します。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

パラメータ

名前	型	説明
`elementType`	`ElementType`	検索する要素のタイプ。
`from`	`RangeElement`	検索結果から検索する検索結果。

戻る

RangeElement - 検索要素の次の位置を示す検索結果。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern)`

正規表現を使用して、要素のコンテンツで指定されたテキストパターンを検索します。

JavaScript 正規表現機能のサブセット（キャプチャグループやモード修飾子など）は完全にはサポートされていません。

指定された正規表現パターンは、現在の要素に含まれる各テキストブロックと個別に照合されます。

パラメータ

名前	型	説明
`searchPattern`	`String`	検索するパターン

戻る

RangeElement - 検索テキストの位置を示す検索結果。一致がない場合、null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern, from)`

指定された検索結果から、要素のコンテンツで指定されたテキストパターンを検索します。

JavaScript 正規表現機能のサブセット（キャプチャグループやモード修飾子など）は完全にはサポートされていません。

指定された正規表現パターンは、現在の要素に含まれる各テキストブロックと個別に照合されます。

パラメータ

名前	型	説明
`searchPattern`	`String`	検索するパターン
`from`	`RangeElement`	検索結果

戻る

RangeElement - 検索テキストの次の位置を示す検索結果。一致がない場合、null です。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getAttributes()`

要素の属性を取得します。

結果は、有効な要素属性ごとにプロパティを含むオブジェクトです。各プロパティ名は、DocumentApp.Attribute 列挙型の項目に対応しています。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

戻る

Object - 要素の属性。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChild(childIndex)`

指定された子インデックスの子要素を取得します。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

パラメータ

名前	型	説明
`childIndex`	`Integer`	取得する子要素のインデックス。

戻る

Element - 指定されたインデックスの子要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChildIndex(child)`

指定された子要素の子インデックスを取得します。

パラメータ

名前	型	説明
`child`	`Element`	インデックスを取得する子要素。

戻る

Integer - 子インデックス。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getHeadingAttributes(paragraphHeading)`

指定された ParagraphHeading の属性セットを取得します。

パラメータ

名前	型	説明
`paragraphHeading`	`ParagraphHeading`	属性を取得する見出し。

戻る

Object - 属性とその現在の値のマップ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getImages()`

セクションに含まれるすべての InlineImages を取得します。

戻る

InlineImage[] - セクション画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getListItems()`

セクションに含まれるすべての ListItems を取得します。

戻る

ListItem[] - セクションリストアイテム。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginBottom()`

下部余白（ポイント単位）を取得します。

戻る

Number - 下余白（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginLeft()`

左側余白（ポイント単位）を取得します。

戻る

Number - 左余白（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginRight()`

右余白を取得します。

戻る

Number - 右余白（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginTop()`

上余白を取得します。

戻る

Number - 上余白（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNumChildren()`

子の数を取得します。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

戻る

Integer - 子の数。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageHeight()`

ページの高さをポイント単位で取得します。

戻る

Number - ページの高さ（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageWidth()`

ページの幅（ポイント単位）を取得します。

戻る

Number - ページの幅（ポイント単位）。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParagraphs()`

セクションに含まれるすべての Paragraphs（ListItems を含む）を取得します。

戻る

Paragraph[] - セクションの段落。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParent()`

要素の親要素を取得します。

親要素には現在の要素が含まれています。

戻る

ContainerElement - 親要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTables()`

セクションに含まれるすべての Tables を取得します。

戻る

Table[] - セクションテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getText()`

要素のコンテンツをテキスト文字列として取得します。

戻る

String - 要素の内容（テキスト文字列）

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTextAlignment()`

テキストの配置を取得します。使用できる配置のタイプは、DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT、DocumentApp.TextAlignment.SUPERSCRIPT です。

戻る

TextAlignment - テキストの配置のタイプ。テキストに複数のタイプのテキストの配置が含まれている場合、またはテキストの配置が設定されていない場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getType()`

要素の ElementType を取得します。

getType() を使用して、特定の要素の正確な型を判断します。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

戻る

ElementType - 要素のタイプ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertHorizontalRule(childIndex)`

指定したインデックスに新しい HorizontalRule を作成して挿入します。

HorizontalRule は新しい Paragraph に含まれます。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス。

戻る

HorizontalRule - 新しい横線。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

指定されたイメージブロブから InlineImage を作成して、指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス。
`image`	`BlobSource`	画像データ。

戻る

InlineImage - 挿入されたインライン画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

指定された InlineImage を指定されたインデックスに挿入します。

イメージは新しい Paragraph に格納されます。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス。
`image`	`InlineImage`	挿入する画像。

戻る

InlineImage - 挿入されたインライン画像。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, listItem)`

指定された ListItem を指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`listItem`	`ListItem`	挿入するリスト項目。

戻る

ListItem - 挿入されたリストアイテム。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, text)`

指定されたインデックスに、指定されたテキストコンテンツを含む新しい ListItem を作成して挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`text`	`String`	リストアイテムのテキストコンテンツ。

戻る

ListItem - 新しいリストアイテム。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex)`

指定したインデックスに新しい PageBreak を作成して挿入します。

PageBreak は新しい Paragraph に含まれます。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス。

戻る

PageBreak - 新しい改ページ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex, pageBreak)`

指定された PageBreak を指定されたインデックスに挿入します。

PageBreak は新しい Paragraph に含まれます。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス。
`pageBreak`	`PageBreak`	挿入する改ページ。

戻る

PageBreak - 挿入された改ページ。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, paragraph)`

指定された Paragraph を指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`paragraph`	`Paragraph`	挿入する段落。

戻る

Paragraph - 挿入された段落。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, text)`

指定されたインデックスに、指定されたテキストコンテンツを含む新しい Paragraph を作成して挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`text`	`String`	段落のテキストコンテンツ。

戻る

Paragraph - 新しい段落。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex)`

指定したインデックスに新しい Table を作成して挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。

戻る

Table - 新しいテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, cells)`

指定されたセルを含む新しい Table を作成して、指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`cells`	`String[][]`	新しいテーブルに追加する表セルのテキストコンテンツ。

戻る

Table - 新しいテーブル。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, table)`

指定された Table を指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	挿入するインデックス。
`table`	`Table`	挿入するテーブル。

戻る

Table - 挿入された表。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeChild(child)`

指定された子要素を削除します。

パラメータ

名前	型	説明
`child`	`Element`	削除する子要素。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`replaceText(searchPattern, replacement)`

正規表現を使用して、指定したテキストパターンのすべての出現を指定された置換文字列に置き換えます。

検索パターンは、JavaScript 正規表現オブジェクトではなく、文字列として渡されます。そのため、パターン内のバックスラッシュをエスケープする必要があります。

このメソッドは Google の RE2 正規表現ライブラリを使用します。これにより、サポートされる構文が制限されます。

指定された正規表現パターンは、現在の要素に含まれる各テキストブロックに対して個別に照合されます。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

パラメータ

名前	型	説明
`searchPattern`	`String`	検索する正規表現パターン
`replacement`	`String`	置換として使用するテキスト

戻る

Element - 現在の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

要素の属性を設定します。

指定された attributes パラメータは、各プロパティ名が DocumentApp.Attribute 列挙型のアイテムで、各プロパティ値が適用される新しい値であるオブジェクトである必要があります。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

パラメータ

名前	型	説明
`attributes`	`Object`	要素の属性。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setHeadingAttributes(paragraphHeading, attributes)`

指定された ParagraphHeading の属性を設定します。

パラメータ

名前	型	説明
`paragraphHeading`	`ParagraphHeading`	属性を設定する見出し。
`attributes`	`Object`	属性と、それらに設定する値のマップ。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginBottom(marginBottom)`

下余白をポイント単位で設定します。

パラメータ

名前	型	説明
`marginBottom`	`Number`	下余白（ポイント単位）。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginLeft(marginLeft)`

左余白をポイント単位で設定します。

パラメータ

名前	型	説明
`marginLeft`	`Number`	左余白（ポイント単位）。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginRight(marginRight)`

右余白をポイント単位で設定します。

パラメータ

名前	型	説明
`marginRight`	`Number`	右余白。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginTop(marginTop)`

上余白を設定します。

パラメータ

名前	型	説明
`marginTop`	`Number`	上余白（ポイント単位）。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageHeight(pageHeight)`

ページの高さをポイント単位で設定します。

パラメータ

名前	型	説明
`pageHeight`	`Number`	ページの高さ（ポイント単位）。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageWidth(pageWidth)`

ページの幅をポイント単位で設定します。

パラメータ

名前	型	説明
`pageWidth`	`Number`	ページの幅（ポイント単位）。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setText(text)`

コンテンツをプレーンテキストとして設定します。

注: 既存のコンテンツは消去されます。

パラメータ

名前	型	説明
`text`	`String`	新しいテキストコンテンツ。

戻る

Body - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setTextAlignment(textAlignment)`

テキストの配置を設定します。使用できる配置のタイプは、DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT、DocumentApp.TextAlignment.SUPERSCRIPT です。

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

パラメータ

名前	型	説明
`textAlignment`	`TextAlignment`	適用するテキストの配置の種類

戻る

Body - 現在の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

サポート終了のメソッド

`getFootnotes()`

非推奨。この要素には Footnote を含めることはできません。

セクションに含まれるすべての Footnotes を取得します。

戻る

Footnote[] - セクションの脚注。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getLinkUrl()`

非推奨。セクション全体にリンクを適用するのではなく、セクション内の要素にリンクを適用します。

リンクの URL を取得します。

戻る

String - リンク URL。要素にこの属性の値が複数含まれている場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNextSibling()`

非推奨。この要素には兄弟要素がありません。

要素の次の兄弟要素を取得します。

次の兄弟は同じ親を持ち、現在の要素の後に続く要素です。

戻る

Element - 次の兄弟要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPreviousSibling()`

非推奨。この要素には兄弟要素がありません。

要素の前の兄弟要素を取得します。

前の兄弟は同じ親を持ち、現在の要素の前に配置されています。

戻る

Element - 前の兄弟要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`isAtDocumentEnd()`

非推奨。この方法は HeaderSection では信頼できません。

要素が Document の末尾にあるかどうかを判断します。

戻る

Boolean - 要素がタブの末尾にあるかどうか。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

非推奨。セクション全体にリンクを適用するのではなく、セクション内の要素にリンクを適用します。

リンク URL を設定します。

パラメータ

名前	型	説明
`url`	`String`	リンク URL

戻る

Body - 現在の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents