Chrome DevTools Protocol

Methods

Storage.clearCookies

Clears cookies.

parameters
browserContextId
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Storage.clearDataForOrigin

Clears storage for origin.

parameters
origin
string

Security origin.

storageTypes
string

Comma separated list of StorageType to clear.

Storage.clearDataForStorageKey

Clears storage for storage key.

parameters
storageKey
string

Storage key.

storageTypes
string

Comma separated list of StorageType to clear.

Storage.getCookies

Returns all browser cookies.

parameters
browserContextId
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Return Object
cookies
array[ Network.Cookie ]

Array of cookie objects.

Storage.getStorageKeyForFrame

Returns a storage key given a frame id.

parameters
frameId
Page.FrameId
Return Object
storageKey
SerializedStorageKey

Storage.getUsageAndQuota

Returns usage and quota in bytes.

parameters
origin
string

Security origin.

Return Object
usage
number

Storage usage (bytes).

quota
number

Storage quota (bytes).

overrideActive
boolean

Whether or not the origin has an active storage quota override

usageBreakdown
array[ UsageForType ]

Storage usage per type (bytes).

Storage.setCookies

Sets given cookies.

parameters
cookies
array[ Network.CookieParam ]

Cookies to be set.

browserContextId
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Storage.trackCacheStorageForOrigin

Registers origin to be notified when an update occurs to its cache storage list.

parameters
origin
string

Security origin.

Storage.trackCacheStorageForStorageKey

Registers storage key to be notified when an update occurs to its cache storage list.

parameters
storageKey
string

Storage key.

Storage.trackIndexedDBForOrigin

Registers origin to be notified when an update occurs to its IndexedDB.

parameters
origin
string

Security origin.

Storage.trackIndexedDBForStorageKey

Registers storage key to be notified when an update occurs to its IndexedDB.

parameters
storageKey
string

Storage key.

Storage.untrackCacheStorageForOrigin

Unregisters origin from receiving notifications for cache storage.

parameters
origin
string

Security origin.

Storage.untrackCacheStorageForStorageKey

Unregisters storage key from receiving notifications for cache storage.

parameters
storageKey
string

Storage key.

Storage.untrackIndexedDBForOrigin

Unregisters origin from receiving notifications for IndexedDB.

parameters
origin
string

Security origin.

Storage.untrackIndexedDBForStorageKey

Unregisters storage key from receiving notifications for IndexedDB.

parameters
storageKey
string

Storage key.

Storage.clearSharedStorageEntries Experimental

Clears all entries for a given origin's shared storage.

parameters
ownerOrigin
string

Storage.clearTrustTokens Experimental

Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.

parameters
issuerOrigin
string
Return Object
didDeleteTokens
boolean

True if any tokens were deleted, false otherwise.

Storage.deleteSharedStorageEntry Experimental

Deletes entry for key (if it exists) for a given origin's shared storage.

parameters
ownerOrigin
string
key
string

Storage.deleteStorageBucket Experimental

Deletes the Storage Bucket with the given storage key and bucket name.

parameters
bucket
StorageBucket

Storage.getInterestGroupDetails Experimental

Gets details for a named interest group.

parameters
ownerOrigin
string
name
string
Return Object
details
InterestGroupDetails

Storage.getSharedStorageEntries Experimental

Gets the entries in an given origin's shared storage.

parameters
ownerOrigin
string
Return Object
entries
array[ SharedStorageEntry ]

Storage.getSharedStorageMetadata Experimental

Gets metadata for an origin's shared storage.

parameters
ownerOrigin
string
Return Object
metadata
SharedStorageMetadata

Storage.getTrustTokens Experimental

Returns the number of stored Trust Tokens per issuer for the current browsing context.

Return Object
tokens
array[ TrustTokens ]

Storage.overrideQuotaForOrigin Experimental

Override quota for the specified origin

parameters
origin
string

Security origin.

quotaSize
number

The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).

Storage.resetSharedStorageBudget Experimental

Resets the budget for ownerOrigin by clearing all budget withdrawals.

parameters
ownerOrigin
string

Storage.runBounceTrackingMitigations Experimental

Deletes state for sites identified as potential bounce trackers, immediately.

Return Object
deletedSites
array[ string ]

Storage.setAttributionReportingLocalTestingMode Experimental

https://wicg.github.io/attribution-reporting-api/

parameters
enabled
boolean

