Interface Element

汎用要素。Document の内容は要素として表されます。たとえば、ListItem、Paragraph、Table は要素であり、getType() など、Element で定義されたすべてのメソッドを継承します。

実装クラス

名前	概要
`Body`	Google ドキュメントのタブの内容。
`ContainerElement`	他の要素を含むことができる汎用要素。
`Date`	書式設定された日付を表す要素
`Equation`	数式を表す要素。
`EquationFunction`	数学の `Equation` の関数を表す要素。
`EquationFunctionArgumentSeparator`	数学の `Equation` の関数区切り文字を表す要素。
`EquationSymbol`	数学の `Equation` の記号を表す要素。
`FooterSection`	フッターセクションを表す要素。
`Footnote`	脚注を表す要素。
`FootnoteSection`	脚注セクションを表す要素。
`HeaderSection`	ヘッダーセクションを表す要素。
`HorizontalRule`	水平ルールを表す要素。
`InlineDrawing`	埋め込み図形描画を表す要素。
`InlineImage`	埋め込み画像を表す要素。
`ListItem`	リスト項目を表す要素。
`PageBreak`	改ページを表す要素。
`Paragraph`	段落を表す要素。
`Person`	人物へのリンクを表す要素。
`RichLink`	Google リソース（ドライブファイルや YouTube 動画など）へのリンクを表す要素。
`Table`	テーブルを表す要素。
`TableCell`	テーブルセルを表す要素。
`TableOfContents`	目次を含む要素。
`TableRow`	テーブル行を表す要素。
`Text`	リッチテキスト領域を表す要素。
`UnsupportedElement`	ページ番号など、不明な領域やスクリプトの影響を受けない領域を表す要素。

メソッド

メソッド	戻り値の型	概要
`asBody()`	`Body`	現在の要素を `Body` として返します。
`asDate()`	`Date`	現在の要素を `Date` として返します。
`asEquation()`	`Equation`	現在の要素を `Equation` として返します。
`asEquationFunction()`	`EquationFunction`	現在の要素を `EquationFunction` として返します。
`asEquationFunctionArgumentSeparator()`	`EquationFunctionArgumentSeparator`	現在の要素を `EquationFunctionArgumentSeparator` として返します。
`asEquationSymbol()`	`EquationSymbol`	現在の要素を `EquationSymbol` として返します。
`asFooterSection()`	`FooterSection`	現在の要素を `FooterSection` として返します。
`asFootnote()`	`Footnote`	現在の要素を `Footnote` として返します。
`asFootnoteSection()`	`FootnoteSection`	現在の要素を `FootnoteSection` として返します。
`asHeaderSection()`	`HeaderSection`	現在の要素を `HeaderSection` として返します。
`asHorizontalRule()`	`HorizontalRule`	現在の要素を `HorizontalRule` として返します。
`asInlineDrawing()`	`InlineDrawing`	現在の要素を `InlineDrawing` として返します。
`asInlineImage()`	`InlineImage`	現在の要素を `InlineImage` として返します。
`asListItem()`	`ListItem`	現在の要素を `ListItem` として返します。
`asPageBreak()`	`PageBreak`	現在の要素を `PageBreak` として返します。
`asParagraph()`	`Paragraph`	現在の要素を `Paragraph` として返します。
`asPerson()`	`Person`	現在の要素を `Person` として返します。
`asRichLink()`	`RichLink`	現在の要素（Google スプレッドシートファイルへのリンクなど）を `RichLink` として返します。
`asTable()`	`Table`	現在の要素を `Table` として返します。
`asTableCell()`	`TableCell`	現在の要素を `TableCell` として返します。
`asTableOfContents()`	`TableOfContents`	現在の要素を `TableOfContents` として返します。
`asTableRow()`	`TableRow`	現在の要素を `TableRow` として返します。
`asText()`	`Text`	現在の要素を `Text` として返します。
`copy()`	`Element`	現在の要素の切り離されたディープコピーを返します。
`getAttributes()`	`Object`	要素の属性を取得します。
`getNextSibling()`	`Element\|null`	要素の次の兄弟要素を取得します。
`getParent()`	`ContainerElement\|null`	要素の親要素を取得します。
`getPreviousSibling()`	`Element\|null`	要素の前の兄弟要素を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の末尾にあるかどうかを判断します。
`merge()`	`Element\|null`	要素を同じタイプの前の兄弟要素とマージします。
`removeFromParent()`	`Element\|null`	要素を親から削除します。
`setAttributes(attributes)`	`Element`	要素の属性を設定します。

詳細なドキュメント

`asBody()`

現在の要素を Body として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Body - 現在の要素。

承認

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

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

`asDate()`

現在の要素を Date として返します。

要素が Date であることがわかっている場合は、このメソッドを使用してその型を Date として設定します。これにより、Apps Script エディタのオートコンプリートで、Date で使用できるメソッドが表示されます。

戻る

Date - タイプが Date に設定された現在の要素。

承認

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

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

`asEquation()`

現在の要素を Equation として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Equation - 現在の要素。

承認

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

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

`asEquationFunction()`

現在の要素を EquationFunction として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

EquationFunction - 現在の要素。

承認

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

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

`asEquationFunctionArgumentSeparator()`

