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

Class Paragraph

段落を表す要素。Paragraph には、Equation、Footnote、HorizontalRule、InlineDrawing、InlineImage、PageBreak、Text 要素を含めることができます。ドキュメント構造の詳細については、Google ドキュメントの拡張に関するガイドをご覧ください。

Paragraphs に改行文字を含めることはできません。改行文字（\n）は、改行文字（\r）に変換されます。

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

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
const section = body.appendParagraph('Section 1');
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph('This is a typical paragraph.');

メソッド

メソッド	戻り値の型	概要
`addPositionedImage(image)`	`PositionedImage`	指定されたイメージ blob から新しい `PositionedImage` を作成して挿入します。
`appendHorizontalRule()`	`HorizontalRule`	新しい `HorizontalRule` を作成して追加します。
`appendInlineImage(image)`	`InlineImage`	指定されたイメージブロブから新しい `InlineImage` を作成して追加します。
`appendInlineImage(image)`	`InlineImage`	指定された `InlineImage` を追加します。
`appendPageBreak()`	`PageBreak`	新しい `PageBreak` を作成して追加します。
`appendPageBreak(pageBreak)`	`PageBreak`	指定された `PageBreak` を追加します。
`appendText(text)`	`Text`	指定された内容を持つ新しい `Text` 要素を作成して追加します。
`appendText(text)`	`Text`	指定された `Text` 要素を追加します。
`clear()`	`Paragraph`	要素の内容を消去します。
`copy()`	`Paragraph`	現在の要素の切断されたディープコピーを返します。
`editAsText()`	`Text`	編集用に現在の要素の `Text` バージョンを取得します。
`findElement(elementType)`	`RangeElement`	要素の内容で、指定したタイプの子孫を検索します。
`findElement(elementType, from)`	`RangeElement`	指定された `RangeElement` から、指定されたタイプの子孫を要素の内容で検索します。
`findText(searchPattern)`	`RangeElement`	正規表現を使用して、要素のコンテンツで指定されたテキストパターンを検索します。
`findText(searchPattern, from)`	`RangeElement`	指定された検索結果から、要素のコンテンツで指定されたテキストパターンを検索します。
`getAlignment()`	`HorizontalAlignment`	`HorizontalAlignment` を取得します。
`getAttributes()`	`Object`	要素の属性を取得します。
`getChild(childIndex)`	`Element`	指定された子インデックスの子要素を取得します。
`getChildIndex(child)`	`Integer`	指定された子要素の子インデックスを取得します。
`getHeading()`	`ParagraphHeading`	`ParagraphHeading` を取得します。
`getIndentEnd()`	`Number`	末尾のインデントをポイント単位で取得します。
`getIndentFirstLine()`	`Number`	1 行目のインデントをポイント単位で取得します。
`getIndentStart()`	`Number`	開始インデントを取得します。
`getLineSpacing()`	`Number`	行間のスペースをポイント単位で取得します。
`getLinkUrl()`	`String`	リンクの URL を取得します。
`getNextSibling()`	`Element`	要素の次の兄弟要素を取得します。
`getNumChildren()`	`Integer`	子の数を取得します。
`getParent()`	`ContainerElement`	要素の親要素を取得します。
`getPositionedImage(id)`	`PositionedImage`	画像の ID で `PositionedImage` を取得します。
`getPositionedImages()`	`PositionedImage[]`	段落にアンカーされているすべての `PositionedImage` オブジェクトを取得します。
`getPreviousSibling()`	`Element`	要素の前の兄弟要素を取得します。
`getSpacingAfter()`	`Number`	要素の後のスペースをポイント単位で取得します。
`getSpacingBefore()`	`Number`	要素の前のスペースをポイント単位で取得します。
`getText()`	`String`	要素のコンテンツをテキスト文字列として取得します。
`getTextAlignment()`	`TextAlignment`	テキストの配置を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	指定されたインデックスに `HorizontalRule` を作成して挿入します。
`insertInlineImage(childIndex, image)`	`InlineImage`	指定されたイメージ blob から新しい `InlineImage` を作成して、指定されたインデックスに挿入します。
`insertInlineImage(childIndex, image)`	`InlineImage`	指定された `InlineImage` を指定されたインデックスに挿入します。
`insertPageBreak(childIndex)`	`PageBreak`	指定したインデックスに新しい `PageBreak` を作成して挿入します。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	指定された `PageBreak` を指定されたインデックスに挿入します。
`insertText(childIndex, text)`	`Text`	指定されたインデックスに新しいテキスト要素を作成して挿入します。
`insertText(childIndex, text)`	`Text`	指定された `Text` 要素を、指定されたインデックスに指定されたテキストコンテンツとともに挿入します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の末尾にあるかどうかを判断します。
`isLeftToRight()`	`Boolean`	左から右の設定を取得します。
`merge()`	`Paragraph`	要素を、同じタイプの前の兄弟要素と統合します。
`removeChild(child)`	`Paragraph`	指定された子要素を削除します。
`removeFromParent()`	`Paragraph`	要素を親から削除します。
`removePositionedImage(id)`	`Boolean`	画像の ID で `PositionedImage` を削除します。
`replaceText(searchPattern, replacement)`	`Element`	正規表現を使用して、指定したテキストパターンのすべての出現を指定された置換文字列に置き換えます。
`setAlignment(alignment)`	`Paragraph`	`HorizontalAlignment` を設定します。
`setAttributes(attributes)`	`Paragraph`	要素の属性を設定します。
`setHeading(heading)`	`Paragraph`	`ParagraphHeading` を設定します。
`setIndentEnd(indentEnd)`	`Paragraph`	末尾のインデントをポイント単位で設定します。
`setIndentFirstLine(indentFirstLine)`	`Paragraph`	最初の行のインデントをポイント単位で設定します。
`setIndentStart(indentStart)`	`Paragraph`	開始インデントをポイント単位で設定します。
`setLeftToRight(leftToRight)`	`Paragraph`	左から右の設定を設定します。
`setLineSpacing(multiplier)`	`Paragraph`	行間隔を設定します。行間に使用する行数を示す量として設定します。
`setLinkUrl(url)`	`Paragraph`	リンク URL を設定します。
`setSpacingAfter(spacingAfter)`	`Paragraph`	要素の後のスペースをポイント単位で設定します。
`setSpacingBefore(spacingBefore)`	`Paragraph`	要素の前のスペースをポイント単位で設定します。
`setText(text)`	`void`	段落の内容をテキストとして設定します。
`setTextAlignment(textAlignment)`	`Paragraph`	テキストの配置を設定します。