If enabled, noise is suppressed and reports are sent immediately.

Storage.setAttributionReportingTracking Experimental

Enables/disables issuing of Attribution Reporting events.

parameters
enable
boolean

Storage.setInterestGroupTracking Experimental

Enables/Disables issuing of interestGroupAccessed events.

parameters
enable
boolean

Storage.setSharedStorageEntry Experimental

Sets entry with key and value for a given origin's shared storage.

parameters
ownerOrigin
string
key
string
value
string
ignoreIfPresent
boolean

If ignoreIfPresent is included and true, then only sets the entry if key doesn't already exist.

Storage.setSharedStorageTracking Experimental

Enables/disables issuing of sharedStorageAccessed events.

parameters
enable
boolean

Storage.setStorageBucketTracking Experimental

Set tracking for a storage key's buckets.

parameters
storageKey
string
enable
boolean

Events

Storage.cacheStorageContentUpdated

A cache's contents have been modified.

parameters
origin
string

Origin to update.

storageKey
string

Storage key to update.

bucketId
string

Storage bucket to update.

cacheName
string

Name of cache in origin.

Storage.cacheStorageListUpdated

A cache has been added/deleted.

parameters
origin
string

Origin to update.

storageKey
string

Storage key to update.

bucketId
string

Storage bucket to update.

Storage.indexedDBContentUpdated

The origin's IndexedDB object store has been modified.

parameters
origin
string

Origin to update.

storageKey
string

Storage key to update.

bucketId
string

Storage bucket to update.

databaseName
string

Database to update.

objectStoreName
string

ObjectStore to update.

Storage.indexedDBListUpdated

The origin's IndexedDB database list has been modified.

parameters
origin
string

Origin to update.

storageKey
string

Storage key to update.

bucketId
string

Storage bucket to update.

Storage.interestGroupAccessed

One of the interest groups was accessed by the associated page.

parameters
accessTime
Network.TimeSinceEpoch
type
InterestGroupAccessType
ownerOrigin
string
name
string

Storage.sharedStorageAccessed

Shared storage was accessed by the associated page. The following parameters are included in all events.

parameters
accessTime
Network.TimeSinceEpoch

Time of the access.

type
SharedStorageAccessType

Enum value indicating the Shared Storage API method invoked.

mainFrameId
Page.FrameId

DevTools Frame Token for the primary frame tree's root.

ownerOrigin
string

Serialized origin for the context that invoked the Shared Storage API.

params
SharedStorageAccessParams

The sub-parameters warapped by params are all optional and their presence/absence depends on type.

Storage.storageBucketCreatedOrUpdated

parameters
bucketInfo
StorageBucketInfo

Storage.storageBucketDeleted

parameters
bucketId
string

Storage.attributionReportingSourceRegistered Experimental

TODO(crbug.com/1458532): Add other Attribution Reporting events, e.g. trigger registration.

parameters
registration
AttributionReportingSourceRegistration
result
AttributionReportingSourceRegistrationResult

Types

Storage.InterestGroupAccessType

Enum of interest group access types.

Allowed Values: join, leave, update, loaded, bid, win, additionalBid, additionalBidWin, clear

Type: string

Storage.InterestGroupAd

Ad advertising element inside an interest group.

Type: object

properties
renderURL
string
metadata
string

Storage.InterestGroupDetails

The full details of an interest group.

Type: object

properties
ownerOrigin
string
name
string
expirationTime
Network.TimeSinceEpoch
joiningOrigin
string
biddingLogicURL
string
biddingWasmHelperURL
string
updateURL
string
trustedBiddingSignalsURL
string
trustedBiddingSignalsKeys
array[ string ]
userBiddingSignals
string
ads
array[ InterestGroupAd ]
adComponents
array[ InterestGroupAd ]

Storage.SerializedStorageKey

Type: string

Storage.SharedStorageAccessParams

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

Type: object

properties
scriptSourceUrl
string

Spec of the module script URL. Present only for SharedStorageAccessType.documentAddModule.

operationName
string

Name of the registered operation to be run. Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

serializedData
string

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

urlsWithMetadata
array[ SharedStorageUrlWithMetadata ]

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessType.documentSelectURL.

key
string

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.documentDelete, SharedStorageAccessType.workletSet, SharedStorageAccessType.workletAppend, SharedStorageAccessType.workletDelete, and SharedStorageAccessType.workletGet.

