Class Document

ドキュメント

1 つ以上の Tab オブジェクトを含むドキュメント。各オブジェクトには、リッチテキストと テーブルやリストなどの要素です

ドキュメントは、DocumentApp を使用して開くか、作成できます。 

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

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

テキスト コンテンツに直接アクセスして変更する Document クラスのメソッド アクティブなタブ（特定のプロパティにバインドされているスクリプト または最初のタブ（アクティブなタブが利用できない場合）に重ねて表示できます。以下に依存するスクリプト: これらのメソッド（getBody() など）は、 getTabs()、次に Tab.asDocumentTab()。

メソッド

メソッド戻り値の型概要
addBookmark(position)Bookmark指定された Position の Bookmark を最初のタブに追加します。または、 ドキュメント、アクティブなタブにバインドされます。
addEditor(emailAddress)Document指定されたユーザーを Document の編集者のリストに追加します。
addEditor(user)Document指定されたユーザーを Document の編集者のリストに追加します。
addEditors(emailAddresses)Document指定されたユーザー配列を Document の編集者のリストに追加します。
addFooter()FooterSectionフッター セクションが存在しない場合は最初のタブ、またはドキュメントにバインドされているスクリプトの場合はアクティブなタブに追加します。
addHeader()HeaderSectionヘッダー セクションが存在しない場合は最初のタブに追加します。ドキュメントにバインドされているスクリプトの場合はアクティブなタブを追加します。
addNamedRange(name, range)NamedRangeNamedRange を追加します。これは、名前と ID を持つ Range です。 その後、最初のタブで取得するか、ドキュメントにバインドされているスクリプトの場合はアクティブなタブで取得します。
addViewer(emailAddress)Document指定したユーザーを Document の閲覧者のリストに追加します。
addViewer(user)Document指定したユーザーを Document の閲覧者のリストに追加します。
addViewers(emailAddresses)Document指定されたユーザーの配列を Document の閲覧者のリストに追加します。
getActiveTab()Tabドキュメント内でユーザーの現在アクティブな Tab を取得します。
getAs(contentType)Blob現在の Document コンテンツを、指定された型の blob として取得します。
getBlob()Blob現在の Document コンテンツを blob として取得します。
getBody()Body最初のタブの Body を取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブの DocumentBodySection を取得します。
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 ドキュメント ファイルでサポートされているすべての言語コードを取得します。
getTab(tabId)Tab指定された ID を持つ Tab を取得します。
getTabs()Tab[]ドキュメントに含まれる、ネストされていないすべての Tab を取得します。
getUrl()String現在のドキュメントにアクセスするための URL を取得します。
getViewers()User[]この Document の閲覧者とコメント投稿者のリストを取得します。
newPosition(element, offset)Position新しい Position を作成します。これは、 最初のタブの特定の要素、ドキュメントにバインドされているスクリプトの場合はアクティブなタブ。
newRange()RangeBuilder次のタブ要素から Range オブジェクトを構築するために使用されるビルダーを作成します。 最初のタブ。スクリプトが特定のプロジェクトにバインドされている場合は、 ドキュメント、アクティブなタブです。
removeEditor(emailAddress)DocumentDocument の編集者のリストから指定したユーザーを削除します。
removeEditor(user)DocumentDocument の編集者のリストから指定したユーザーを削除します。
removeViewer(emailAddress)DocumentDocument の閲覧者と閲覧者（コメント可）のリストから指定したユーザーを削除します。
removeViewer(user)DocumentDocument の閲覧者と閲覧者（コメント可）のリストから指定したユーザーを削除します。
saveAndClose()void現在の Document を保存します。
setActiveTab(tabId)void現在のドキュメントでユーザーが選択した Tab を、指定された ID のタブに設定します。
setCursor(position)Document指定された Position に、ユーザーのカーソルを設定します。
setLanguage(languageCode)Documentドキュメントの言語コードを設定します。
setName(name)Documentドキュメントのタイトルを設定します。
setSelection(range)DocumentRange に基づいて、アクティブなタブでのユーザーの選択を設定します。

詳細なドキュメント

addBookmark(position)

