Class Document

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

リッチテキストと、表やリストなどの要素を含むドキュメント。

ドキュメントは DocumentApp を使用してオープンまたは作成できます。

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Methods

方法戻り値の型概要
addBookmark(position)Bookmark指定された PositionBookmark を追加します。
addEditor(emailAddress)Document指定されたユーザーを Document の編集者リストに追加します。
addEditor(user)Document指定されたユーザーを Document の編集者リストに追加します。
addEditors(emailAddresses)Document指定したユーザー配列を Document の編集者リストに追加します。
addFooter()FooterSectionドキュメント フッターのセクションを追加します(存在しない場合)。
addHeader()HeaderSectionドキュメント ヘッダー セクションを追加します(存在しない場合)。
addNamedRange(name, range)NamedRange新しい NamedRange を追加します。これは、後で取得できるように名前と ID を持つ Range です。
addViewer(emailAddress)Document指定されたユーザーを Document の閲覧者リストに追加します。
addViewer(user)Document指定されたユーザーを Document の閲覧者リストに追加します。
addViewers(emailAddresses)Document指定したユーザー配列を Document の閲覧者リストに追加します。
getAs(contentType)Blob現在の Document コンテンツを、指定された型の blob として取得します。
getBlob()Blob現在の Document コンテンツを blob として取得します。
getBody()Bodyアクティブなドキュメントの Body を取得します。
getBookmark(id)Bookmark指定された ID の Bookmark を取得します。
getBookmarks()Bookmark[]ドキュメント内のすべての Bookmark オブジェクトを取得します。
getCursor()Positionアクティブ ドキュメント内のユーザーのカーソルを取得します。
getEditors()User[]この Document の編集者のリストを取得します。
getFooter()FooterSectionドキュメントのフッター セクション(存在する場合)を取得します。
getFootnotes()Footnote[]ドキュメント本文内のすべての Footnote 要素を取得します。
getHeader()HeaderSectionドキュメントのヘッダー セクションを取得します(存在する場合)。
getId()Stringドキュメントの一意の識別子を取得します。
getLanguage()Stringドキュメントの言語コードを取得します。
getName()Stringドキュメントのタイトルを取得します。
getNamedRangeById(id)NamedRange指定された ID の NamedRange を取得します。
getNamedRanges()NamedRange[]ドキュメント内のすべての NamedRange オブジェクトを取得します。
getNamedRanges(name)NamedRange[]指定された名前のドキュメント内のすべての NamedRange オブジェクトを取得します。
getSelection()Rangeアクティブなドキュメント内のユーザーの選択を取得します。
getSupportedLanguageCodes()String[]Google ドキュメント ファイルでサポートされているすべての言語コードを取得します。
getUrl()String現在のドキュメントにアクセスするための URL を取得します。
getViewers()User[]この Document の閲覧者とコメント投稿者のリストを取得します。
newPosition(element, offset)Position新しい Position を作成します。これは、特定の要素を基準に、ドキュメント内の場所への参照です。
newRange()RangeBuilderドキュメント要素から Range オブジェクトを作成するために使用されるビルダーを作成します。
removeEditor(emailAddress)Document指定されたユーザーを Document の編集者のリストから削除します。
removeEditor(user)Document指定されたユーザーを Document の編集者のリストから削除します。
removeViewer(emailAddress)DocumentDocument の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)DocumentDocument の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
saveAndClose()void現在の Document を保存します。
setCursor(position)DocumentPosition が付与された場合に、アクティブなドキュメントでユーザーのカーソルを設定します。
setLanguage(languageCode)Documentドキュメントの言語コードを設定します。
setName(name)Documentドキュメントのタイトルを設定します。
setSelection(range)DocumentRange が付与された場合に、アクティブなドキュメントでユーザーの選択を設定します。

詳細なドキュメント

addBookmark(position)

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

パラメータ

名前説明
positionPosition新しいブックマークの位置

戻る

Bookmark - 新しいブックマーク

認可

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

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

addEditor(emailAddress)

指定されたユーザーを Document の編集者リストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから昇格させます。

パラメータ

名前説明
emailAddressString追加するユーザーのメールアドレス。

戻る

Document - この Document。チェーン用です。

認可

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

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

addEditor(user)

指定されたユーザーを Document の編集者リストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから昇格させます。

パラメータ

名前説明
userUser追加するユーザーの表現。

戻る

