说明
使用 chrome.bookmarks API 创建、整理和以其他方式处理书签。另请参阅替换页面，您可以使用该页面创建自定义书签管理器页面。
权限
bookmarks您必须在扩展程序清单中声明“书签”权限，才能使用 Bookmarks API。例如：
{
"name": "My extension",
...
"permissions": [
"bookmarks"
],
...
}
概念和用法
对象和属性
书签以树状结构进行整理，其中树中的每个节点都是一个书签或文件夹（有时称为组）。树中的每个节点都由 bookmarks.BookmarkTreeNode 对象表示。
BookmarkTreeNode 属性在整个 chrome.bookmarks API 中均可使用。例如，调用 bookmarks.create 时，您需要传入新节点的父节点 (parentId)，以及可选的节点的 index、title 和 url 属性。如需了解节点可以具有的属性，请参阅 bookmarks.BookmarkTreeNode。
示例
以下代码会创建一个标题为“扩展程序书签”的文件夹。create() 的第一个参数用于指定新文件夹的属性。第二个实参用于定义在创建文件夹后要执行的函数。
chrome.bookmarks.create(
{'parentId': bookmarkBar.id, 'title': 'Extension bookmarks'},
function(newFolder) {
console.log("added folder: " + newFolder.title);
},
);
以下代码段会创建一个指向扩展程序开发者文档的书签。由于创建书签失败不会造成任何不良后果，因此此代码不必定义回调函数。
chrome.bookmarks.create({
'parentId': extensionsFolderId,
'title': 'Extensions doc',
'url': 'https://developer.chrome.com/docs/extensions',
});
如需试用此 API，请从 chrome-extension-samples 代码库安装 Bookmarks API 示例。
类型
BookmarkTreeNode
书签树中的节点（书签或文件夹）。子节点在其父级文件夹中会按顺序排列。
属性
-
孩子
BookmarkTreeNode[] 可选
此节点的子节点的有序列表。
-
dateAdded
number 可选
此节点的创建时间（从公元纪年开始计算，以毫秒为单位）(
new Date(dateAdded))。 -
dateGroupModified
number 可选
此文件夹上次更改内容的时间（以自纪元以来经过的毫秒数表示）。
-
dateLastUsed
number 可选
Chrome 114 及更高版本此节点上次打开的时间（以自纪元以来经过的毫秒数表示）。未为文件夹设置。
-
id
字符串
节点的唯一标识符。这些 ID 在当前个人资料中是唯一的，即使浏览器重启后，它们也仍然有效。
-
索引
number 可选
此节点在其父级文件夹中的编号（从 0 开始）。
-
parentId
字符串（选填）
父级文件夹的
id。对于根节点，请省略此属性。 -
title
字符串
为节点显示的文本。
-
不可修改
“managed”
可选指明此节点不可修改的原因。
managed值表示此节点是由系统管理员或受监督用户的监护人配置的。如果节点可由用户和扩展程序修改，则省略此属性（默认）。 -
网址
字符串（选填）
用户点击书签时导航到的网址。文件夹会省略此字段。
BookmarkTreeNodeUnmodifiable
指明此节点不可修改的原因。managed 值表示此节点由系统管理员配置。如果节点可由用户和扩展程序修改，则省略此属性（默认）。
值
“managed”
CreateDetails
传递给 create() 函数的对象。
属性
-
索引
number 可选
-
parentId
字符串（选填）
默认为“其他书签”文件夹。
-
title
字符串（选填）
-
网址
字符串（选填）
属性
MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE
书签写入操作不再受 Chrome 限制。
值
1000000
MAX_WRITE_OPERATIONS_PER_HOUR
书签写入操作不再受 Chrome 限制。
值
1000000
方法
create()
chrome.bookmarks.create(
bookmark: CreateDetails,
callback?: function,
)
在指定的 parentId 下创建书签或文件夹。如果网址为 null 或缺失，则为文件夹。
参数
-
callback
函数（可选）
callback参数如下所示：(result: BookmarkTreeNode) => void
返回
-
Promise<BookmarkTreeNode>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
get()
chrome.bookmarks.get(
idOrIdList: string | [string, ...string[]],
callback?: function,
)
检索指定的 BookmarkTreeNode。
参数
-
idOrIdList
string | [string, ...string[]]
一个字符串值 ID，或一个字符串值 ID 数组
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
getChildren()
chrome.bookmarks.getChildren(
id: string,
callback?: function,
)
检索指定 BookmarkTreeNode ID 的子项。
参数
-
id
字符串
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
getRecent()
chrome.bookmarks.getRecent(
numberOfItems: number,
callback?: function,
)
检索最近添加的书签。
参数
-
numberOfItems
数值
需要返回的最大项数。
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
getSubTree()
chrome.bookmarks.getSubTree(
id: string,
callback?: function,
)
检索从指定节点开始的部分书签层次结构。
参数
-
id
字符串
要检索的子树的根的 ID。
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
getTree()
chrome.bookmarks.getTree(
callback?: function,
)
检索整个书签层次结构。
参数
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
move()
chrome.bookmarks.move(
id: string,
destination: object,
callback?: function,
)
将指定的 BookmarkTreeNode 移至所提供的位置。
参数
-
id
字符串
-
目标账号
对象
-
索引
number 可选
-
parentId
字符串（选填）
-
-
callback
函数（可选）
callback参数如下所示：(result: BookmarkTreeNode) => void
返回
-
Promise<BookmarkTreeNode>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
remove()
chrome.bookmarks.remove(
id: string,
callback?: function,
)
移除书签或空白书签文件夹。
参数
-
id
字符串
-
callback
函数（可选）
callback参数如下所示：() => void
返回
-
Promise<void>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
removeTree()
chrome.bookmarks.removeTree(
id: string,
callback?: function,
)
递归移除书签文件夹。
参数
-
id
字符串
-
callback
函数（可选）
callback参数如下所示：() => void
返回
-
Promise<void>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
search()
chrome.bookmarks.search(
query: string | object,
callback?: function,
)
搜索与给定查询匹配的 BookmarkTreeNode。使用对象指定的查询会生成与所有指定属性匹配的 BookmarkTreeNode。
参数
-
查询
字符串 | 对象
一个字符串，其中包含要与书签网址和标题进行匹配的字词和带引号的短语，或者一个对象。如果是对象，则可以指定
query、url和title属性，系统会生成与所有指定属性匹配的书签。-
查询
字符串（选填）
一串字词和带引号的短语，用于与书签网址和标题进行匹配。
-
title
字符串（选填）
书签的标题；完全匹配。
-
网址
字符串（选填）
书签的网址；完全匹配。请注意，文件夹没有网址。
-
-
callback
函数（可选）
callback参数如下所示：(results: BookmarkTreeNode[]) => void
-
结果
-
返回
-
Promise<BookmarkTreeNode[]>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
update()
chrome.bookmarks.update(
id: string,
changes: object,
callback?: function,
)
更新书签或文件夹的属性。请仅指定您要更改的属性；未指定的属性将保持不变。注意：目前，仅支持“title”和“url”。
参数
-
id
字符串
-
更改
对象
-
title
字符串（选填）
-
网址
字符串（选填）
-
-
callback
函数（可选）
callback参数如下所示：(result: BookmarkTreeNode) => void
返回
-
Promise<BookmarkTreeNode>
Chrome 90 及更高版本清单 V3 及更高版本支持 Promise，但为了实现向后兼容性，我们提供了回调。您不能在同一函数调用中同时使用这两种方法。promise 的解析结果与传递给回调的类型相同。
事件
onChanged
chrome.bookmarks.onChanged.addListener(
callback: function,
)
在书签或文件夹发生变化时触发。注意：目前，只有标题和网址更改会触发此操作。
参数
-
callback
函数
callback参数如下所示：(id: string, changeInfo: object) => void
-
id
字符串
-
changeInfo
对象
-
title
字符串
-
网址
字符串（选填）
-
-
onChildrenReordered
chrome.bookmarks.onChildrenReordered.addListener(
callback: function,
)
当文件夹的子项因界面中的排序而更改其顺序时触发。此方法不会因 move() 而被调用。
参数
-
callback
函数
callback参数如下所示：(id: string, reorderInfo: object) => void
-
id
字符串
-
reorderInfo
对象
-
childIds
字符串[]
-
-
onCreated
chrome.bookmarks.onCreated.addListener(
callback: function,
)
在创建书签或文件夹时触发。
参数
-
callback
函数
callback参数如下所示：(id: string, bookmark: BookmarkTreeNode) => void
-
id
字符串
-
onImportBegan
chrome.bookmarks.onImportBegan.addListener(
callback: function,
)
在开始书签导入会话时触发。在 onImportEnded 触发之前，开销较大的观察器应忽略 onCreated 更新。观察器仍应立即处理其他通知。
参数
-
callback
函数
callback参数如下所示：() => void
onImportEnded
chrome.bookmarks.onImportEnded.addListener(
callback: function,
)
在书签导入会话结束时触发。
参数
-
callback
函数
callback参数如下所示：() => void
onMoved
chrome.bookmarks.onMoved.addListener(
callback: function,
)
当书签或文件夹移至其他父级文件夹时触发。
参数
-
callback
函数
callback参数如下所示：(id: string, moveInfo: object) => void
-
id
字符串
-
moveInfo
对象
-
索引
数值
-
oldIndex
数值
-
oldParentId
字符串
-
parentId
字符串
-
-
onRemoved
chrome.bookmarks.onRemoved.addListener(
callback: function,
)
在移除书签或文件夹时触发。递归移除文件夹时，系统会为该文件夹触发一次通知，而不会为其内容触发任何通知。
参数
-
callback
函数
callback参数如下所示：(id: string, removeInfo: object) => void
-
id
字符串
-
removeInfo
对象
-
索引
数值
-
Chrome 48 及更高版本
-
parentId
字符串
-
-