value
string

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.workletSet, and SharedStorageAccessType.workletAppend.

ignoreIfPresent
boolean

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessType.documentSet and SharedStorageAccessType.workletSet.

Storage.SharedStorageAccessType

Enum of shared storage access types.

Allowed Values: documentAddModule, documentSelectURL, documentRun, documentSet, documentAppend, documentDelete, documentClear, workletSet, workletAppend, workletDelete, workletClear, workletGet, workletKeys, workletEntries, workletLength, workletRemainingBudget

Type: string

Storage.SharedStorageEntry

Struct for a single key-value pair in an origin's shared storage.

Type: object

properties
key
string
value
string

Storage.SharedStorageMetadata

Details for an origin's shared storage.

Type: object

properties
creationTime
Network.TimeSinceEpoch
length
integer
remainingBudget
number

Storage.SharedStorageReportingMetadata

Pair of reporting metadata details for a candidate URL for selectURL().

Type: object

properties
eventType
string
reportingUrl
string

Storage.SharedStorageUrlWithMetadata

Bundles a candidate URL with its reporting metadata.

Type: object

properties
url
string

Spec of candidate URL.

reportingMetadata
array[ SharedStorageReportingMetadata ]

Any associated reporting metadata.

Storage.StorageBucket

Type: object

properties
storageKey
SerializedStorageKey
name
string

If not specified, it is the default bucket of the storageKey.

Storage.StorageBucketInfo

Type: object

properties
bucket
StorageBucket
id
string
expiration
Network.TimeSinceEpoch
quota
number

Storage quota (bytes).

persistent
boolean
durability
StorageBucketsDurability

Storage.StorageBucketsDurability

Allowed Values: relaxed, strict

Type: string

Storage.StorageType

Enum of possible storage types.

Allowed Values: appcache, cookies, file_systems, indexeddb, local_storage, shader_cache, websql, service_workers, cache_storage, interest_groups, shared_storage, storage_buckets, all, other

Type: string

Storage.UsageForType

Usage for a storage type.

Type: object

properties
storageType
StorageType

Name of storage type.

usage
number

Storage usage (bytes).

Storage.AttributionReportingAggregationKeysEntry Experimental

Type: object

properties
key
string
value
UnsignedInt128AsBase16

Storage.AttributionReportingEventReportWindows Experimental

Type: object

properties
start
integer

duration in seconds

ends
array[ integer ]

duration in seconds

Storage.AttributionReportingFilterDataEntry Experimental

Type: object

properties
key
string
values
array[ string ]

Storage.AttributionReportingSourceRegistration Experimental

Type: object

properties
time
Network.TimeSinceEpoch
expiry
integer

duration in seconds

triggerSpecs
array[ AttributionReportingTriggerSpec ]
aggregatableReportWindow
integer

duration in seconds

type
AttributionReportingSourceType
sourceOrigin
string
reportingOrigin
string
destinationSites
array[ string ]
eventId
UnsignedInt64AsBase10
priority
SignedInt64AsBase10
filterData
array[ AttributionReportingFilterDataEntry ]
aggregationKeys
array[ AttributionReportingAggregationKeysEntry ]
debugKey
UnsignedInt64AsBase10
triggerDataMatching
AttributionReportingTriggerDataMatching

Storage.AttributionReportingSourceRegistrationResult Experimental

Allowed Values: success, internalError, insufficientSourceCapacity, insufficientUniqueDestinationCapacity, excessiveReportingOrigins, prohibitedByBrowserPolicy, successNoised, destinationReportingLimitReached, destinationGlobalLimitReached, destinationBothLimitsReached, reportingOriginsPerSiteLimitReached, exceedsMaxChannelCapacity

Type: string

Storage.AttributionReportingSourceType Experimental

Allowed Values: navigation, event

Type: string

Storage.AttributionReportingTriggerDataMatching Experimental

Allowed Values: exact, modulus

Type: string

Storage.AttributionReportingTriggerSpec Experimental

Type: object

properties
triggerData
array[ number ]

number instead of integer because not all uint32 can be represented by int

eventReportWindows
AttributionReportingEventReportWindows

Storage.SignedInt64AsBase10 Experimental

Type: string

Storage.TrustTokens Experimental

Pair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.

Type: object

properties
issuerOrigin
string
count
number

Storage.UnsignedInt128AsBase16 Experimental

Type: string

Storage.UnsignedInt64AsBase10 Experimental

Type: string