Document - この Document。チェーン用です。

認可

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

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

addEditors(emailAddresses)

指定したユーザー配列を Document の編集者リストに追加します。いずれかのユーザーがすでに閲覧者のリストに含まれていた場合、この方法によって閲覧者のリストから昇格されます。

パラメータ

名前説明
emailAddressesString[]追加するユーザーのメールアドレスの配列。

戻る

Document - この Document。チェーン用です。

認可

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

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

addFooter()

ドキュメント フッターのセクションを追加します(存在しない場合)。

戻る

FooterSection - ドキュメントのフッター

認可

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

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

addHeader()

ドキュメント ヘッダー セクションを追加します(存在しない場合)。

戻る

HeaderSection - ドキュメント ヘッダー

認可

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

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

addNamedRange(name, range)

新しい NamedRange を追加します。これは、後で取得できるように名前と ID を持つ Range です。名前は必ずしも一意ではありません。HTML のクラスと同様に、同じドキュメント内の複数の範囲で同じ名前を共有できます。一方、ID は HTML の ID のようにドキュメント内で一意です。NamedRange をドキュメントに追加すると、変更はできないため、削除のみが可能です。

NamedRange には、ドキュメントにアクセスするすべてのスクリプトからアクセスできます。スクリプト間で予期しない競合が発生しないように、範囲名に一意の文字列を接頭辞として付けることを検討してください。

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

パラメータ

名前説明
nameString範囲の名前です。一意である必要はありません。範囲名は 1 文字以上 256 文字以下にする必要があります。
rangeRange名前に関連付ける要素の範囲。範囲は、有効な選択検索結果、または newRange() を使用して手動で構築できます

戻る

NamedRange - 新しい NamedRange

認可

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

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

addViewer(emailAddress)

指定されたユーザーを Document の閲覧者リストに追加します。ユーザーがすでに編集者のリストに含まれていた場合、このメソッドは何の効果もありません。

パラメータ

名前説明
emailAddressString追加するユーザーのメールアドレス。

戻る

Document - この Document。チェーン用です。

認可

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

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

addViewer(user)

指定されたユーザーを Document の閲覧者リストに追加します。ユーザーがすでに編集者のリストに含まれていた場合、このメソッドは何の効果もありません。

パラメータ

名前説明
userUser追加するユーザーの表現。

戻る

Document - この Document。チェーン用です。

認可

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

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

addViewers(emailAddresses)

指定したユーザー配列を Document の閲覧者リストに追加します。すでに編集者のリストにすでに登録されているユーザーがいる場合、このメソッドはその編集者に影響しません。

パラメータ

名前説明
emailAddressesString[]追加するユーザーのメールアドレスの配列。

戻る

Document - この Document。チェーン用です。

認可

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

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

getAs(contentType)

現在の Document コンテンツを、指定された型の blob として取得します。

パラメータ

名前説明
contentTypeString変換する MIME タイプ。現時点では 'application/pdf' のみがサポートされています

戻る

Blob - blob としての現在のドキュメント


getBlob()

現在の Document コンテンツを blob として取得します。

戻る

Blob - blob としての現在のドキュメント


getBody()

アクティブなドキュメントの Body を取得します。

ドキュメントにはさまざまなタイプのセクション(例: HeaderSectionFooterSection)が含まれる可能性があります。ドキュメントのアクティブなセクションは Body です。

Document の要素メソッドは、アクティブな Body にデリゲートします。

戻る

Body - アクティブなドキュメントの本文セクション

認可

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

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

getBookmark(id)

指定された ID の Bookmark を取得します。Bookmark が存在しない場合、このメソッドは null を返します。

パラメータ

名前説明
idStringBookmark の ID

戻る

Bookmark - 指定された ID の Bookmark、またはそのような Bookmark が存在しない場合は null

認可

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

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

getBookmarks()

ドキュメント内のすべての Bookmark オブジェクトを取得します。

戻る

Bookmark[] - ドキュメント内の Bookmark オブジェクトの配列。

認可

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

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

getCursor()

アクティブ ドキュメント内のユーザーのカーソルを取得します。スクリプトがユーザーのドキュメントにバインドされている場合にのみ、スクリプトはそのユーザーのカーソルにアクセスできます。

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

戻る

Position - ユーザーのカーソルの表現。または、ユーザーがドキュメントにカーソルを置いていない場合、またはスクリプトがドキュメントにバインドされていない場合は null

