Class Bookmark

ブックマーク

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

// Insert a bookmark at the cursor position and log its ID.
var doc = DocumentApp.getActiveDocument();
var cursor = doc.getCursor();
var bookmark = doc.addBookmark(cursor);
Logger.log(bookmark.getId());

Methods

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

詳細なドキュメント

getId()

Bookmark の ID を取得します。ID はドキュメント内で一意です。

リターン

String - Bookmark の ID(ドキュメント内で一意の ID)

承認

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

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

getPosition()

Document 内の BookmarkPosition を取得します。スクリプトによってドキュメント構造が変更されても、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