Chrome DevTools

Storage Domain

Experimental

Methods

Events

Types

Methods

Chrome DevTools

Storage.clearCookies #

Clears cookies.

Parameters

browserContextId
Optional
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Chrome DevTools

Storage.clearDataForOrigin #

Clears storage for origin.

Parameters

origin
string

Security origin.

storageTypes
string

Comma separated list of StorageType to clear.

Chrome DevTools

Storage.clearDataForStorageKey #

Clears storage for storage key.

Parameters

storageKey
string

Storage key.

storageTypes
string

Comma separated list of StorageType to clear.

Chrome DevTools

Storage.getCookies #

Returns all browser cookies.

Parameters

browserContextId
Optional
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Return object

cookies
array[ Network.Cookie ]

Array of cookie objects.

Chrome DevTools

Storage.getStorageKeyForFrame #

Returns a storage key given a frame id.

Parameters

frameId
Page.FrameId

Return object

storageKey
SerializedStorageKey
Chrome DevTools

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).

Chrome DevTools

Storage.setCookies #

Sets given cookies.

Parameters

cookies
array[ Network.CookieParam ]

Cookies to be set.

browserContextId
Optional
Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Chrome DevTools

Storage.trackCacheStorageForOrigin #

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

Parameters

origin
string

Security origin.

Chrome DevTools

Storage.trackCacheStorageForStorageKey #

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

Parameters

storageKey
string

Storage key.

Chrome DevTools

Storage.trackIndexedDBForOrigin #

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

Parameters

origin
string

Security origin.

Chrome DevTools

Storage.trackIndexedDBForStorageKey #

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

Parameters

storageKey
string

Storage key.

Chrome DevTools

Storage.untrackCacheStorageForOrigin #

Unregisters origin from receiving notifications for cache storage.

Parameters

origin
string

Security origin.

Chrome DevTools

Storage.untrackCacheStorageForStorageKey #

Unregisters storage key from receiving notifications for cache storage.

Parameters

storageKey
string

Storage key.

Chrome DevTools

Storage.untrackIndexedDBForOrigin #

Unregisters origin from receiving notifications for IndexedDB.

Parameters

origin
string

Security origin.

Chrome DevTools

Storage.untrackIndexedDBForStorageKey #

Unregisters storage key from receiving notifications for IndexedDB.

Parameters

storageKey
string

Storage key.

Chrome DevTools

Storage.clearSharedStorageEntries Experimental#

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

Parameters

ownerOrigin
string
Chrome DevTools

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.

Chrome DevTools

Storage.deleteSharedStorageEntry Experimental#

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

Parameters

ownerOrigin
string
key
string
Chrome DevTools

Storage.deleteStorageBucket Experimental#

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

Parameters

bucket
StorageBucket
Chrome DevTools

Storage.getInterestGroupDetails Experimental#

Gets details for a named interest group.

Parameters

ownerOrigin
string
name
string

Return object

details
object

This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin.

Chrome DevTools

Storage.getRelatedWebsiteSets Experimental#

Returns the effective Related Website Sets in use by this profile for the browser session. The effective Related Website Sets will not change during a browser session.

Return object

sets
array[ RelatedWebsiteSet ]
Chrome DevTools

Storage.getSharedStorageEntries Experimental#

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

Parameters

ownerOrigin
string

Return object

entries
array[ SharedStorageEntry ]
Chrome DevTools

Storage.getSharedStorageMetadata Experimental#

Gets metadata for an origin's shared storage.

Parameters

ownerOrigin
string

Return object

metadata
SharedStorageMetadata
Chrome DevTools

Storage.getTrustTokens Experimental#

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

Return object

tokens
array[ TrustTokens ]
Chrome DevTools

Storage.overrideQuotaForOrigin Experimental#

Override quota for the specified origin

Parameters

origin
string

Security origin.

quotaSize
Optional
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).

Chrome DevTools

Storage.resetSharedStorageBudget Experimental#

Resets the budget for ownerOrigin by clearing all budget withdrawals.

Parameters

ownerOrigin
string
Chrome DevTools

Storage.runBounceTrackingMitigations Experimental#

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

Return object

deletedSites
array[ string ]
Chrome DevTools

Storage.sendPendingAttributionReports Experimental#