認可

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

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

getEditors()

この Document の編集者のリストを取得します。

戻る

User[] - 編集権限を持つユーザーの配列。

認可

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

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

getFooter()

ドキュメントのフッター セクション(存在する場合)を取得します。

戻る

FooterSection - ドキュメントのフッター

認可

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

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

getFootnotes()

ドキュメント本文内のすべての Footnote 要素を取得します。

getFootnotes を呼び出すと、ドキュメントの要素が反復処理されます。サイズの大きいドキュメントの場合、このメソッドを不必要に呼び出さないようにしてください。

戻る

Footnote[] - ドキュメントの脚注

認可

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

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

getHeader()

ドキュメントのヘッダー セクションを取得します(存在する場合)。

戻る

HeaderSection - ドキュメント ヘッダー

認可

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

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

getId()

ドキュメントの一意の識別子を取得します。ドキュメント ID は、DocumentApp.openById() と一緒に特定のドキュメント インスタンスを開くために使用されます。

戻る

String - ドキュメントの ID。

認可

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

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

getLanguage()

ドキュメントの言語コードを取得します。これは、ドキュメント エディタのファイル言語に表示される言語です。ドキュメントに含まれる実際の言語とは限りません。

戻る

String - ドキュメントの言語。定義されていない場合は null

認可

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

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

getName()

ドキュメントのタイトルを取得します。

戻る

String - ドキュメントのタイトル

認可

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

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

getNamedRangeById(id)

指定された ID の NamedRange を取得します。NamedRange が存在しない場合、このメソッドは null を返します。名前は必ずしも一意ではありません。HTML のクラスと同様に、同じドキュメント内の複数の範囲で同じ名前を共有できます。一方、ID は HTML の ID のようにドキュメント内で一意です。

パラメータ

名前説明
idString範囲の ID(ドキュメント内で一意の ID)

戻る

NamedRange - 指定された ID の NamedRange、またはそのような範囲が存在しない場合は null

認可

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

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

getNamedRanges()

ドキュメント内のすべての NamedRange オブジェクトを取得します。

NamedRange には、ドキュメントにアクセスするすべてのスクリプトからアクセスできます。スクリプト間で予期しない競合が発生しないように、範囲名に一意の文字列を接頭辞として付けることを検討してください。

戻る

NamedRange[] - ドキュメント内の NamedRange オブジェクトの配列。同じ名前の複数の範囲が含まれる場合もあります。

認可

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

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

getNamedRanges(name)

指定された名前のドキュメント内のすべての NamedRange オブジェクトを取得します。名前は必ずしも一意ではありません。HTML のクラスと同様に、同じドキュメント内の複数の範囲で同じ名前を共有できます。一方、ID は HTML 内の ID のようにドキュメント内で一意です。

NamedRange には、ドキュメントにアクセスするすべてのスクリプトからアクセスできます。スクリプト間で予期しない競合が発生しないように、範囲名に一意の文字列を接頭辞として付けることを検討してください。

パラメータ

名前説明
nameString範囲の名前(必ずしも一意ではない)

戻る

NamedRange[] - 指定された名前のドキュメント内の NamedRange オブジェクトの配列

認可

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

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

getSelection()

アクティブなドキュメント内のユーザーの選択を取得します。スクリプトがアクセスできるのは、スクリプトを実行しているユーザーのみです。また、スクリプトがドキュメントにバインドされている場合に限ります。

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

戻る

Range - ユーザーの選択の表示。null で、ユーザーがドキュメントで何も選択されていない場合、段落の終わりのみが選択されている場合、段落と行のみが選択されている場合、またはスクリプトがドキュメントにバインドされていません。

認可

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

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

getSupportedLanguageCodes()

Google ドキュメント ファイルでサポートされているすべての言語コードを取得します。

戻る

String[] - 言語コードの配列。

認可

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

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

getUrl()

現在のドキュメントにアクセスするための URL を取得します。

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

戻る

String - 現在のドキュメントにアクセスする URL

認可

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

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

getViewers()

この Document の閲覧者とコメント投稿者のリストを取得します。

戻る

User[] - 表示またはコメントの権限を持つユーザーの配列。

認可

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

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

newPosition(element, offset)

新しい Position を作成します。これは、特定の要素を基準に、ドキュメント内の場所への参照です。ユーザーのカーソルは、特に Position として表されます。

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