詳細なドキュメント

`addPositionedImage(image)`

指定されたイメージ blob から新しい PositionedImage を作成して挿入します。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png',
);

// Adds the image to the tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

パラメータ

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

戻る

PositionedImage - 新しい位置に配置された画像。

承認

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

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

`appendHorizontalRule()`

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

戻る

HorizontalRule - 新しい横線。

承認

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

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

`appendInlineImage(image)`

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png',
);

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

パラメータ

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

戻る

InlineImage - 追加された画像。

承認

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

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

`appendInlineImage(image)`

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

パラメータ

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

戻る

InlineImage - 追加された画像。

承認

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

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

`appendPageBreak()`

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

注: PageBreaks は TableCells 内に含めることはできません。現在の要素が表セルに含まれている場合、例外がスローされます。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

戻る

PageBreak - 新しい改ページ要素。

承認

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

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

`appendPageBreak(pageBreak)`

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

注: PageBreaks は TableCells 内に含めることはできません。現在の要素がテーブルセルにある場合、スクリプトは例外をスローします。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

パラメータ

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

戻る

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

承認

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

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

`appendText(text)`

指定された内容を含む新しい Text 要素を作成して追加します。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

パラメータ

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

戻る

Text - 新しいテキスト要素。

承認

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

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

`appendText(text)`

指定された Text 要素を追加します。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

パラメータ

名前	型	説明
`text`	`Text`	追加するテキスト要素。

戻る

Text - 追加されたテキスト要素。

承認

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

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

`clear()`

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

戻る

Paragraph - 現在の要素。

`copy()`

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

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

戻る

Paragraph - 新しいコピー。

承認

このメソッドを使用するスクリプトには、次のスコープの 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

`getAlignment()`

HorizontalAlignment を取得します。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the
// console.
console.log(paragraph.getAlignment().toString());

戻る

HorizontalAlignment - 配置。

承認

このメソッドを使用するスクリプトには、次のスコープの 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

`getHeading()`

ParagraphHeading を取得します。

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

戻る

ParagraphHeading - 見出し。

承認

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

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

`getIndentEnd()`

末尾のインデントをポイント単位で取得します。

戻る

Number - 終了インデント（ポイント単位）

承認

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

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

`getIndentFirstLine()`

1 行目のインデントをポイント単位で取得します。

戻る

Number - 先頭行のインデント（ポイント単位）

承認

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

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

`getIndentStart()`

開始インデントを取得します。

戻る

Number - 開始インデント

承認

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

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

`getLineSpacing()`

行間のスペースをポイント単位で取得します。

戻る

Number - 行間隔（ポイント単位）

承認

このメソッドを使用するスクリプトには、次のスコープの 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

