React Native CDP Status

Storage Domain

Experimental

Methods

Storage.clearCookies #

Clears cookies.

Parameters

browserContextId
Optional

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
Optional

Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Return object

cookies

array[ Network.Cookie ]

Array of cookie objects.

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
Optional

Browser.BrowserContextID

Browser context to use when called on the browser endpoint.

Storage.setProtectedAudienceKAnonymity #

Parameters

owner

string

name

string

hashes

array[ string ]

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.getStorageKeyForFrame Deprecated#

Returns a storage key given a frame id. Deprecated. Please use Storage.getStorageKey instead.

Parameters

frameId

Page.FrameId

Return object

storageKey

SerializedStorageKey

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

object

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

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 ]

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.getStorageKey Experimental#

Returns storage key for the given frame. If no frame ID is provided, the storage key of the target executing this command is returned.

Parameters

frameId
Optional

Page.FrameId

Return object

storageKey

SerializedStorageKey

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

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.setInterestGroupAuctionTracking Experimental#

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

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
Optional

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

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

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.

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.

scope

SharedStorageAccessScope

Enum value indicating the access scope.

method

SharedStorageAccessMethod

Enum value indicating the Shared Storage API method invoked.

mainFrameId

Page.FrameId

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

ownerOrigin

string

Serialization of the origin owning the Shared Storage data.

ownerSite

string

Serialization of the site owning the Shared Storage data.

params

SharedStorageAccessParams

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

Storage.sharedStorageWorkletOperationExecutionFinished #

A shared storage run or selectURL operation finished its execution. The following parameters are included in all events.

Parameters

finishedTime

Network.TimeSinceEpoch

Time that the operation finished.

executionTime

integer

Time, in microseconds, from start of shared storage JS API call until end of operation execution in the worklet.

method

SharedStorageAccessMethod

Enum value indicating the Shared Storage API method invoked.

operationId

string

ID of the operation call.

workletTargetId

Target.TargetID

Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet.

mainFrameId

Page.FrameId

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

ownerOrigin

string

Serialization of the origin owning the Shared Storage data.

Storage.storageBucketCreatedOrUpdated #

Parameters

bucketInfo

StorageBucketInfo

Storage.storageBucketDeleted #

Parameters

bucketId

string

Types

Storage.InterestGroupAccessType #

Enum of interest group access types.

Type: string

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

Storage.InterestGroupAuctionEventType #

Enum of auction events.

Type: string

Allowed values: started, configResolved

Storage.InterestGroupAuctionFetchType #

Enum of network fetches auctions can do.

Type: string

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

Storage.InterestGroupAuctionId #

Protected audience interest group auction identifier.

Type: string

Storage.SerializedStorageKey #

Type: string

Storage.SharedStorageAccessMethod #

Enum of shared storage access methods.

Type: string

Allowed values: addModule, createWorklet, selectURL, run, batchUpdate, set, append, delete, clear, get, keys, values, entries, length, remainingBudget

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 SharedStorageAccessMethods: addModule and createWorklet.

dataOrigin
Optional

string

String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet.

operationName
Optional

string

Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.

operationId
Optional

string

ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.

keepAlive
Optional

boolean

Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.

privateAggregationConfig
Optional

SharedStoragePrivateAggregationConfig

Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.

serializedData
Optional

string

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessMethods: run and selectURL. TODO(crbug.com/401011862): Consider updating this parameter to binary.

urlsWithMetadata
Optional

array[ SharedStorageUrlWithMetadata ]

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.

urnUuid
Optional

string

Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.

key
Optional

string

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.

value
Optional

string

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.

ignoreIfPresent
Optional

boolean

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.

workletOrdinal
Optional

integer

A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition. Present only for SharedStorageAccessMethods: addModule, createWorklet.

workletTargetId
Optional

Target.TargetID

Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. Present only for SharedStorageAccessMethods: addModule, createWorklet, run, selectURL, and any other SharedStorageAccessMethod when the SharedStorageAccessScope is sharedStorageWorklet.

withLock
Optional

string

Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.

batchUpdateId
Optional

string

If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs. Optionally present only for SharedStorageAccessMethods: batchUpdate (required), set, append, delete, and clear.

batchSize
Optional

integer

Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.

Storage.SharedStorageAccessScope #

Enum of shared storage access scopes.

Type: string

Allowed values: window, sharedStorageWorklet, protectedAudienceWorklet, header

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

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.

Storage.SharedStoragePrivateAggregationConfig #

Represents a dictionary object passed in as privateAggregationConfig to run or selectURL.

Type: object

Properties

aggregationCoordinatorOrigin
Optional

string

The chosen aggregation service deployment.

contextId
Optional

string

The context ID provided.

filteringIdMaxBytes

integer

Configures the maximum size allowed for filtering IDs.

maxContributions
Optional

integer

The limit on the number of contributions in the final report.

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
Optional

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 #

Type: string

Allowed values: relaxed, strict

Storage.StorageType #

Enum of possible storage types.

Type: string

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

Storage.UsageForType #

Usage for a storage type.

Type: object

Properties

storageType

StorageType

Name of storage type.

usage

number

Storage usage (bytes).

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.

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