sync ストレージ領域を指します。 sync ストレージ内のアイテムはブラウザーによって同期され、ログイン(Firefox sync や Google アカウントなど)しているブラウザー・デバイスの全てのインスタンスで利用できます。

Firefox の場合、ユーザーは "about:preferences" の "Sync 設定" オプションの下にある "アドオン" ボックスにチェックを入れる必要があります。

storage.sync の実装はアドオン ID に依存していることに注意してください。もし storage.sync を使うのであれば、 applications manifest.json キーを使用して拡張機能に ID を設定する必要があります。

この API の主な利用例は拡張機能の設定を格納し、異なるプロファイル間で同期させることです。この API は最大100 KB までデータを格納できます。それ以上格納しようとするとエラーメッセージを返して失敗します。 この API は稼働時間やパフォーマンスを保証しません。

関数

sync オブジェクトは storage.StorageArea 型で定義された関数を実装しています。

storage.StorageArea.get()
ストレージ領域から1つ以上のアイテムを取得します。
storage.StorageArea.getBytesInUse()
1つ以上のストレージ領域内に格納されたアイテムが占めるストレージ空間をバイト単位で取得します。
storage.StorageArea.set()
1つ以上のアイテムをストレージ領域に格納します。既にアイテムが存在していれば値は上書きされます。
storage.StorageArea.remove()
ストレージ領域内の1つ以上のアイテムを削除します。
storage.StorageArea.clear()
ストレージ領域内の全てのアイテムを削除します。

ブラウザ実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaAndroid 版 Firefox
基本対応Chrome 完全対応 ありEdge 完全対応 15Firefox 完全対応 53Opera 未対応 なしFirefox Android 未対応 なし

凡例

完全対応  
完全対応
未対応  
未対応

Example extensions

Acknowledgements

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

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

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

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