`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

`getParent()`

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

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

戻る

ContainerElement - 親要素。

承認

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

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

`getPositionedImage(id)`

画像の ID で PositionedImage を取得します。

パラメータ

名前	型	説明
`id`	`String`	画像 ID

戻る

PositionedImage - 配置された画像

承認

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

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

`getPositionedImages()`

段落にアンカーされているすべての PositionedImage オブジェクトを取得します。

戻る

PositionedImage[] - 配置された画像のリスト

承認

このメソッドを使用するスクリプトには、次のスコープの 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

`getSpacingAfter()`

要素の後のスペースをポイント単位で取得します。

戻る

Number - 要素の後のスペース（ポイント単位）

承認

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

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

`getSpacingBefore()`

要素の前のスペースをポイント単位で取得します。

戻る

Number - 要素の前のスペース（ポイント単位）

承認

このメソッドを使用するスクリプトには、次のスコープの 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 を作成して挿入します。

パラメータ

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

戻る

HorizontalRule - 新しい横線要素

承認

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

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

`insertInlineImage(childIndex, image)`

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

パラメータ

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

戻る

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

承認

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

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

`insertInlineImage(childIndex, image)`

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

パラメータ

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

戻る

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

承認

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

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

`insertPageBreak(childIndex)`

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

注: PageBreaks は TableCells 内に含めることはできません。現在の要素が表セルに含まれている場合、例外がスローされます。

パラメータ

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

戻る

PageBreak - 新しい改ページ要素

承認

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

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

`insertPageBreak(childIndex, pageBreak)`

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

注: PageBreaks は TableCells 内に含めることはできません。現在の要素が表セルに含まれている場合、例外がスローされます。

パラメータ

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

戻る

PageBreak - 挿入された改ページ要素

承認

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

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

`insertText(childIndex, text)`

指定されたインデックスに新しいテキスト要素を作成して挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス
`text`	`String`	テキストコンテンツ

戻る

Text - 新しいテキスト要素

承認

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

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

`insertText(childIndex, text)`

指定された Text 要素を、指定されたインデックスに指定されたテキストコンテンツとともに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス
`text`	`Text`	挿入するテキスト要素

戻る

Text - 挿入されたテキスト要素

承認

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

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

`isAtDocumentEnd()`

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

戻る

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

承認

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

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

`isLeftToRight()`

左から右の設定を取得します。

戻る

Boolean - 左から右の設定

承認

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

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

`merge()`

要素を、同じタイプの前の兄弟要素と統合します。

マージできるのは、同じ ElementType の要素のみです。現在の要素に含まれる子要素は、前の兄弟要素に移動されます。

現在の要素がドキュメントから削除されます。

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

戻る

Paragraph - 統合された要素。

承認

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

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

`removeChild(child)`

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

パラメータ

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

戻る

Paragraph - 現在の要素

承認

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

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

`removeFromParent()`

要素を親から削除します。

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

戻る

Paragraph - 削除された要素。

承認

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

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

`removePositionedImage(id)`

画像の ID で PositionedImage を削除します。

パラメータ

名前	型	説明
`id`	`String`	画像 ID

戻る

Boolean - 指定した画像が削除されたかどうか

承認

このメソッドを使用するスクリプトには、次のスコープの 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

`setAlignment(alignment)`

HorizontalAlignment を設定します。

パラメータ

名前	型	説明
`alignment`	`HorizontalAlignment`	水平方向の配置

戻る

Paragraph - 現在の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 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`	要素の属性。

戻る

Paragraph - 現在の要素。

承認

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

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

`setHeading(heading)`

ParagraphHeading を設定します。

パラメータ

名前	型	説明
`heading`	`ParagraphHeading`	見出し

戻る

Paragraph - 現在の要素

承認

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

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

`setIndentEnd(indentEnd)`

末尾のインデントをポイント単位で設定します。

パラメータ

名前	型	説明
`indentEnd`	`Number`	末尾のインデント（ポイント単位）

戻る

Paragraph - 現在の要素

承認

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

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

`setIndentFirstLine(indentFirstLine)`

最初の行のインデントをポイント単位で設定します。

パラメータ

名前	型	説明
`indentFirstLine`	`Number`	先頭行のインデント（ポイント単位）

戻る

Paragraph - 現在の要素

承認

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

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

`setIndentStart(indentStart)`

開始インデントをポイント単位で設定します。

パラメータ

名前	型	説明
`indentStart`	`Number`	開始インデント（ポイント単位）

戻る

Paragraph - 現在の要素

承認

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

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

`setLeftToRight(leftToRight)`

左から右の設定を設定します。

パラメータ

名前	型	説明
`leftToRight`	`Boolean`	左から右の設定

戻る

Paragraph - 現在の要素

承認

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

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

`setLineSpacing(multiplier)`

行間隔を設定します。行間に使用する行数を示す量として設定します。

パラメータ

名前	型	説明
`multiplier`	`Number`	行数

戻る

Paragraph - 現在の要素

承認

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

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

`setLinkUrl(url)`

リンク URL を設定します。

パラメータ

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

戻る

Paragraph - 現在の要素

承認

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

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

`setSpacingAfter(spacingAfter)`

要素の後のスペースをポイント単位で設定します。

パラメータ

名前	型	説明
`spacingAfter`	`Number`	要素の後のスペース（ポイント単位）

戻る

Paragraph - 現在の要素

承認

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

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

`setSpacingBefore(spacingBefore)`

要素の前のスペースをポイント単位で設定します。

パラメータ

名前	型	説明
`spacingBefore`	`Number`	要素の前のスペース（ポイント単位）

戻る

Paragraph - 現在の要素

承認

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

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

`setText(text)`

段落の内容をテキストとして設定します。

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

パラメータ

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

承認

このメソッドを使用するスクリプトには、次のスコープの 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`	適用するテキストの配置の種類

戻る

Paragraph - 現在の要素

承認

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

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