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テキストの配置を設定します。

詳細なドキュメント

appendHorizontalRule()

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

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

戻る

HorizontalRule - 新しい横線。

承認

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

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

appendImage(image)

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

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

パラメータ

名前型説明
imageBlobSource画像データ。

戻る

InlineImage - 追加された画像。

承認

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

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

appendImage(image)

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

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

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

パラメータ

名前型説明
imageInlineImage画像データ。

戻る

InlineImage - 追加された画像。

承認

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

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

appendListItem(listItem)

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

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

パラメータ

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

戻る

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

承認

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

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

appendListItem(text)

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

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

パラメータ

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

戻る

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 を使用します。

パラメータ

名前型説明
pageBreakPageBreak追加する改ページ。

戻る

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

承認

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

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

appendParagraph(paragraph)

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

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

パラメータ

名前型説明
paragraphParagraph追加する段落。

戻る

Paragraph - 追加された段落。

承認

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

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

appendParagraph(text)

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

パラメータ

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

戻る

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

パラメータ

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

戻る

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

承認

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

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

appendTable(table)

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

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

パラメータ

名前型説明
tableTable追加するテーブル。

戻る

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)

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

パラメータ

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

戻る

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;
  }
}

パラメータ

名前型説明
elementTypeElementType検索する要素のタイプ。
fromRangeElement検索結果から検索する検索結果。

戻る

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

承認

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

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

findText(searchPattern)

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

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

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

パラメータ

名前型説明
searchPatternString検索するパターン

戻る

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

承認

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

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

findText(searchPattern, from)

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

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

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

パラメータ

名前型説明
searchPatternString検索するパターン
fromRangeElement検索結果

戻る

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.');
}

パラメータ

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

戻る

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

承認

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

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

getChildIndex(child)

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

パラメータ

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

戻る

Integer - 子インデックス。

承認

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

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

getHeadingAttributes(paragraphHeading)

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

パラメータ

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

戻る

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 に含まれます。

パラメータ

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

戻る

HorizontalRule - 新しい横線。

承認

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

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

insertImage(childIndex, image)

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

パラメータ

名前型説明
childIndexInteger要素を挿入するインデックス。
imageBlobSource画像データ。

戻る

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

承認

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

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

insertImage(childIndex, image)

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

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

パラメータ

名前型説明
childIndexInteger要素を挿入するインデックス。
imageInlineImage挿入する画像。

戻る

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

承認

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

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

insertListItem(childIndex, listItem)

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

パラメータ

名前型説明
childIndexInteger挿入するインデックス。
listItemListItem挿入するリスト項目。

戻る

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

承認

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

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

insertListItem(childIndex, text)

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

パラメータ

名前型説明
childIndexInteger挿入するインデックス。
textStringリストアイテムのテキスト コンテンツ。

戻る

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

承認

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

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

insertPageBreak(childIndex)

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

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

パラメータ

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

戻る

PageBreak - 新しい改ページ。

承認

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

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

insertPageBreak(childIndex, pageBreak)

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

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

パラメータ

名前型説明
childIndexInteger要素を挿入するインデックス。
pageBreakPageBreak挿入する改ページ。

戻る

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

承認

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

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

insertParagraph(childIndex, paragraph)

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

パラメータ

名前型説明
childIndexInteger挿入するインデックス。
paragraphParagraph挿入する段落。

戻る

Paragraph - 挿入された段落。

承認

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

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

insertParagraph(childIndex, text)

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

パラメータ

名前型説明
childIndexInteger挿入するインデックス。
textString段落のテキスト コンテンツ。

戻る

Paragraph - 新しい段落。

承認

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

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

insertTable(childIndex)

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

パラメータ

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

戻る

Table - 新しいテーブル。

承認

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

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

insertTable(childIndex, cells)

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

パラメータ

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

戻る

Table - 新しいテーブル。

承認

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

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

insertTable(childIndex, table)

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

パラメータ

名前型説明
childIndexInteger挿入するインデックス。
tableTable挿入するテーブル。

戻る

Table - 挿入された表。

承認

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

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

removeChild(child)

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

パラメータ

名前型説明
childElement削除する子要素。

戻る

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

パラメータ

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

戻る

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

パラメータ

名前型説明
attributesObject要素の属性。

戻る

Body - 現在の要素。

承認

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

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

setHeadingAttributes(paragraphHeading, attributes)

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

パラメータ

名前型説明
paragraphHeadingParagraphHeading属性を設定する見出し。
attributesObject属性と、それらに設定する値のマップ。

戻る

Body - 現在の要素。

承認

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

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

setMarginBottom(marginBottom)

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

パラメータ

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

戻る

Body - 現在の要素。

承認

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

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

setMarginLeft(marginLeft)

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

パラメータ

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

戻る

Body - 現在の要素。

承認

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

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

setMarginRight(marginRight)

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

パラメータ

名前型説明
marginRightNumber右余白。

戻る

Body - 現在の要素。

承認

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

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

setMarginTop(marginTop)

上余白を設定します。

パラメータ

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

戻る

Body - 現在の要素。

承認

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

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

setPageHeight(pageHeight)

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

パラメータ

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

戻る

Body - 現在の要素。

承認

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

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

setPageWidth(pageWidth)

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

パラメータ

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

戻る

Body - 現在の要素。

承認

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

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

setText(text)

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

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

パラメータ

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

戻る

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

パラメータ

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

戻る

Body - 現在の要素

承認

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

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

サポート終了のメソッド