指定された Position の Bookmark を最初のタブに追加します。または、 ドキュメント、アクティブなタブにバインドされます。コメントを追加するには、 ブックマークするには、DocumentTab.addBookmark(position) メソッドを使用します。 

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

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

パラメータ

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

フッター セクションが存在しない場合は最初のタブ、またはドキュメントにバインドされているスクリプトの場合はアクティブなタブに追加します。フッターを追加するには セクションを任意のタブに表示するには、DocumentTab.addFooter() メソッドを使用します。 

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

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

戻る

FooterSection - タブのフッター。

承認

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

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

addHeader()

ヘッダー セクションが存在しない場合は最初のタブに追加します。ドキュメントにバインドされているスクリプトの場合はアクティブなタブを追加します。ヘッダーを追加するには セクションを任意のタブに表示するには、DocumentTab.addHeader() メソッドを使用します。 

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

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

戻る

HeaderSection - タブのヘッダー。

承認

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

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

addNamedRange(name, range)

NamedRange を追加します。これは、名前と ID を持つ Range です。 その後、最初のタブで取得するか、ドキュメントにバインドされているスクリプトの場合はアクティブなタブで取得します。いずれかのタブに NamedRange を追加するには、DocumentTab.addNamedRange(name, range) メソッドを使用します。名前は正しくない 必ずしも一意ではありません同じドキュメント内の複数の異なる範囲で同じ名前を共有できます。 使用できます。一方、ID は HTML の ID のようにドキュメント内で一意です。 ドキュメントに追加した NamedRange は、変更できず、削除のみ可能です。

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

// Creates a named range that includes every table in the active tab.
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]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', 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

getActiveTab()

ドキュメント内でユーザーの現在アクティブな Tab を取得します。スクリプトがアクセスできるのは スクリプトを実行しているユーザーのアクティブ タブ。スクリプトがドキュメントにバインドされている場合にのみ発生します。 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

戻る

Tab - ユーザーが現在アクティブな Tab。スクリプトがバインドされていない場合は null。 できます。

承認

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

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

getAs(contentType)

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

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

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

パラメータ

名前型説明
contentTypeString変換先の MIME タイプ。'application/pdf' と 'text/markdown' がサポートされています。

戻る

Blob - 現在のドキュメント（blob 形式）。

getBlob()

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

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

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

戻る

Blob - 現在のドキュメント（blob 形式）。

getBody()

最初のタブの Body を取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブの DocumentBodySection を取得します。任意のタブの DocumentBodySection を取得するには、DocumentTab.getBody() メソッドを使用します。

タブにはさまざまなタイプのセクションを含めることができます（例: HeaderSection、FooterSection）。タブのアクティブなセクションは Body です。

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

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

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

戻る

Body - タブ本文のセクション。

承認

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

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

getBookmark(id)

最初のタブで指定された ID の Bookmark を取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブ タブを取得します。特典を ブックマークするには、DocumentTab.getBookmark(id) メソッドを使用します。このメソッドは、タブ内に該当する Bookmark が存在しない場合、null を返します。 

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

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

パラメータ

名前型説明
idStringBookmark の ID。

戻る

Bookmark - 指定された ID を持つ Bookmark。該当する Bookmark がない場合は null タブ内にあります。

承認

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

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

getBookmarks()

最初のタブのすべての Bookmark オブジェクトを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブを取得します。すべての機能を ブックマークするには、DocumentTab.getBookmarks() メソッドを使用します。 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

戻る

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

最初のタブのフッター セクションを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブ タブのフッターを取得します。 。タブのフッター セクションを取得するには、DocumentTab.getFooter() メソッドを使用します。 

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

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

戻る

FooterSection - タブのフッター。

承認

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

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

getFootnotes()

最初のタブの本文にある Footnote 要素をすべて取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブの本文を取得します。特典を すべての脚注を削除するには、DocumentTab.getFootnotes() メソッドを使用します。

getFootnotes を呼び出すと、タブの要素が反復処理されます。大きなタブの場合 このメソッドの不要な呼び出しを回避してください。 

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

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

戻る

Footnote[] - タブの脚注。

承認

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

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

getHeader()

最初のタブのヘッダー セクションを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブ タブのヘッダーを取得します。 。任意のタブのヘッダー セクションを取得するには、DocumentTab.getHeader() メソッドを使用します。 

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

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

