chrome.browsingData

説明

chrome.browsingData API を使用して、ユーザーのローカル プロフィールから閲覧データを削除します。

権限

browsingData

この API を使用するには、拡張機能のマニフェストで "browsingData" 権限を宣言する必要があります。

{
  "name": "My extension",
  ...
  "permissions": [
    "browsingData",
  ],
  ...
}

コンセプトと使用方法

この API の最も簡単なユースケースは、ユーザーの閲覧データをクリアする時間ベースのメカニズムです。 コードでは、ユーザーの前回の閲覧から経過した過去の日付を示すタイムスタンプを提供する必要があります。 閲覧データを削除する必要があります。このタイムスタンプの形式は、 Unix エポック（getTime() メソッドを使用して JavaScript Date オブジェクトから取得できます）。

たとえば、過去 1 週間のユーザーの閲覧データをすべて消去するには、次のようにコードを記述します。 次のようになります。

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

chrome.browsingData.remove() メソッドを使用すると、各種の閲覧データを より具体的な複数のメソッドを呼び出すよりもはるかに高速です。ただし、 特定の閲覧データ（Cookie など）のみを消去したい場合は、 メソッドは、JSON で入力された呼び出しの代わりとなる、読み取り可能な代替手段を提供します。

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.removeCookies({
  "since": oneWeekAgo
}, callback);

ユーザーがデータを同期している場合、chrome.browsingData.remove() によって自動的に Cookie が再構築されることがあります。 を削除します。これは、同期の処理を継続できるため、 最終的にサーバー上のデータを削除できます。ただし、 chrome.browsingData.removeCookies() を使用して、同期アカウントの Cookie を消去できます。 一時停止されます

特定のオリジン

特定のオリジンのデータを削除したり、オリジンのセットを削除対象から除外したりするには、 RemovalOptions.origins パラメータと RemovalOptions.excludeOrigins パラメータ。適用できるのは Cookie、キャッシュ、ストレージ（CacheStorage、FileSystems、IndexedDB、LocalStorage、ServiceWorkers、 。

