WebExtensions bookmarks API を利用すると、拡張機能からブラウザのブックマークシステムにアクセスしたり、操作することができます。ページをブックマークする、既存のブックマークを取得したり、ブックマークを編集・削除・整理することが可能です。

この API を使用する際は、拡張機能の manifest.json ファイルで "bookmarks" パーミッション を指定する必要があります。

関連する値の型

bookmarks.BookmarkTreeNode
ブックマークツリー上のブックマークやフォルダを表します。
bookmarks.BookmarkTreeNodeType
ツリー内のノードがブックマークかフォルダーかセパレーターかを表す string の列挙型です。
bookmarks.BookmarkTreeNodeUnmodifiable
ブックマークやフォルダが変更不可である理由を表す string の列挙型です。
bookmarks.CreateDetails
新しいブックマークを作成する際、bookmarks.create() メソッドに渡す情報を含みます。

メソッド

bookmarks.create()
ブックマークやフォルダを作成します。
bookmarks.get()
ブックマークの ID や ID の配列を指定し、1 つ以上の BookmarkTreeNode(s) を取得します。
bookmarks.getChildren()
指定した BookmarkTreeNode の子要素を取得します。
bookmarks.getRecent()
最近追加されたブックマークを取得します。
bookmarks.getSubTree()
指定したノードを起点とする、ブックマークツリーの部分木を取得します。
bookmarks.getTree()
ブックマークのツリー全体を BookmarkTreeNode オブジェクトの配列として取得します。
bookmarks.move()
指定した BookmarkTreeNode を所望の場所に移します。
bookmarks.remove()
ノードの ID を指定し、ブックマークや空のブックマークフォルダを削除します。
bookmarks.removeTree()
ブックマークのフォルダを再帰的に削除します。すなわち、フォルダノードの ID を指定し、そのノードと子要素すべてを削除します。
bookmarks.search()
与えた条件に一致する BookmarkTreeNodes を検索します。
bookmarks.update()
ブックマークの ID を指定し、ブックマークの URL やタイトル、またはフォルダの名前を更新します。

イベント

bookmarks.onCreated
ブックマークやフォルダが作成された際に発火します。
bookmarks.onRemoved
ブックマークやフォルダが削除された際に発火します。フォルダが再帰的に削除された場合は、そのフォルダに対して一回だけ発火し、フォルダの中身については発火しません。
bookmarks.onChanged
ブックマークやフォルダが変更された際に発火します。現在は title と url の変更に対してのみ発火します。
bookmarks.onMoved
異なる親フォルダへ、または同じフォルダ内の異なる場所へブックマークやフォルダが移された際に発火します。
bookmarks.onChildrenReordered
UI で表示されている順序に伴って子フォルダの順序も変更された際に発火します。move() の実行後には発火しません。
bookmarks.onImportBegan
ブックマークのインポートが開始した際に発火します。パフォーマンスが重要である場合、イベントのオブザーバは bookmarks.onImportEnded が発火するまで bookmarks.onCreated を無視すべきでしょう。その場合であっても、オブザーバは他のイベントについては即座に処理すべきでしょう。
bookmarks.onImportEnded
ブックマークのインポートが終了した際に発火します。

ブラウザ実装状況

ChromeEdgeFirefoxFirefox for AndroidOpera
BookmarkTreeNode あり なし45 なし あり
BookmarkTreeNodeType なし なし57 なし なし
BookmarkTreeNodeUnmodifiable あり なし45 なし あり
CreateDetails あり なし45 なし あり
create あり1545 なし あり
get あり なし45 なし あり
getChildren あり なし45 なし あり
getRecent あり なし47 なし あり
getSubTree あり なし45 なし あり
getTree あり1545 なし あり
move あり1545 なし あり
onChanged あり なし52 なし あり
onChildrenReordered あり なし なし なし あり
onCreated あり なし52 なし あり
onImportBegan あり なし なし なし あり
onImportEnded あり なし なし なし あり
onMoved あり なし52 なし あり
onRemoved あり なし52 なし あり
remove あり1545 なし あり
removeTree あり1547 なし あり
search あり なし47 なし あり
update あり1545 なし あり

Example extensions

謝辞

この API は Chromium の chrome.bookmarks API に基づいています。また、このドキュメントは bookmarks.json における Chromium のコードに基づいています。

Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。

ドキュメントのタグと貢献者

このページの貢献者: Uemmra3, hashedhyphen
最終更新者: Uemmra3,