API リファレンス
ブックマーク
機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。
型定義
graphql
type Mutation {
addBookmarks(urls: [String!]!, groupId: ID!): [Bookmark!]!
createBookmarkGroup(name: String!): BookmarkGroup!
deleteBookmarkGroup(id: ID!): Boolean!
deleteBookmarks(ids: [ID!]!): ActionResult!
importBookmarks(content: String!): ActionResult!
recordBookmarkClick(id: ID!): Boolean!
updateBookmark(id: ID!, input: BookmarkInput!): Bookmark!
updateBookmarkGroup(id: ID!, name: String!, collapsed: Boolean!, sortOrder: Int!): BookmarkGroup!
}
type Query {
bookmark(id: ID!): Bookmark
bookmarkGroups: [BookmarkGroup!]!
bookmarks: [Bookmark!]!
pageMetadata(url: String!): PageMetadata!
}
type Subscription {
bookmarksUpdated: [Bookmark!]!
}
type ActionResult {
affectedCount: Int!
}
type Bookmark {
id: ID!
url: String!
title: String!
faviconPath: String!
groupId: ID!
pinned: Boolean!
clickCount: Int!
sortOrder: Int!
createdAt: Instant!
updatedAt: Instant!
lastClickedAt: Instant
}
type BookmarkGroup {
id: ID!
name: String!
collapsed: Boolean!
sortOrder: Int!
itemCount: Int!
createdAt: Instant!
updatedAt: Instant!
}
input BookmarkInput {
url: String!
title: String!
faviconUrl: String
groupId: ID!
pinned: Boolean!
sortOrder: Int!
}
scalar Instant
type PageMetadata {
title: String
faviconUrl: String
}操作
mutation
addBookmarks
指定したグループに、指定した URL のブックマークを作成します。
graphql
mutation addBookmarks($urls: [String!]!, $groupId: ID!) {
addBookmarks(urls: $urls, groupId: $groupId) { id url title faviconPath groupId pinned clickCount sortOrder }
}mutation
createBookmarkGroup
新しいブックマークグループを作成します。
graphql
mutation createBookmarkGroup($name: String!) {
createBookmarkGroup(name: $name) { id name collapsed sortOrder itemCount createdAt updatedAt }
}mutation
deleteBookmarkGroup
ブックマークグループを削除します。内部のブックマークは削除せず、グループ分けのみ解除します。
graphql
mutation deleteBookmarkGroup($id: ID!) {
deleteBookmarkGroup(id: $id)
}mutation
deleteBookmarks
ID を指定して 1 つ以上のブックマークを削除します。
graphql
mutation deleteBookmarks($ids: [ID!]!) {
deleteBookmarks(ids: $ids) { affectedCount }
}mutation
importBookmarks
指定したドキュメント内容からブックマークをインポートし、影響を受けた件数を報告します。
graphql
mutation importBookmarks($content: String!) {
importBookmarks(content: $content) { affectedCount }
}mutation
recordBookmarkClick
ブックマークに保存された訪問回数を増やします。
graphql
mutation recordBookmarkClick($id: ID!) {
recordBookmarkClick(id: $id)
}mutation
updateBookmark
既存ブックマークの 1 つ以上のフィールドを更新します。
graphql
mutation updateBookmark($id: ID!, $input: BookmarkInput!) {
updateBookmark(id: $id, input: $input) { id url title faviconPath groupId pinned clickCount sortOrder }
}mutation
updateBookmarkGroup
ブックマークグループの名前、折りたたみ状態、並び順を更新します。
graphql
mutation updateBookmarkGroup($id: ID!, $name: String!, $collapsed: Boolean!, $sortOrder: Int!) {
updateBookmarkGroup(id: $id, name: $name, collapsed: $collapsed, sortOrder: $sortOrder) { id name collapsed sortOrder itemCount createdAt updatedAt }
}query
bookmark
ID を指定して保存済みブックマークを 1 件読み取り、存在しない場合は null を返します。
graphql
query bookmark($id: ID!) {
bookmark(id: $id) { id url title faviconPath groupId pinned clickCount sortOrder }
}query
bookmarkGroups
すべてのブックマークグループを一覧表示します。
graphql
query bookmarkGroups {
bookmarkGroups { id name collapsed sortOrder itemCount createdAt updatedAt }
}query
bookmarks
すべてのブックマークを一覧表示します。
graphql
query bookmarks {
bookmarks { id url title faviconPath groupId pinned clickCount sortOrder }
}query
pageMetadata
ブックマークを保存せずに、Web ページのタイトルとファビコン URL を取得します。
graphql
query pageMetadata($url: String!) {
pageMetadata(url: $url) { title faviconUrl }
}subscription
bookmarksUpdated
更新されたブックマークレコードを受信します。
graphql
subscription bookmarksUpdated {
bookmarksUpdated { id url title faviconPath groupId pinned clickCount sortOrder }
}