このページは大阪弁化フィルタによって翻訳生成されたんですわ。

翻訳前ページへ


chrome.browsingData - Google Chrome
The Wayback Machine - http://web.archive.org/web/20130824120929/http://developer.chrome.com/extensions/browsingData.html

chrome.browsingData

Description: Use the chrome.browsingData API to remove browsing data from a user's local profile.
Availability: Stable since Chrome 19.
Permissions: "browsingData"

Manifest

You must declare the "browsingData" permission in the extension manifest to use this API.

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

Usage

The simplest use-case for this API is a a time-based mechanism for clearing a user's browsing data. Your code should provide a timestamp which indicates the historical date after which the user's browsing data should be removed. This timestamp is formatted as the number of milliseconds since the Unix epoch (which can be retrieved from a JavaScript Date object via the getTime method).

For example, to clear all of a user's browsing data from the last week, you might write code as follows:

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,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "pluginData": true,
  "passwords": true,
  "webSQL": true
}, callback);

The chrome.browsingData.remove method allows you to remove various types of browsing data with a single call, and will be much faster than calling multiple more specific methods. If, however, you only want to clear one specific type of browsing data (cookies, for example), the more granular methods offer a readable alternative to a call filled with 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);

Important: Removing browsing data involves a good deal of heavy lifting in the background, and can take tens of seconds to complete, depending on a user's profile. You should use the callback mechanism to keep your users up to date on the removal's status.

Origin Types

Adding an originTypes property to the API's options object allows you to specify which types of origins ought to be effected. Currently, origins are divided into three categories:

We could adjust the previous example to remove only data from protected websites as follows:

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,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "serverBoundCertificates": true,
  "pluginData": true,
  "passwords": true,
  "webSQL": true
}, callback);

Seriously: Be careful with protectedWeb and extension. These are destructive operations that your users will write angry email about if they're not well-informed about what to expect when your extension removes data on their behalf.

Examples

Samples for the browsingData API are available on the samples page.

chrome.browsingData reference

Types

RemovalOptions

Options that determine exactly what data will be removed.

properties of RemovalOptions

since ( optional double )
Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the getTime method of the JavaScript Date object). If absent, defaults to 0 (which would remove all browsing data).
originTypes ( optional object )
An object whose properties specify which origin types ought to be cleared. If this object isn't specified, it defaults to clearing only "unprotected" origins. Please ensure that you really want to remove application data before adding 'protectedWeb' or 'extensions'.
unprotectedWeb ( optional boolean )
Normal websites.
protectedWeb ( optional boolean )
Websites that have been installed as hosted applications (be careful!).
extension ( optional boolean )
Extensions and packaged applications a user has installed (be _really_ careful!).

DataTypeSet

A set of data types. Missing data types are interpreted as false.

properties of DataTypeSet

appcache ( optional boolean )
Websites' appcaches.
cache ( optional boolean )
The browser's cache. Note: when removing data, this clears the entire cache: it is not limited to the range you specify.
cookies ( optional boolean )
The browser's cookies.
downloads ( optional boolean )
The browser's download list.
fileSystems ( optional boolean )
Websites' file systems.
formData ( optional boolean )
The browser's stored form data.
history ( optional boolean )
The browser's history.
indexedDB ( optional boolean )
Websites' IndexedDB data.
localStorage ( optional boolean )
Websites' local storage data.
serverBoundCertificates ( optional boolean )
Server-bound certificates.
pluginData ( optional boolean )
Plugins' data.
passwords ( optional boolean )
Stored passwords.
webSQL ( optional boolean )
Websites' WebSQL data.

Methods

settings

chrome.browsingData.settings(function callback)

Reports which types of data are currently selected in the 'Clear browsing data' settings UI. Note: some of the data types included in this API are not available in the settings UI, and some UI settings control more than one data type listed here.

Parameters

callback ( function )

Callback

The callback parameter should specify a function that looks like this:

function(object result) {...};
result ( object )
options ( RemovalOptions )
dataToRemove ( DataTypeSet )
All of the types will be present in the result, with values of true if they are both selected to be removed and permitted to be removed, otherwise false.
dataRemovalPermitted ( DataTypeSet )
All of the types will be present in the result, with values of true if they are permitted to be removed (e.g., by enterprise policy) and false if not.

remove

chrome.browsingData.remove(RemovalOptions options, DataTypeSet dataToRemove, function callback)

Clears various types of browsing data stored in a user's profile.

Parameters

options ( RemovalOptions )
dataToRemove ( DataTypeSet )
The set of data types to remove.
callback ( optional function )
Called when deletion has completed.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeAppcache

chrome.browsingData.removeAppcache(RemovalOptions options, function callback)

Clears websites' appcache data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when websites' appcache data has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeCache

chrome.browsingData.removeCache(RemovalOptions options, function callback)

Clears the browser's cache.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's cache has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeCookies

chrome.browsingData.removeCookies(RemovalOptions options, function callback)

Clears the browser's cookies and server-bound certificates modified within a particular timeframe.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's cookies and server-bound certificates have been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeDownloads

chrome.browsingData.removeDownloads(RemovalOptions options, function callback)

Clears the browser's list of downloaded files (not the downloaded files themselves).

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's list of downloaded files has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeFileSystems

chrome.browsingData.removeFileSystems(RemovalOptions options, function callback)

Clears websites' file system data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when websites' file systems have been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeFormData

chrome.browsingData.removeFormData(RemovalOptions options, function callback)

Clears the browser's stored form data (autofill).

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's form data has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeHistory

chrome.browsingData.removeHistory(RemovalOptions options, function callback)

Clears the browser's history.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's history has cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeIndexedDB

chrome.browsingData.removeIndexedDB(RemovalOptions options, function callback)

Clears websites' IndexedDB data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when websites' IndexedDB data has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeLocalStorage

chrome.browsingData.removeLocalStorage(RemovalOptions options, function callback)

Clears websites' local storage data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when websites' local storage has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removePluginData

chrome.browsingData.removePluginData(RemovalOptions options, function callback)

Clears plugins' data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when plugins' data has been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removePasswords

chrome.browsingData.removePasswords(RemovalOptions options, function callback)

Clears the browser's stored passwords.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when the browser's passwords have been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

removeWebSQL

chrome.browsingData.removeWebSQL(RemovalOptions options, function callback)

Clears websites' WebSQL data.

Parameters

options ( RemovalOptions )
callback ( optional function )
Called when websites' WebSQL databases have been cleared.

Callback

If you specify the callback parameter, it should specify a function that looks like this:

function() {...};

Sample Extensions that use chrome.browsingData

  • BrowsingData API: Basics – A trivial usage example.