現在の要素を EquationFunctionArgumentSeparator として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

EquationFunctionArgumentSeparator - 現在の要素。

承認

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

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

`asEquationSymbol()`

現在の要素を EquationSymbol として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

EquationSymbol - 現在の要素。

承認

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

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

`asFooterSection()`

現在の要素を FooterSection として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

FooterSection - 現在の要素。

承認

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

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

`asFootnote()`

現在の要素を Footnote として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Footnote - 現在の要素。

承認

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

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

`asFootnoteSection()`

現在の要素を FootnoteSection として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

FootnoteSection - 現在の要素。

承認

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

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

`asHeaderSection()`

現在の要素を HeaderSection として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

HeaderSection - 現在の要素。

承認

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

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

`asHorizontalRule()`

現在の要素を HorizontalRule として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

HorizontalRule - 現在の要素。

承認

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

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

`asInlineDrawing()`

現在の要素を InlineDrawing として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

InlineDrawing - 現在の要素。

承認

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

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

`asInlineImage()`

現在の要素を InlineImage として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

InlineImage - 現在の要素。

承認

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

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

`asListItem()`

現在の要素を ListItem として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

ListItem - 現在の要素。

承認

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

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

`asPageBreak()`

現在の要素を PageBreak として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

PageBreak - 現在の要素。

承認

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

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

`asParagraph()`

現在の要素を Paragraph として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Paragraph - 現在の要素。

承認

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

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

`asPerson()`

現在の要素を Person として返します。

要素が Person であることがわかっている場合は、このメソッドを使用してそのタイプを人物として設定します。これにより、Apps Script エディタの予測入力で、人物要素で使用できるメソッドが表示されます。

戻る

Person - タイプが Person に設定された現在の要素。

承認

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

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

`asRichLink()`

現在の要素を RichLink として返します（Google スプレッドシートファイルへのリンクなど）。

要素が RichLink であることがわかっている場合は、このメソッドを使用してその型を RichLink として設定します。これにより、Apps Script エディタの予測入力で、RichLink で使用できるメソッドが表示されます。

戻る

RichLink - タイプが RichLink に設定された現在の要素。

承認

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

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

`asTable()`

現在の要素を Table として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Table - 現在の要素。

承認

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

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

`asTableCell()`

現在の要素を TableCell として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

TableCell - 現在の要素。

承認

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

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

`asTableOfContents()`

現在の要素を TableOfContents として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

TableOfContents - 現在の要素。

承認

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

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

`asTableRow()`

現在の要素を TableRow として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

TableRow - 現在の要素。

承認

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

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

`asText()`

現在の要素を Text として返します。

このメソッドは、特定の型の要素であることがわかっている場合に、オートコンプリートを補助するために使用します。

戻る

Text - 現在の要素。

承認

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

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

`copy()`

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

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

戻る

Element - 新しいコピー。

承認

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

`getNextSibling()`

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

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

戻る

Element|null - 次の兄弟要素。

承認

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

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

`getParent()`

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

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

戻る

ContainerElement|null - 親要素。

承認

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

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

`getPreviousSibling()`

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

前の兄弟は同じ親を持ち、現在の要素の前にあります。

戻る

Element|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

`isAtDocumentEnd()`

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

戻る

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

戻る

Element|null - マージされた要素。

承認

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

戻る

Element|null - 削除された要素。

承認

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

戻る

Element - 現在の要素。

承認

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

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

Interface Element コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

実装クラス

メソッド

詳細なドキュメント

asBody()

戻る

承認

asDate()

戻る

承認

asEquation()

戻る

承認

asEquationFunction()

戻る

承認

asEquationFunctionArgumentSeparator()

戻る

承認

asEquationSymbol()

戻る

承認

asFooterSection()

戻る

承認

asFootnote()

戻る

承認

asFootnoteSection()

戻る

承認

asHeaderSection()

戻る

承認

asHorizontalRule()

戻る

承認

asInlineDrawing()

戻る

承認

asInlineImage()

戻る

承認

asListItem()

戻る

承認

asPageBreak()

戻る

承認

asParagraph()

戻る

承認

asPerson()

戻る

承認

asRichLink()

戻る

承認

asTable()

戻る

承認

asTableCell()

戻る

承認

asTableOfContents()

戻る

承認

asTableRow()

戻る

承認

asText()

戻る

承認

copy()

戻る

承認

getAttributes()

戻る

承認

getNextSibling()

Interface Element

`asBody()`

`asDate()`

`asEquation()`

`asEquationFunction()`

`asEquationFunctionArgumentSeparator()`

`asEquationSymbol()`

`asFooterSection()`

`asFootnote()`

`asFootnoteSection()`

`asHeaderSection()`

`asHorizontalRule()`

`asInlineDrawing()`

`asInlineImage()`

`asListItem()`

`asPageBreak()`

`asParagraph()`

`asPerson()`

`asRichLink()`

`asTable()`

`asTableCell()`

`asTableOfContents()`

`asTableRow()`

`asText()`

`copy()`

`getAttributes()`

`getNextSibling()`

`getParent()`

`getPreviousSibling()`

`getType()`

`isAtDocumentEnd()`

`merge()`

`removeFromParent()`

`setAttributes(attributes)`