chrome.browsingData.remove({
  "origins": ["https://www.example.com"]
}, {
  "cacheStorage": true,
  "cookies": true,
  "fileSystems": true,
  "indexedDB": true,
  "localStorage": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

送信元の種類

API オプション オブジェクトに originTypes プロパティを追加すると、 オリジンに影響する必要がありますオリジンは 3 つのカテゴリに分類されます。

  • unprotectedWeb は、ユーザーが特別な操作を行わずにアクセスする一般的なウェブサイトを対象としています。 できます。originTypes を指定しない場合、API はデフォルトで保護されていないデータを削除します。 ウェブオリジン
  • protectedWeb は、ホスト型アプリケーションとしてインストールされているウェブオリジンに対応しています。 たとえば、Angry Birds をインストールすると、配信元 https://chrome.angrybirds.com が保護されます。 unprotectedWeb カテゴリから削除する。削除をトリガーするときは 取得しているものが取り消されないようにユーザーに知らせる ゲームデータを削除します。小さな豚の家を必要以上に頻繁にたたきたがる人はいません。
  • extension は、chrome-extensions: スキームのオリジンに対応します。拡張機能データの削除は ここでも、細心の注意を払う必要があります。

上記の例を変更して、保護されたウェブサイトからデータのみを削除できます。

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo,
  "originTypes": {
    "protectedWeb": true
  }
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

例

この API を試すには、chrome-extension-samples から browsingData API の例をインストールしてください。 できます。

型

DataTypeSet

データ型のセット。欠落しているデータ型は false として解釈されます。

プロパティ

  • appcache

    ブール値（省略可）

    ウェブサイト使用します。

  • キャッシュ

    ブール値（省略可）

    ブラウザのキャッシュ。

  • cacheStorage

    ブール値（省略可）

    Chrome 72 以降

    キャッシュ ストレージ

  • Cookie

    ブール値（省略可）

    ブラウザの Cookie。

  • ダウンロード

    ブール値（省略可）

    ブラウザのダウンロード リスト。

  • fileSystems

    ブール値（省略可）

    ウェブサイトファイル システム。

  • formData

    ブール値（省略可）

    ブラウザに保存されているフォームデータ。

  • 履歴

    ブール値（省略可）

    ブラウザの履歴。

  • indexedDB

    ブール値（省略可）

    ウェブサイトIndexedDB データ。

  • localStorage

    ブール値（省略可）

    ウェブサイトローカル ストレージのデータです。

  • 含まれていた

    ブール値（省略可）

    保存されているパスワード。

  • pluginData

    ブール値（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 88 以降非推奨

    Flash のサポートは終了しました。このデータ型は無視されます。

    プラグイン分析できます

  • serverBoundCertificates

    ブール値（省略可）

    <ph type="x-smartling-placeholder"></ph> Chrome 76 以降非推奨

    サーバーにバインドされた証明書のサポートは終了しました。このデータ型は無視されます。

    サーバーにバインドされた証明書。

  • serviceWorkers

    ブール値（省略可）

    Service Worker

  • webSQL

    ブール値（省略可）

    ウェブサイトWebSQL データ。

RemovalOptions

削除されるデータを正確に決定するためのオプション。

プロパティ

  • excludeOrigins

    文字列 [] 省略可

    Chrome 74 以降

    指定した場合、このリストに含まれるオリジンのデータは削除から除外されます。origins と併用することはできません。Cookie、ストレージ、キャッシュについてのみサポートされます。登録可能なドメイン全体で Cookie が除外されます。

  • originTypes

    オブジェクト（省略可）

    クリアするオリジンのタイプをプロパティに指定しているオブジェクト。このオブジェクトが指定されていない場合は、デフォルトで「保護されていない」もののみがクリアされます。生成します。「ProtectedWeb」を追加する前に本当にアプリケーション データを削除する「広告表示オプション」を使用します。

    • 拡張機能

      ブール値（省略可）

      ユーザーがインストールした拡張機能とパッケージ化アプリケーションです（ご注意ください）。

    • protectedWeb

      ブール値（省略可）

      ホスト型アプリケーションとしてインストールされているウェブサイトです（ご注意ください）。

    • unprotectedWeb

      ブール値（省略可）

      通常のウェブサイト。

  • オリジン

    [string, ...string[]] 省略可

    Chrome 74 以降

    存在する場合は、このリストにあるオリジンのデータのみが削除されます。Cookie、ストレージ、キャッシュについてのみサポートされます。登録可能なドメイン全体の Cookie が消去されます。

  • 開始:

    数値（省略可）

    エポックからのミリ秒単位で表される、この日付以降に蓄積されたデータを削除します（JavaScript の Date オブジェクトの getTime メソッドでアクセスできます）。指定されていない場合、デフォルトの 0 が使用されます（すべての閲覧データが削除されます）。

メソッド

remove()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
  callback?: function,
)

ユーザーのプロフィールに保存されている各種の閲覧データを消去します。

パラメータ

  • オプション

    RemovalOptions

  • dataToRemove

    DataTypeSet

    削除するデータ型のセット。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeAppcache()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeAppcache(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリア使用します。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeCache()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeCache(
  options: RemovalOptions,
  callback?: function,
)

ブラウザのキャッシュをクリアします。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeCacheStorage()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 72 以降 をご覧ください。
chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアキャッシュに保存します

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeCookies()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeCookies(
  options: RemovalOptions,
  callback?: function,
)

特定の期間内に変更されたブラウザの Cookie とサーバーバインド証明書を消去します。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeDownloads()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeDownloads(
  options: RemovalOptions,
  callback?: function,
)

ブラウザのダウンロード ファイルのリストを消去します（ダウンロードされたファイル自体は消去されます）。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeFileSystems()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアファイルシステムデータです。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeFormData()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeFormData(
  options: RemovalOptions,
  callback?: function,
)

ブラウザに保存されているフォームデータ（自動入力）を消去します。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeHistory()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeHistory(
  options: RemovalOptions,
  callback?: function,
)

ブラウザの履歴を消去します。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeIndexedDB()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアIndexedDB データ。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeLocalStorage()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアローカル ストレージのデータです。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removePasswords()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removePasswords(
  options: RemovalOptions,
  callback?: function,
)

ブラウザに保存されているパスワードを消去します。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removePluginData()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 88 以降非推奨
chrome.browsingData.removePluginData(
  options: RemovalOptions,
  callback?: function,
)

Flash のサポートは終了しました。この関数は効果がありません。

プラグインを消去分析できます

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeServiceWorkers()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 72 以降 をご覧ください。
chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアService Worker

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

removeWebSQL()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
  callback?: function,
)

ウェブサイトのデータをクリアWebSQL データ。

パラメータ

  • オプション

    RemovalOptions

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    () => void

戻り値

  • 約束 <void>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。

settings()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.browsingData.settings(
  callback?: function,
)

[閲覧履歴を消去] で現在選択されているデータの種類をレポート設定 UI。注: この API に含まれるデータ型の一部は、設定 UI では利用できません。また、一部の UI 設定では、ここに示す複数のデータ型が制御されます。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: object) => void

    • 件の結果

      オブジェクト

      • dataRemovalPermitted

        DataTypeSet

        結果にはすべてのタイプが含まれ、削除が許可されている場合（エンタープライズ ポリシーなどで）は true、そうでない場合は false の値が設定されます。

      • dataToRemove

        DataTypeSet

        結果にはすべての型が含まれ、両方を選択して削除を許可している場合は true、それ以外の場合は false になります。

      • オプション

        RemovalOptions

戻り値

  • Promise&lt;object&gt;

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、 下位互換性が確保されます同じ関数呼び出しで両方を使用することはできません。「 Promise はコールバックに渡された型と同じ型で解決されます。