Class Bookmark

ブックマーク

ブックマークを表すオブジェクト。

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

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
const cursor = doc.getCursor();
const bookmark = documentTab.addBookmark(cursor);
Logger.log(bookmark.getId());

メソッド

メソッド戻り値の型概要
getId()StringBookmark の ID を取得します。
getPosition()PositionDocumentTab 内の Bookmark の Position を取得します。
remove()voidBookmark を削除します。

詳細なドキュメント

getId()

Bookmark の ID を取得します。ID は DocumentTab 内で一意です。

戻る

String - Bookmark の ID。DocumentTab 内で一意です。

承認

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

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

getPosition()

DocumentTab 内の Bookmark の Position を取得します。スクリプトでドキュメント構造が変更された場合でも、Bookmark が削除されない限り、Position は正確なままです。

戻る

Position - Bookmark の位置。

承認

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

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

remove()

Bookmark を削除します。すでに削除されている Bookmark でこのメソッドを呼び出しても効果はありません。

承認

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

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