Class ListItem

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

リストアイテムを表す要素。ListItem は、リスト ID に関連付けられた Paragraph です。ListItem には、EquationFootnoteHorizontalRuleInlineDrawingInlineImagePageBreakText 要素を含めることができます。ドキュメント構造の詳細については、Google ドキュメントの拡張ガイドをご覧ください。

ListItems に改行文字を含めることはできません。改行文字("\n")は改行文字("\}}"><")に変換されます。

同じリスト ID を持つ ListItems は同じリストに属し、それに応じて番号が付けられます。リストの ListItems は、ドキュメント内で隣接していたり、親要素が同じである必要はありません。次の例に示すように、同じリストに属する 2 つのアイテムは、連続する番号付けを維持しながら、ドキュメントの任意の場所に存在する可能性があります。

var body = DocumentApp.getActiveDocument().getBody();

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Methods

方法戻り値の型概要
addPositionedImage(image)PositionedImage指定された画像 blob から新しい PositionedImage を作成して挿入します。
appendHorizontalRule()HorizontalRule新しい HorizontalRule を作成して追加します。
appendInlineImage(image)InlineImage指定された画像 blob から新しい InlineImage を作成して追加します。
appendInlineImage(image)InlineImage指定された InlineImage を追加します。
appendPageBreak()PageBreak新しい PageBreak を作成して追加します。
appendPageBreak(pageBreak)PageBreak指定された PageBreak を追加します。
appendText(text)Text指定された内容で新しい Text 要素を作成して追加します。
appendText(text)Text指定された Text 要素を追加します。
clear()ListItem要素のコンテンツをクリアします。
copy()ListItem現在の要素から分離されたディープコピーを返します。
editAsText()Text編集用に現在の要素の Text バージョンを取得します。
findElement(elementType)RangeElement要素のコンテンツを指定して、指定された型の子孫を検索します。
findElement(elementType, from)RangeElement要素の内容を検索し、指定された RangeElement から始まる、指定されたタイプの子孫を検索します。
findText(searchPattern)RangeElement正規表現を使用して、要素の内容について、指定されたテキスト パターンを検索します。
findText(searchPattern, from)RangeElement特定のコンテンツ要素から、指定したテキスト パターンで要素のコンテンツを検索します。
getAlignment()HorizontalAlignmentHorizontalAlignment を取得します。
getAttributes()Object要素の属性を取得します。
getChild(childIndex)Element指定した子インデックスにある子要素を取得します。
getChildIndex(child)Integer指定した子要素の子インデックスを取得します。
getGlyphType()GlyphTypeリストアイテムの GlyphType を取得します。
getHeading()ParagraphHeadingParagraphHeading を取得します。
getIndentEnd()Number最後のインデントをポイント数で取得します。
getIndentFirstLine()Number最初の行のインデントをポイント数で取得します。
getIndentStart()Number開始インデントを取得します。
getLineSpacing()Number行間隔をポイント数で取得します。
getLinkUrl()Stringリンクの URL を取得します。
getListId()Stringリスト ID を取得します。
getNestingLevel()Integerリストアイテムのネストレベルを取得します。
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()ListItem同じタイプの先行する兄弟要素と要素を結合します。
removeChild(child)ListItem指定した子要素を削除します。
removeFromParent()ListItem親から要素を削除します。
removePositionedImage(id)Boolean画像の ID で PositionedImage を削除します。
replaceText(searchPattern, replacement)Element正規表現を使用して、特定のテキスト パターンをすべて特定の置換文字列に置き換えます。
setAlignment(alignment)ListItemHorizontalAlignment を設定します。
setAttributes(attributes)ListItem要素の属性を設定します。
setGlyphType(glyphType)ListItemリストアイテムの GlyphType を設定します。
setHeading(heading)ListItemParagraphHeading を設定します。
setIndentEnd(indentEnd)ListItem最後のインデントをポイント単位で設定します。
setIndentFirstLine(indentFirstLine)ListItem先頭行のインデントをポイントで設定します。
setIndentStart(indentStart)ListItem開始インデントをポイント単位で設定します。
setLeftToRight(leftToRight)ListItem左から右の設定を指定します。
setLineSpacing(multiplier)ListItem行間隔を、間隔に使用する行数を示す数量として設定します。
setLinkUrl(url)ListItemリンクの URL を設定します。
setListId(listItem)ListItemリスト ID を設定します。
setNestingLevel(nestingLevel)ListItemリストアイテムのネストレベルを設定します。
setSpacingAfter(spacingAfter)ListItem要素の後の間隔をポイントで設定します。
setSpacingBefore(spacingBefore)ListItem要素の前の間隔をポイントで設定します。
setText(text)voidリスト項目の内容をテキストとして設定します。
setTextAlignment(textAlignment)ListItemテキストの配置を設定します。

詳細なドキュメント

addPositionedImage(image)

指定された画像 blob から新しい PositionedImage を作成して挿入します。

パラメータ

名前説明
imageBlobSource画像データ

戻る

PositionedImage - 新しい配置画像。

認可

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

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

appendHorizontalRule()

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

戻る

HorizontalRule - 新しい水平ルール。

認可

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

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

appendInlineImage(image)

指定された画像 blob から新しい InlineImage を作成して追加します。

パラメータ

名前説明
imageBlobSource画像データ

戻る

InlineImage - 追加された画像

認可

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

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

appendInlineImage(image)

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

パラメータ

名前説明
imageInlineImage画像データ

戻る

InlineImage - 追加された画像

認可

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

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

appendPageBreak()

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

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

戻る

PageBreak - 新しい改ページ要素

認可

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

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

appendPageBreak(pageBreak)

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

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

パラメータ

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

戻る

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

認可

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

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

appendText(text)

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

パラメータ

名前説明
textStringテキスト コンテンツ

戻る

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

認可

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

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

appendText(text)

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

パラメータ

名前説明
textText追加するテキスト要素

戻る

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

認可

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

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

clear()

要素のコンテンツをクリアします。

戻る

ListItem - 現在の要素。


copy()

現在の要素から分離されたディープコピーを返します。

その要素内のすべての子要素もコピーされます。新しい要素には親がありません。

戻る

ListItem - 新しいコピー。

認可

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

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

editAsText()

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

editAsText を使用して、要素のコンテンツをリッチテキストとして操作します。editAsText モードでは、テキスト以外の要素(InlineImageHorizontalRule など)は無視されます。

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

var body = DocumentApp.getActiveDocument().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 から始まる、指定されたタイプの子孫を検索します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

パラメータ

名前説明
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

getAlignment()

HorizontalAlignment を取得します。

戻る

HorizontalAlignment - 配置

認可

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

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

getAttributes()

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

結果は、各プロパティ名が DocumentApp.Attribute 列挙型のアイテムに対応する、有効な要素属性のプロパティを含むオブジェクトになります。

var body = DocumentApp.getActiveDocument().getBody();

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

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

// Log the paragraph attributes.
for (var 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)

指定した子インデックスにある子要素を取得します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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

getGlyphType()

リストアイテムの GlyphType を取得します。

戻る

GlyphType - グリフタイプ

認可

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

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

getHeading()

ParagraphHeading を取得します。

戻る

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

最初の行のインデントをポイント数で取得します。

戻る

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

getListId()

リスト ID を取得します。

戻る

String - リスト ID

認可

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

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

getNestingLevel()

リストアイテムのネストレベルを取得します。

デフォルトでは、リスト項目のネストレベルは 0 です。ネストレベルによって、リストアイテムで使用されるグリフが決まります。

戻る

Integer - ネストレベル

認可

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

子の数を取得します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document 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 を取得します。

パラメータ

名前説明
idString画像 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.NORMALDocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT です。

戻る

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

認可

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

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

getType()

要素の ElementType を取得します。

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

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var 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 を作成して挿入します。

パラメータ

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

戻る

HorizontalRule - 新しい水平ルール要素。

認可

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

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

insertInlineImage(childIndex, image)

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

パラメータ

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

戻る

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

認可

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

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

insertInlineImage(childIndex, image)

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

パラメータ

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

戻る

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

認可

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

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

insertPageBreak(childIndex)

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

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

パラメータ

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

戻る

PageBreak - 新しい改ページ要素

認可

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

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

insertPageBreak(childIndex, pageBreak)

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

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

パラメータ

名前説明
childIndexInteger要素を挿入するインデックス
pageBreakPageBreak挿入するページ区切り

戻る

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

認可

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

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

insertText(childIndex, text)

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

パラメータ

名前説明
childIndexInteger要素を挿入するインデックス
textStringテキスト コンテンツ

戻る

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

認可

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

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

insertText(childIndex, text)

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

パラメータ

名前説明
childIndexInteger要素を挿入するインデックス
textText挿入するテキスト要素

戻る

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 の要素のみです。現在の要素に含まれている子要素は、前の兄弟要素に移動されます。

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

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

戻る

ListItem - マージされた要素。

認可

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

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

removeChild(child)

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

パラメータ

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

戻る

ListItem - 現在の要素。

認可

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

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

removeFromParent()

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

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

戻る

ListItem - 削除された要素。

認可

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

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

removePositionedImage(id)

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

パラメータ

名前説明
idString

戻る

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

認可

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

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

replaceText(searchPattern, replacement)

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

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

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

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

var body = DocumentApp.getActiveDocument().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

setAlignment(alignment)

HorizontalAlignment を設定します。

パラメータ

名前説明
alignmentHorizontalAlignment水平方向の配置

戻る

ListItem - 現在の要素。

認可

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

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

setAttributes(attributes)

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

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

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

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

パラメータ

名前説明
attributesObject要素の属性。

戻る

ListItem - 現在の要素。

認可

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

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

setGlyphType(glyphType)

リストアイテムの GlyphType を設定します。

パラメータ

名前説明
glyphTypeGlyphTypeグリフタイプ

戻る

ListItem - 現在の要素。

認可

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

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

setHeading(heading)

ParagraphHeading を設定します。

パラメータ

名前説明
headingParagraphHeading見出し

戻る

ListItem - 現在の要素。

認可

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

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

setIndentEnd(indentEnd)

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

パラメータ

名前説明
indentEndNumber最後のインデント(ポイント)

戻る

ListItem - 現在の要素。

認可

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

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

setIndentFirstLine(indentFirstLine)

先頭行のインデントをポイントで設定します。

パラメータ

名前説明
indentFirstLineNumber最初の行のインデント(ポイント)

戻る

ListItem - 現在の要素。

認可

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

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

setIndentStart(indentStart)

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

パラメータ

名前説明
indentStartNumber開始インデント(ポイント数)

戻る

ListItem - 現在の要素。

認可

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

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

setLeftToRight(leftToRight)

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

パラメータ

名前説明
leftToRightBoolean左から右の設定

戻る

ListItem - 現在の要素。

認可

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

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

setLineSpacing(multiplier)

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

パラメータ

名前説明
multiplierNumber行数

戻る

ListItem - 現在の要素。

認可

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

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

setLinkUrl(url)

リンクの URL を設定します。

パラメータ

名前説明
urlStringリンクの URL

戻る

ListItem - 現在の要素。

認可

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

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

setListId(listItem)

リスト ID を設定します。

リスト ID は、指定された ListItem と同じ値に設定されます。2 つの ListItems は、同じリストのメンバーとして扱われます。

パラメータ

名前説明
listItemListItem使用するリスト ID を含むリストアイテム

戻る

ListItem - 現在の要素。

認可

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

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

setNestingLevel(nestingLevel)

リストアイテムのネストレベルを設定します。

デフォルトでは、リスト項目のネストレベルは 0 です。ネストレベルによって、リストアイテムで使用されるグリフが決まります。

パラメータ

名前説明
nestingLevelIntegerネストレベル

戻る

ListItem - 現在の要素。

認可

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

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

setSpacingAfter(spacingAfter)

要素の後の間隔をポイントで設定します。

パラメータ

名前説明
spacingAfterNumber要素の後の間隔(ポイント数)

戻る

ListItem - 現在の要素。

認可

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

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

setSpacingBefore(spacingBefore)

要素の前の間隔をポイントで設定します。

パラメータ

名前説明
spacingBeforeNumber要素の前の間隔(ポイント単位)

戻る

ListItem - 現在の要素。

認可

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

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

setText(text)

リストアイテムのコンテンツをテキストとして設定します。

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

パラメータ

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

認可

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

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

setTextAlignment(textAlignment)

テキストの配置を設定します。使用可能なアライメントのタイプは、DocumentApp.TextAlignment.NORMALDocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT です。

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

パラメータ

名前説明
textAlignmentTextAlignment適用するテキストの配置タイプ

戻る

ListItem - 現在の要素。

認可

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

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