Sends all pending Attribution Reports immediately, regardless of their scheduled report time.

Return object

numSent
integer

The number of reports that were sent.

Chrome DevTools

Storage.setAttributionReportingLocalTestingMode Experimental#

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

Parameters

enabled
boolean

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

Chrome DevTools

Storage.setAttributionReportingTracking Experimental#

Enables/disables issuing of Attribution Reporting events.

Parameters

enable
boolean
Chrome DevTools

Storage.setInterestGroupAuctionTracking Experimental#

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

Parameters

enable
boolean
Chrome DevTools

Storage.setInterestGroupTracking Experimental#

Enables/Disables issuing of interestGroupAccessed events.

Parameters

enable
boolean
Chrome DevTools

Storage.setSharedStorageEntry Experimental#

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

Parameters

ownerOrigin
string
key
string
value
string
ignoreIfPresent
Optional
boolean

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

Chrome DevTools

Storage.setSharedStorageTracking Experimental#

Enables/disables issuing of sharedStorageAccessed events.

Parameters

enable
boolean
Chrome DevTools

Storage.setStorageBucketTracking Experimental#

Set tracking for a storage key's buckets.

Parameters

storageKey
string
enable
boolean

Events

Chrome DevTools

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.

Chrome DevTools

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.

Chrome DevTools

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.

Chrome DevTools

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.

Chrome DevTools

Storage.interestGroupAccessed #

One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.

Parameters

accessTime
Network.TimeSinceEpoch
type
InterestGroupAccessType
ownerOrigin
string
name
string
componentSellerOrigin
Optional
string

For topLevelBid/topLevelAdditionalBid, and when appropriate, win and additionalBidWin

bid
Optional
number

For bid or somethingBid event, if done locally and not on a server.

bidCurrency
Optional
string
uniqueAuctionId
Optional
InterestGroupAuctionId

For non-global events --- links to interestGroupAuctionEvent

Chrome DevTools

Storage.interestGroupAuctionEventOccurred #

An auction involving interest groups is taking place. These events are target-specific.

Parameters

eventTime
Network.TimeSinceEpoch
type
InterestGroupAuctionEventType
uniqueAuctionId
InterestGroupAuctionId
parentAuctionId
Optional
InterestGroupAuctionId

Set for child auctions.

auctionConfig
Optional
object

Set for started and configResolved

Chrome DevTools

Storage.interestGroupAuctionNetworkRequestCreated #

Specifies which auctions a particular network fetch may be related to, and in what role. Note that it is not ordered with respect to Network.requestWillBeSent (but will happen before loadingFinished loadingFailed).

Parameters

type
InterestGroupAuctionFetchType
requestId
Network.RequestId
auctions
array[ InterestGroupAuctionId ]

This is the set of the auctions using the worklet that issued this request. In the case of trusted signals, it's possible that only some of them actually care about the keys being queried.

Chrome DevTools

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 wrapped by params are all optional and their presence/absence depends on type.

Chrome DevTools

Storage.storageBucketCreatedOrUpdated #

Parameters

bucketInfo
StorageBucketInfo
Chrome DevTools

Storage.storageBucketDeleted #

Parameters

bucketId
string
Chrome DevTools

Storage.attributionReportingSourceRegistered Experimental#

Parameters

registration
AttributionReportingSourceRegistration
result
AttributionReportingSourceRegistrationResult
Chrome DevTools

Storage.attributionReportingTriggerRegistered Experimental#

Parameters

registration
AttributionReportingTriggerRegistration
eventLevel
AttributionReportingEventLevelResult
aggregatable
AttributionReportingAggregatableResult

Types

Chrome DevTools

Storage.InterestGroupAccessType #

Enum of interest group access types.

Type: string

Allowed values: join, leave, update, loaded, bid, win, additionalBid, additionalBidWin, topLevelBid, topLevelAdditionalBid, clear

Chrome DevTools

Storage.InterestGroupAuctionEventType #

Enum of auction events.

Type: string

Allowed values: started, configResolved

Chrome DevTools

Storage.InterestGroupAuctionFetchType #

Enum of network fetches auctions can do.

Type: string

Allowed values: bidderJs, bidderWasm, sellerJs, bidderTrustedSignals, sellerTrustedSignals

