Chrome DevTools Protocol (original) (raw)

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

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

parameters

ownerOrigin

string

Storage.clearTrustTokensExperimental #

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

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

parameters

ownerOrigin

string

key

string

Storage.deleteStorageBucketExperimental #

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

parameters

bucket

StorageBucket

Storage.getInterestGroupDetailsExperimental #

Gets details for a named interest group.

parameters

ownerOrigin

string

name

string

Return Object

details

object

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

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

parameters

ownerOrigin

string

Return Object

entries

array[ SharedStorageEntry ]

Storage.getSharedStorageMetadataExperimental #

Gets metadata for an origin's shared storage.

parameters

ownerOrigin

string

Return Object

metadata

SharedStorageMetadata

Storage.getTrustTokensExperimental #

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

Return Object

tokens

array[ TrustTokens ]

Storage.overrideQuotaForOriginExperimental #

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

Resets the budget for ownerOrigin by clearing all budget withdrawals.

parameters

ownerOrigin

string

Storage.runBounceTrackingMitigationsExperimental #

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

Return Object

deletedSites

array[ string ]

Storage.sendPendingAttributionReportsExperimental #

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

Return Object

numSent

integer

The number of reports that were sent.

Storage.setAttributionReportingLocalTestingModeExperimental #

parameters

enabled

boolean

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

Storage.setAttributionReportingTrackingExperimental #

Enables/disables issuing of Attribution Reporting events.

parameters

enable

boolean

Storage.setInterestGroupAuctionTrackingExperimental #

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

parameters

enable

boolean

Storage.setInterestGroupTrackingExperimental #

Enables/Disables issuing of interestGroupAccessed events.

parameters

enable

boolean

Storage.setSharedStorageEntryExperimental #

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 ifkey doesn't already exist.

Storage.setSharedStorageTrackingExperimental #

Enables/disables issuing of sharedStorageAccessed events.

parameters

enable

boolean

Storage.setStorageBucketTrackingExperimental #

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

string

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

bid

number

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

bidCurrency

string

uniqueAuctionId

InterestGroupAuctionId

For non-global events --- links to interestGroupAuctionEvent

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.

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.

Storage.storageBucketDeleted#

parameters

bucketId

string

Types

Storage.InterestGroupAccessType#

Enum of interest group access types.

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

Type: string

Storage.InterestGroupAuctionEventType#

Enum of auction events.

Allowed Values: started, configResolved

Type: string

Storage.InterestGroupAuctionFetchType#

Enum of network fetches auctions can do.

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

Type: string

Storage.InterestGroupAuctionId#

Protected audience interest group auction identifier.

Type: string

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

value

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

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.

Storage.SharedStorageAccessType#

Enum of shared storage access types.

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

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

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

Type: object

properties

budget

number

number instead of integer because not all uint32 can be represented by int, only present for source registrations

keyPiece

UnsignedInt128AsBase16

debugData

array[ AttributionReportingAggregatableDebugReportingData ]

aggregationCoordinatorOrigin

string

Storage.AttributionReportingAggregatableDebugReportingDataExperimental #

Type: object

properties

keyPiece

UnsignedInt128AsBase16

value

number

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

types

array[ string ]

Storage.AttributionReportingAggregatableResultExperimental #

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

Type: string

Storage.AttributionReportingAggregatableValueDictEntryExperimental #

Type: object

properties

key

string

value

number

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

filteringId

UnsignedInt64AsBase10

Storage.AttributionReportingAggregationKeysEntryExperimental #

Type: object

properties

key

string

value

UnsignedInt128AsBase16

Storage.AttributionReportingEventLevelResultExperimental #

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

Type: string

Storage.AttributionReportingEventReportWindowsExperimental #

Type: object

properties

start

integer

duration in seconds

ends

array[ integer ]

duration in seconds

Storage.AttributionReportingFilterConfigExperimental #

Type: object

properties

filterValues

array[ AttributionReportingFilterDataEntry ]

lookbackWindow

integer

duration in seconds

Storage.AttributionReportingFilterDataEntryExperimental #

Type: object

properties

key

string

values

array[ string ]

Storage.AttributionReportingSourceRegistrationResultExperimental #

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

Type: string

Storage.AttributionReportingSourceRegistrationTimeConfigExperimental #

Allowed Values: include, exclude

Type: string

Storage.AttributionReportingSourceTypeExperimental #

Allowed Values: navigation, event

Type: string

Storage.AttributionReportingTriggerDataMatchingExperimental #

Allowed Values: exact, modulus

Type: string

Storage.AttributionReportingTriggerSpecExperimental #

Type: object

properties

triggerData

array[ number ]

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

eventReportWindows

AttributionReportingEventReportWindows

Storage.AttributionScopesDataExperimental #

Type: object

properties

values

array[ string ]

limit

number

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

maxEventStates

number

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

Type: string

Storage.TrustTokensExperimental #

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

Type: string

Storage.UnsignedInt64AsBase10Experimental #

Type: string