Class Document

指定された 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('123abc');

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

パラメータ

戻る

Bookmark - 新しいブックマーク。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

フッター セクションが存在しない場合は、最初のタブまたは、ドキュメントにバインドされているスクリプトの場合はアクティブなタブにフッター セクションを追加します。タブにフッター セクションを追加するには、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('123abc');

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

ヘッダー セクションが存在しない場合は、最初のタブまたは、ドキュメントにバインドされているスクリプトの場合はアクティブなタブにヘッダー セクションを追加します。タブにヘッダー セクションを追加するには、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('123abc');

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

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

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

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let 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());

パラメータ

戻る

NamedRange - NamedRange。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

ドキュメント内の現在アクティブな 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

現在の 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('123abc');

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

パラメータ

戻る

Blob - 現在のドキュメントを Blob として取得します。

現在の 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('123abc');

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

戻る

Blob - 現在のドキュメントを Blob として取得します。

最初のタブの 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('123abc');

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

指定された 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('123abc');

// 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.');
}

パラメータ

戻る

Bookmark|null - 指定された ID の Bookmark。タブ内にそのような Bookmark が存在しない場合は null。

承認

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

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

最初のタブにあるすべての Bookmark オブジェクトを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブにあるすべての 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('123abc');

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

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

// Insert some text at the cursor position and make it bold.
const 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.
  const 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 - ユーザーのカーソルの表現。ユーザーがタブにカーソルを配置していない場合、またはスクリプトがドキュメントにバインドされていない場合は null。

承認

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

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

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

戻る

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

承認

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

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

最初のタブのフッター セクションを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブのフッター セクションを取得します。任意のタブのフッター セクションを取得するには、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('123abc');

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

戻る

FooterSection|null - タブのフッター。

承認

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

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

最初のタブの本文にあるすべての Footnote 要素を取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブの本文にあるすべての 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('123abc');

// 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[]|null - タブの脚注。

承認

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

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

最初のタブのヘッダー セクションを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブのヘッダー セクションを取得します。任意のタブのヘッダー セクションを取得するには、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('123abc');

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

戻る

HeaderSection|null - タブのヘッダー。

承認

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

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

ドキュメントの一意の ID を取得します。ドキュメント ID は、DocumentApp.openById() とともに使用して、特定のドキュメント インスタンスを開きます。

戻る

String - ドキュメントの ID。

承認

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

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

ドキュメントの言語コードを取得します。これは、ドキュメント エディタの [ファイル] > [言語] に表示される言語です。ドキュメントに含まれている実際の言語とは異なる場合があります。

戻る

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

承認

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

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

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

戻る

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

承認

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

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

指定された ID の NamedRange を最初のタブから取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブから取得します。任意のタブで指定された ID の NamedRange を取得するには、DocumentTab.getNamedRangeById(id) メソッドを使用します。タブにそのような NamedRange が存在しない場合、このメソッドは null を返します。名前は、タブ間でも必ずしも一意ではありません。同じタブ内の複数の異なる範囲で同じ名前を共有できます。これは HTML のクラスに似ています。一方、ID は HTML の ID のように、タブ内で一意です。

パラメータ

戻る

NamedRange|null - 指定された ID の NamedRange。タブにそのような範囲が存在しない場合は null。

承認

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

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

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

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

戻る

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

承認

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

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

最初のタブにある指定された名前のすべての NamedRange オブジェクトを取得します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブにある指定された名前のすべての NamedRange オブジェクトを取得します。タブ内のすべての NamedRange オブジェクトを取得するには、DocumentTab.getNamedRanges(name) メソッドを使用します。名前は、タブ間でも一意である必要はありません。同じタブ内の複数の異なる範囲が、HTML のクラスのように同じ名前を共有できます。一方、ID は HTML の ID のように、タブ内で一意です。

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

パラメータ

戻る

NamedRange[] - 指定された名前のタブにある NamedRange オブジェクトの配列。

承認

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

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

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

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

戻る

Range|null - ユーザーの選択内容を表します。タブで何も選択されていない場合、段落の末尾のみが選択されている場合、段落の末尾と改行のみが選択されている場合、またはスクリプトがドキュメントにバインドされていない場合は null。

承認

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

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

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

戻る

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

承認

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

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

指定された ID の Tab を取得します。そのような Tab が存在しない場合、このメソッドは null を返します。任意のネストレベルのタブにアクセスできます。

パラメータ

戻る

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

承認

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

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

ドキュメントの一部であるネストされていないすべての Tab を取得します。

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

戻る

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

承認

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

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

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

const 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

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

戻る

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

承認

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

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

新しい Position を作成します。これは、最初のタブの特定の要素に対するタブ内の場所への参照です。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブに対するタブ内の場所への参照です。任意のタブのロケーションを基準にして 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.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

パラメータ

戻る

Position - 新しい Position。

承認

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

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

最初のタブのタブ要素から Range オブジェクトを構築するために使用されるビルダーを作成します。ドキュメントにバインドされているスクリプトの場合は、アクティブなタブのタブ要素から Range オブジェクトを構築するために使用されるビルダーを作成します。任意のタブのタブ要素から DocumentRange オブジェクトを構築するために使用されるビルダーを作成するには、DocumentTab.newRange() メソッドを使用します。

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let 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

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

ドライブ ファイルの場合、この操作を行うと、閲覧者リストからもユーザーが削除されます。

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

ドライブ ファイルの場合、この操作を行うと、閲覧者リストからもユーザーが削除されます。

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

ドライブ ファイルの場合、この操作を行うと、ユーザーは編集者のリストからも削除されます。

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

ドライブ ファイルの場合、この操作を行うと、ユーザーは編集者のリストからも削除されます。

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

現在の Document を保存します。保留中のアップデートをフラッシュして適用します。

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

クローズした Document は編集できません。DocumentApp.openById() を使用して、指定されたドキュメントを編集用に再度開きます。

承認

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

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

現在のドキュメントでユーザーが選択した 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('123abc');

パラメータ

承認

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

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

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

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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

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

パラメータ

戻る

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

承認

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

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

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

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

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

パラメータ

戻る

Document - チェーン用の Document。

承認

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

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