パラメータ

名前説明
elementElement新しい Position を格納する要素。Text 要素または Paragraph などのコンテナ要素のいずれかにする必要があります。
offsetIntegerText 要素の場合は、Position の前の文字数。他の要素の場合は、同じコンテナ要素内の Position より前の子要素の数。

戻る

Position - 新しい Position

認可

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

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

newRange()

ドキュメント要素から Range オブジェクトを作成するために使用されるビルダーを作成します。

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

戻る

RangeBuilder - 新しいビルダー

認可

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

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

removeEditor(emailAddress)

指定されたユーザーを Document の編集者のリストから削除します。このメソッドは、Document がドメイン全体で共有されている場合や、Document がアクセスできる共有ドライブ内にある場合など、一般的なアクセス権を持つクラスのクラスに属している場合、ユーザーが Document にアクセスすることをブロックしません。

ドライブ ファイルの場合は、閲覧者のリストからユーザーも削除されます。

パラメータ

名前説明
emailAddressString削除するユーザーのメールアドレス。

戻る

Document - この Document。チェーン用です。

認可

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

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

removeEditor(user)

指定されたユーザーを Document の編集者のリストから削除します。このメソッドは、Document がドメイン全体で共有されている場合や、Document がアクセスできる共有ドライブ内にある場合など、一般的なアクセス権を持つクラスのクラスに属している場合、ユーザーが Document にアクセスすることをブロックしません。

ドライブ ファイルの場合は、閲覧者のリストからユーザーも削除されます。

パラメータ

名前説明
userUser削除するユーザーの表現。

戻る

Document - この Document。チェーン用です。

認可

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

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

removeViewer(emailAddress)

Document の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが編集者で、閲覧者や閲覧者(コメント可)ではない場合、このメソッドは何の効果も生じさせません。この方法は、一般へのアクセス権を持つユーザーのクラスに属している場合であっても、Document へのアクセスをブロックしません。たとえば、Document がドメイン全体と共有されている場合や、ユーザーがアクセスできる共有ドライブに Document が含まれている場合も同様です。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

名前説明
emailAddressString削除するユーザーのメールアドレス。

戻る

Document - チェーン用の Document

認可

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

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

removeViewer(user)

Document の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが編集者ではなく閲覧者では、このメソッドは何の効果も生じさせません。このメソッドは、Document がドメイン全体で共有されている場合や、Document がアクセスできる共有ドライブ内にある場合など、一般アクセス権を持つユーザーのクラスに属している場合に、ユーザーが Document にアクセスすることをブロックしません。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

名前説明
userUser削除するユーザーの表現。

戻る

Document - チェーン用の Document

認可

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

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

saveAndClose()

現在の Document を保存します。保留中の更新をフラッシュして適用します。

saveAndClose() メソッドは、開いている編集可能な各 Document で、スクリプト実行の最後に自動的に呼び出されます。

閉じた Document は編集できません。DocumentApp.openById() を使用して、特定のドキュメントを編集用に再度開きます。

認可

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

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

setCursor(position)

Position が付与された場合に、アクティブなドキュメントでユーザーのカーソルを設定します。スクリプトがユーザーのカーソルにアクセスできるのは、スクリプトがドキュメントにバインドされている場合に限ります。

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

パラメータ

名前説明
positionPosition新しいカーソルの位置

戻る

Document - この Document(チェーンの場合)

認可

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

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

setLanguage(languageCode)

ドキュメントの言語コードを設定します。これは、ドキュメント エディタのファイル言語に表示される言語です。ドキュメントに含まれる実際の言語とは限りません。有効なすべての言語コードを取得するには、getSupportedLanguageCodes() を使用します。

パラメータ

名前説明
languageCodeString言語コード。

戻る

Document - この Document。チェーン用です。

認可

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

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

setName(name)

ドキュメントのタイトルを設定します。

パラメータ

名前説明
nameString新しいドキュメントのタイトル

戻る

Document - 現在のドキュメント。

認可

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

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

setSelection(range)

Range が付与された場合に、アクティブなドキュメントでユーザーの選択を設定します。スクリプトがアクセスできるのは、スクリプトを実行しているユーザーのみです。また、スクリプトがドキュメントにバインドされている場合に限ります。

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

パラメータ

名前説明
rangeRange選択する新しい要素の範囲

戻る

Document - この Document(チェーンの場合)

認可

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

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