戻る

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

ドキュメントの言語コードを取得します。これは、ドキュメント エディタの [ファイル &gt;Language は、ドキュメントに記載されている実際の言語とは異なる場合があります。

戻る

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 を取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブ タブを取得します。取得するには、 任意のタブで、指定された ID を持つ NamedRange には、DocumentTab.getNamedRangeById(id) を使用します。 メソッドを呼び出します。このメソッドは、該当する NamedRange がタブに存在しない場合、null を返します。名前 タブ間でも一意であるとは限りません。同じタブに複数の異なる範囲がある場合、 HTML のクラスのように、同じ名前を持つオブジェクトです。一方、ID はタブ内では一意であり、 使用できます

パラメータ

名前型説明
idString範囲の ID（タブ内で一意）。

戻る

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

承認

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

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

getNamedRanges()

最初のタブのすべての NamedRange オブジェクトを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブを取得します。すべての機能を NamedRange オブジェクトがある場合は、DocumentTab.getNamedRanges() メソッドを使用します。

NamedRange には、タブにアクセスするすべてのスクリプトからアクセスできます。避けるべきこと スクリプト間で意図しない競合が発生している場合は、範囲名の先頭に一意の文字列を付けることを検討してください。

戻る

NamedRange[] - タブ内の NamedRange オブジェクトの配列。複数のオブジェクトが含まれる場合もあります。 複数の範囲が含まれます。

承認

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

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

getNamedRanges(name)

最初のタブで指定された名前を持つ NamedRange オブジェクトをすべて取得します。 ドキュメント（アクティブなタブ）にバインドされます。特典を いずれかのタブのすべての NamedRange オブジェクトを表示するには、DocumentTab.getNamedRanges(name) メソッドを使用します。タブ間でも、名前が一意であるとは限りません。複数の異なる範囲を 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

getTab(tabId)

指定された ID を持つ Tab を取得します。該当する Tab が存在しない場合、このメソッドは null を返します。どのネスト レベルでもタブにアクセスできます。

パラメータ

名前型説明
tabIdString取得するタブの ID。

戻る

Tab - 指定された ID を持つ Tab。該当する Tab が存在しない場合は null。

承認

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

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

getTabs()

ドキュメントに含まれる、ネストされていないすべての Tab を取得します。

タブには子タブ（別のタブ内にネストされたタブ）を含めることができます。子タブにアクセスできる Tab.getChildTabs() を使用します。

戻る

Tab[] - ドキュメントに含まれるすべての Tab のリスト。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 を作成します。これは、 最初のタブの特定の要素、ドキュメントにバインドされているスクリプトの場合はアクティブなタブ。新しい P-MAX キャンペーンを 任意のタブの場所を基準とした Position の場合は、DocumentTab.newPosition(element, offset) を使用します。 メソッドを呼び出します。ユーザーのカーソルは、さまざまな用途で Position として表されます。 

// Append a paragraph to the active tab, 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 オブジェクトを構築するために使用されるビルダーを作成します。 最初のタブ。スクリプトが特定のプロジェクトにバインドされている場合は、 ドキュメント、アクティブなタブです。DocumentRange オブジェクトの作成に使用するビルダーの作成 任意のタブのタブ要素から抽出するには、DocumentTab.newRange() メソッドを使用します。 

// Change the user's selection to a range that includes every table in the active tab.
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

setActiveTab(tabId)

現在のドキュメントでユーザーが選択した Tab を、指定された ID のタブに設定します。 

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

パラメータ

名前型説明
tabIdStringアクティブとして設定するタブの ID。

承認

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

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

setCursor(position)

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

非アクティブな Tab から Position を提供すると、ユーザーのアクティブなタブが切り替わります。 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.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)

ドキュメントの言語コードを設定します。これは、ドキュメント エディタの [ファイル &gt;Language は、ドキュメントに記載されている実際の言語とは異なる場合があります。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 に基づいて、アクティブなタブでのユーザーの選択を設定します。スクリプトは スクリプトがドキュメントにバインドされている場合にのみ、スクリプトを実行しているユーザーが選択したオプションにアクセスします。 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.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