Chrome DevTools

Storage.InterestGroupAuctionId #

Protected audience interest group auction identifier.

Type: string

Chrome DevTools

Storage.SerializedStorageKey #

Type: string

Chrome DevTools

Storage.SharedStorageAccessParams #

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

Type: object

Properties

scriptSourceUrl
Optional
string

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

operationName
Optional
string

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

serializedData
Optional
string

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

urlsWithMetadata
Optional
array[ SharedStorageUrlWithMetadata ]

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

key
Optional
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, SharedStorageAccessType.workletGet, SharedStorageAccessType.headerSet, SharedStorageAccessType.headerAppend, and SharedStorageAccessType.headerDelete.

value
Optional
string

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

ignoreIfPresent
Optional
boolean

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

Chrome DevTools

Storage.SharedStorageAccessType #

Enum of shared storage access types.

Type: string

Allowed values: documentAddModule, documentSelectURL, documentRun, documentSet, documentAppend, documentDelete, documentClear, documentGet, workletSet, workletAppend, workletDelete, workletClear, workletGet, workletKeys, workletEntries, workletLength, workletRemainingBudget, headerSet, headerAppend, headerDelete, headerClear

Chrome DevTools

Storage.SharedStorageEntry #

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

Type: object

Properties

key
string
value
string
Chrome DevTools

Storage.SharedStorageMetadata #

Details for an origin's shared storage.

Type: object

Properties

creationTime
Network.TimeSinceEpoch

Time when the origin's shared storage was last created.

length
integer

Number of key-value pairs stored in origin's shared storage.

remainingBudget
number

Current amount of bits of entropy remaining in the navigation budget.

bytesUsed
integer

Total number of bytes stored as key-value pairs in origin's shared storage.

Chrome DevTools

Storage.SharedStorageReportingMetadata #

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

Type: object

Properties

eventType
string
reportingUrl
string
Chrome DevTools

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.

Chrome DevTools

Storage.StorageBucket #

Type: object

Properties

storageKey
SerializedStorageKey
name
Optional
string

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

Chrome DevTools

Storage.StorageBucketInfo #

Type: object

Properties

bucket
StorageBucket
id
string
expiration
Network.TimeSinceEpoch
quota
number

Storage quota (bytes).

persistent
boolean
durability
StorageBucketsDurability
Chrome DevTools

Storage.StorageBucketsDurability #

Type: string

Allowed values: relaxed, strict

Chrome DevTools

Storage.StorageType #

Enum of possible storage types.

Type: string

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

Chrome DevTools

Storage.UsageForType #

Usage for a storage type.

Type: object

Properties

storageType
StorageType

Name of storage type.

usage
number

Storage usage (bytes).

Chrome DevTools

Storage.AttributionReportingAggregatableDedupKey Experimental#

Type: object

Properties

dedupKey
Optional
UnsignedInt64AsBase10
filters
AttributionReportingFilterPair
Chrome DevTools

Storage.AttributionReportingAggregatableResult Experimental#

Type: string

Allowed values: success, internalError, noCapacityForAttributionDestination, noMatchingSources, excessiveAttributions, excessiveReportingOrigins, noHistograms, insufficientBudget, noMatchingSourceFilterData, notRegistered, prohibitedByBrowserPolicy, deduplicated, reportWindowPassed, excessiveReports

Chrome DevTools

Storage.AttributionReportingAggregatableTriggerData Experimental#

Type: object

Properties

keyPiece
UnsignedInt128AsBase16
sourceKeys
array[ string ]
filters
AttributionReportingFilterPair
Chrome DevTools

Storage.AttributionReportingAggregatableValueDictEntry Experimental#

Type: object

Properties

key
string
value
number

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

Chrome DevTools

Storage.AttributionReportingAggregatableValueEntry Experimental#

Type: object

Properties

values
array[ AttributionReportingAggregatableValueDictEntry ]
filters
AttributionReportingFilterPair
Chrome DevTools

Storage.AttributionReportingAggregationKeysEntry Experimental#

Type: object

Properties

key
string
value
UnsignedInt128AsBase16
Chrome DevTools

Storage.AttributionReportingEventLevelResult Experimental#

Type: string

