Storage Protocol
Storage domain commands, events and types for Chrome DevTools Protocol.
Methods
module-attribute
GetStorageKeyForFrameResponse = Response[GetStorageKeyForFrameResult]
module-attribute
GetUsageAndQuotaResponse = Response[GetUsageAndQuotaResult]
module-attribute
GetInterestGroupDetailsResponse = Response[GetInterestGroupDetailsResult]
module-attribute
GetSharedStorageMetadataResponse = Response[GetSharedStorageMetadataResult]
module-attribute
GetSharedStorageEntriesResponse = Response[GetSharedStorageEntriesResult]
module-attribute
RunBounceTrackingMitigationsResponse = Response[RunBounceTrackingMitigationsResult]
module-attribute
SendPendingAttributionReportsResponse = Response[SendPendingAttributionReportsResult]
module-attribute
GetRelatedWebsiteSetsResponse = Response[GetRelatedWebsiteSetsResult]
module-attribute
GetAffectedUrlsForThirdPartyCookieMetadataResponse = Response[GetAffectedUrlsForThirdPartyCookieMetadataResult]
module-attribute
GetStorageKeyForFrameCommand = Command[GetStorageKeyForFrameParams, GetStorageKeyForFrameResponse]
module-attribute
ClearDataForOriginCommand = Command[ClearDataForOriginParams, EmptyResponse]
module-attribute
ClearDataForStorageKeyCommand = Command[ClearDataForStorageKeyParams, EmptyResponse]
module-attribute
GetCookiesCommand = Command[GetCookiesParams, GetCookiesResponse]
module-attribute
ClearCookiesCommand = Command[ClearCookiesParams, EmptyResponse]
module-attribute
GetUsageAndQuotaCommand = Command[GetUsageAndQuotaParams, GetUsageAndQuotaResponse]
module-attribute
OverrideQuotaForOriginCommand = Command[OverrideQuotaForOriginParams, EmptyResponse]
module-attribute
TrackCacheStorageForOriginCommand = Command[TrackCacheStorageForOriginParams, EmptyResponse]
module-attribute
TrackCacheStorageForStorageKeyCommand = Command[TrackCacheStorageForStorageKeyParams, EmptyResponse]
module-attribute
TrackIndexedDBForOriginCommand = Command[TrackIndexedDBForOriginParams, EmptyResponse]
module-attribute
TrackIndexedDBForStorageKeyCommand = Command[TrackIndexedDBForStorageKeyParams, EmptyResponse]
module-attribute
UntrackCacheStorageForOriginCommand = Command[UntrackCacheStorageForOriginParams, EmptyResponse]
module-attribute
UntrackCacheStorageForStorageKeyCommand = Command[UntrackCacheStorageForStorageKeyParams, EmptyResponse]
module-attribute
UntrackIndexedDBForOriginCommand = Command[UntrackIndexedDBForOriginParams, EmptyResponse]
module-attribute
UntrackIndexedDBForStorageKeyCommand = Command[UntrackIndexedDBForStorageKeyParams, EmptyResponse]
module-attribute
GetTrustTokensCommand = Command[EmptyParams, GetTrustTokensResponse]
module-attribute
ClearTrustTokensCommand = Command[ClearTrustTokensParams, EmptyResponse]
module-attribute
GetInterestGroupDetailsCommand = Command[GetInterestGroupDetailsParams, GetInterestGroupDetailsResponse]
module-attribute
SetInterestGroupTrackingCommand = Command[SetInterestGroupTrackingParams, EmptyResponse]
module-attribute
SetInterestGroupAuctionTrackingCommand = Command[SetInterestGroupAuctionTrackingParams, EmptyResponse]
module-attribute
GetSharedStorageMetadataCommand = Command[GetSharedStorageMetadataParams, GetSharedStorageMetadataResponse]
module-attribute
GetSharedStorageEntriesCommand = Command[GetSharedStorageEntriesParams, GetSharedStorageEntriesResponse]
module-attribute
SetSharedStorageEntryCommand = Command[SetSharedStorageEntryParams, EmptyResponse]
module-attribute
DeleteSharedStorageEntryCommand = Command[DeleteSharedStorageEntryParams, EmptyResponse]
module-attribute
ClearSharedStorageEntriesCommand = Command[ClearSharedStorageEntriesParams, EmptyResponse]
module-attribute
ResetSharedStorageBudgetCommand = Command[ResetSharedStorageBudgetParams, EmptyResponse]
module-attribute
SetSharedStorageTrackingCommand = Command[SetSharedStorageTrackingParams, EmptyResponse]
module-attribute
SetStorageBucketTrackingCommand = Command[SetStorageBucketTrackingParams, EmptyResponse]
module-attribute
DeleteStorageBucketCommand = Command[DeleteStorageBucketParams, EmptyResponse]
module-attribute
RunBounceTrackingMitigationsCommand = Command[EmptyParams, RunBounceTrackingMitigationsResponse]
module-attribute
SetAttributionReportingLocalTestingModeCommand = Command[SetAttributionReportingLocalTestingModeParams, EmptyResponse]
module-attribute
SetAttributionReportingTrackingCommand = Command[SetAttributionReportingTrackingParams, EmptyResponse]
module-attribute
SendPendingAttributionReportsCommand = Command[EmptyParams, SendPendingAttributionReportsResponse]
module-attribute
GetRelatedWebsiteSetsCommand = Command[EmptyParams, GetRelatedWebsiteSetsResponse]
module-attribute
GetAffectedUrlsForThirdPartyCookieMetadataCommand = Command[GetAffectedUrlsForThirdPartyCookieMetadataParams, GetAffectedUrlsForThirdPartyCookieMetadataResponse]
module-attribute
SetProtectedAudienceKAnonymityCommand = Command[SetProtectedAudienceKAnonymityParams, EmptyResponse]
Bases: str, Enum
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
GET_AFFECTED_URLS_FOR_THIRD_PARTY_COOKIE_METADATA = 'Storage.getAffectedUrlsForThirdPartyCookieMetadata'
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
Events
module-attribute
CacheStorageContentUpdated = CDPEvent[CacheStorageContentUpdatedEventParams]
module-attribute
CacheStorageListUpdated = CDPEvent[CacheStorageListUpdatedEventParams]
module-attribute
IndexedDBContentUpdated = CDPEvent[IndexedDBContentUpdatedEventParams]
module-attribute
IndexedDBListUpdated = CDPEvent[IndexedDBListUpdatedEventParams]
module-attribute
InterestGroupAccessed = CDPEvent[InterestGroupAccessedEventParams]
module-attribute
InterestGroupAuctionEventOccurred = CDPEvent[InterestGroupAuctionEventOccurredEventParams]
module-attribute
InterestGroupAuctionNetworkRequestCreated = CDPEvent[InterestGroupAuctionNetworkRequestCreatedEventParams]
module-attribute
SharedStorageAccessed = CDPEvent[SharedStorageAccessedEventParams]
module-attribute
SharedStorageWorkletOperationExecutionFinished = CDPEvent[SharedStorageWorkletOperationExecutionFinishedEventParams]
module-attribute
StorageBucketCreatedOrUpdated = CDPEvent[StorageBucketCreatedOrUpdatedEventParams]
module-attribute
StorageBucketDeleted = CDPEvent[StorageBucketDeletedEventParams]
module-attribute
AttributionReportingSourceRegistered = CDPEvent[AttributionReportingSourceRegisteredEventParams]
module-attribute
AttributionReportingTriggerRegistered = CDPEvent[AttributionReportingTriggerRegisteredEventParams]
module-attribute
AttributionReportingReportSent = CDPEvent[AttributionReportingReportSentEventParams]
module-attribute
AttributionReportingVerboseDebugReportSent = CDPEvent[AttributionReportingVerboseDebugReportSentEventParams]
Bases: str, Enum
Events from the Storage domain of the Chrome DevTools Protocol.
This enumeration contains the names of Storage-related events that can be received from the Chrome DevTools Protocol. These events provide information about changes to various browser storage mechanisms including Cache Storage, IndexedDB, Interest Groups, Shared Storage, and Storage Buckets.
class-attribute
instance-attribute
A cache's contents have been modified.
| PARAMETER | DESCRIPTION |
|---|---|
origin
|
Origin to update.
TYPE:
|
storageKey
|
Storage key to update.
TYPE:
|
bucketId
|
Storage bucket to update.
TYPE:
|
cacheName
|
Name of cache in origin.
TYPE:
|
class-attribute
instance-attribute
A cache has been added/deleted.
| PARAMETER | DESCRIPTION |
|---|---|
origin
|
Origin to update.
TYPE:
|
storageKey
|
Storage key to update.
TYPE:
|
bucketId
|
Storage bucket to update.
TYPE:
|
class-attribute
instance-attribute
The origin's IndexedDB object store has been modified.
| PARAMETER | DESCRIPTION |
|---|---|
origin
|
Origin to update.
TYPE:
|
storageKey
|
Storage key to update.
TYPE:
|
bucketId
|
Storage bucket to update.
TYPE:
|
databaseName
|
Database to update.
TYPE:
|
objectStoreName
|
ObjectStore to update.
TYPE:
|
class-attribute
instance-attribute
The origin's IndexedDB database list has been modified.
| PARAMETER | DESCRIPTION |
|---|---|
origin
|
Origin to update.
TYPE:
|
storageKey
|
Storage key to update.
TYPE:
|
bucketId
|
Storage bucket to update.
TYPE:
|
class-attribute
instance-attribute
One of the interest groups was accessed. Note that these events are global to all targets sharing an interest group store.
| PARAMETER | DESCRIPTION |
|---|---|
accessTime
|
Time of the access.
TYPE:
|
type
|
Type of access.
TYPE:
|
ownerOrigin
|
Owner origin.
TYPE:
|
name
|
Name of the interest group.
TYPE:
|
componentSellerOrigin
|
For topLevelBid/topLevelAdditionalBid, and when appropriate, win and additionalBidWin.
TYPE:
|
bid
|
For bid or somethingBid event, if done locally and not on a server.
TYPE:
|
bidCurrency
|
Currency of the bid.
TYPE:
|
uniqueAuctionId
|
For non-global events --- links to interestGroupAuctionEvent.
TYPE:
|
class-attribute
instance-attribute
An auction involving interest groups is taking place. These events are target-specific.
| PARAMETER | DESCRIPTION |
|---|---|
eventTime
|
Time of the event.
TYPE:
|
type
|
Type of auction event. |
uniqueAuctionId
|
Unique identifier for the auction.
TYPE:
|
parentAuctionId
|
Set for child auctions.
TYPE:
|
auctionConfig
|
Set for started and configResolved.
TYPE:
|
class-attribute
instance-attribute
INTEREST_GROUP_AUCTION_NETWORK_REQUEST_CREATED = '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).
| PARAMETER | DESCRIPTION |
|---|---|
type
|
Type of fetch. |
requestId
|
Request identifier.
TYPE:
|
auctions
|
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.
TYPE:
|
class-attribute
instance-attribute
Shared storage was accessed by the associated page. The following parameters are included in all events.
| PARAMETER | DESCRIPTION |
|---|---|
accessTime
|
Time of the access.
TYPE:
|
scope
|
Enum value indicating the access scope.
TYPE:
|
method
|
Enum value indicating the Shared Storage API method invoked. |
mainFrameId
|
DevTools Frame Token for the primary frame tree's root.
TYPE:
|
ownerOrigin
|
Serialization of the origin owning the Shared Storage data.
TYPE:
|
ownerSite
|
Serialization of the site owning the Shared Storage data.
TYPE:
|
params
|
The sub-parameters wrapped by params are all optional and their presence/absence depends on type. |
class-attribute
instance-attribute
SHARED_STORAGE_WORKLET_OPERATION_EXECUTION_FINISHED = 'Storage.sharedStorageWorkletOperationExecutionFinished'
A shared storage run or selectURL operation finished its execution. The following parameters are included in all events.
| PARAMETER | DESCRIPTION |
|---|---|
finishedTime
|
Time that the operation finished.
TYPE:
|
executionTime
|
Time, in microseconds, from start of shared storage JS API call until end of operation execution in the worklet.
TYPE:
|
method
|
Enum value indicating the Shared Storage API method invoked. |
operationId
|
ID of the operation call.
TYPE:
|
workletTargetId
|
Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet.
TYPE:
|
mainFrameId
|
DevTools Frame Token for the primary frame tree's root.
TYPE:
|
ownerOrigin
|
Serialization of the origin owning the Shared Storage data.
TYPE:
|
class-attribute
instance-attribute
Fired when a storage bucket is created or updated.
| PARAMETER | DESCRIPTION |
|---|---|
bucketInfo
|
Information about the storage bucket.
TYPE:
|
class-attribute
instance-attribute
Fired when a storage bucket is deleted.
| PARAMETER | DESCRIPTION |
|---|---|
bucketId
|
ID of the deleted storage bucket.
TYPE:
|
class-attribute
instance-attribute
Fired when an attribution source is registered.
| PARAMETER | DESCRIPTION |
|---|---|
registration
|
Registration details. |
result
|
Result of the registration. |
class-attribute
instance-attribute
Fired when an attribution trigger is registered.
| PARAMETER | DESCRIPTION |
|---|---|
registration
|
Registration details. |
eventLevel
|
Event level result. |
aggregatable
|
Aggregatable result. |
class-attribute
instance-attribute
Fired when an attribution report is sent.
| PARAMETER | DESCRIPTION |
|---|---|
url
|
URL the report was sent to.
TYPE:
|
body
|
Body of the report.
TYPE:
|
result
|
Result of the report sending. |
netError
|
If result is sent, populated with net/HTTP status.
TYPE:
|
netErrorName
|
Name of the network error if any.
TYPE:
|
httpStatusCode
|
HTTP status code if available.
TYPE:
|
class-attribute
instance-attribute
ATTRIBUTION_REPORTING_VERBOSE_DEBUG_REPORT_SENT = 'Storage.attributionReportingVerboseDebugReportSent'
Fired when a verbose debug report is sent for an attribution source.
| PARAMETER | DESCRIPTION |
|---|---|
url
|
URL the report was sent to.
TYPE:
|
body
|
Body of the report.
TYPE:
|
netError
|
If result is sent, populated with net/HTTP status.
TYPE:
|
netErrorName
|
Name of the network error if any.
TYPE:
|
httpStatusCode
|
HTTP status code if available.
TYPE:
|
Bases: TypedDict
Bases: TypedDict
Types
Bases: str, Enum
Bases: str, Enum
Enum of interest group access types.
class-attribute
instance-attribute
Bases: str, Enum
Enum of network fetches auctions can do.
class-attribute
instance-attribute
Bases: str, Enum
Enum of shared storage access scopes.
class-attribute
instance-attribute
class-attribute
instance-attribute
Bases: str, Enum
Enum of shared storage access methods.
Bases: TypedDict
Represents a dictionary object passed in as privateAggregationConfig to run or selectURL.
Bases: TypedDict
Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.
Bases: TypedDict
Bases: str, Enum
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
Bases: TypedDict
Bases: str, Enum
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
class-attribute
instance-attribute
Bases: str, Enum