Allowed values: success, successDroppedLowerPriority, internalError, noCapacityForAttributionDestination, noMatchingSources, deduplicated, excessiveAttributions, priorityTooLow, neverAttributedSource, excessiveReportingOrigins, noMatchingSourceFilterData, prohibitedByBrowserPolicy, noMatchingConfigurations, excessiveReports, falselyAttributedSource, reportWindowPassed, notRegistered, reportWindowNotStarted, noMatchingTriggerData

Chrome DevTools

Storage.AttributionReportingEventReportWindows Experimental#

Type: object

Properties

start
integer

duration in seconds

ends
array[ integer ]

duration in seconds

Chrome DevTools

Storage.AttributionReportingEventTriggerData Experimental#

Type: object

Properties

data
UnsignedInt64AsBase10
priority
SignedInt64AsBase10
dedupKey
Optional
UnsignedInt64AsBase10
filters
AttributionReportingFilterPair
Chrome DevTools

Storage.AttributionReportingFilterConfig Experimental#

Type: object

Properties

filterValues
array[ AttributionReportingFilterDataEntry ]
lookbackWindow
Optional
integer

duration in seconds

Chrome DevTools

Storage.AttributionReportingFilterDataEntry Experimental#

Type: object

Properties

key
string
values
array[ string ]
Chrome DevTools

Storage.AttributionReportingFilterPair Experimental#

Type: object

Properties

filters
array[ AttributionReportingFilterConfig ]
notFilters
array[ AttributionReportingFilterConfig ]
Chrome DevTools

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
Optional
UnsignedInt64AsBase10
triggerDataMatching
AttributionReportingTriggerDataMatching
Chrome DevTools

Storage.AttributionReportingSourceRegistrationResult Experimental#

Type: string

Allowed values: success, internalError, insufficientSourceCapacity, insufficientUniqueDestinationCapacity, excessiveReportingOrigins, prohibitedByBrowserPolicy, successNoised, destinationReportingLimitReached, destinationGlobalLimitReached, destinationBothLimitsReached, reportingOriginsPerSiteLimitReached, exceedsMaxChannelCapacity, exceedsMaxTriggerStateCardinality, destinationPerDayReportingLimitReached

Chrome DevTools

Storage.AttributionReportingSourceRegistrationTimeConfig Experimental#

Type: string

Allowed values: include, exclude

Chrome DevTools

Storage.AttributionReportingSourceType Experimental#

Type: string

Allowed values: navigation, event

Chrome DevTools

Storage.AttributionReportingTriggerDataMatching Experimental#

Type: string

Allowed values: exact, modulus

Chrome DevTools

Storage.AttributionReportingTriggerRegistration Experimental#

Type: object

Properties

filters
AttributionReportingFilterPair
debugKey
Optional
UnsignedInt64AsBase10
aggregatableDedupKeys
array[ AttributionReportingAggregatableDedupKey ]
eventTriggerData
array[ AttributionReportingEventTriggerData ]
aggregatableTriggerData
array[ AttributionReportingAggregatableTriggerData ]
aggregatableValues
array[ AttributionReportingAggregatableValueEntry ]
debugReporting
boolean
aggregationCoordinatorOrigin
Optional
string
sourceRegistrationTimeConfig
AttributionReportingSourceRegistrationTimeConfig
triggerContextId
Optional
string
Chrome DevTools

Storage.AttributionReportingTriggerSpec Experimental#

Type: object

Properties

triggerData
array[ number ]

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

eventReportWindows
AttributionReportingEventReportWindows
Chrome DevTools

Storage.RelatedWebsiteSet Experimental#

A single Related Website Set object.

Type: object

Properties

primarySites
array[ string ]

The primary site of this set, along with the ccTLDs if there is any.

associatedSites
array[ string ]

The associated sites of this set, along with the ccTLDs if there is any.

serviceSites
array[ string ]

The service sites of this set, along with the ccTLDs if there is any.

Chrome DevTools

Storage.SignedInt64AsBase10 Experimental#

Type: string

Chrome DevTools

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
Chrome DevTools

Storage.UnsignedInt128AsBase16 Experimental#

Type: string

Chrome DevTools

Storage.UnsignedInt64AsBase10 Experimental#

Type: string