Storage

class Storage(cdp: CDP) : Domain

Constructors

Link copied to clipboard
constructor(cdp: CDP)

Types

@Serializable
data class AttributionReportingAggregatableDebugReportingConfig(val budget: Double? = null, val keyPiece: String, val debugData: List<Storage.AttributionReportingAggregatableDebugReportingData>, val aggregationCoordinatorOrigin: String? = null)
@Serializable
data class AttributionReportingAggregatableDebugReportingData(val keyPiece: String, val value: Double, val types: List<String>)
Link copied to clipboard
@Serializable
data class AttributionReportingAggregatableDedupKey(val dedupKey: String? = null, val filters: Storage.AttributionReportingFilterPair)
@Serializable
data class AttributionReportingAggregatableTriggerData(val keyPiece: String, val sourceKeys: List<String>, val filters: Storage.AttributionReportingFilterPair)
@Serializable
data class AttributionReportingAggregatableValueDictEntry(val key: String, val value: Double, val filteringId: String)
Link copied to clipboard
@Serializable
data class AttributionReportingAggregationKeysEntry(val key: String, val value: String)
Link copied to clipboard
@Serializable
data class AttributionReportingEventReportWindows(val start: Int, val ends: List<Int>)
Link copied to clipboard
@Serializable
data class AttributionReportingEventTriggerData(val data: String, val priority: String, val dedupKey: String? = null, val filters: Storage.AttributionReportingFilterPair)
Link copied to clipboard
@Serializable
data class AttributionReportingFilterConfig(val filterValues: List<Storage.AttributionReportingFilterDataEntry>, val lookbackWindow: Int? = null)
Link copied to clipboard
@Serializable
data class AttributionReportingFilterDataEntry(val key: String, val values: List<String>)
Link copied to clipboard
@Serializable
data class AttributionReportingNamedBudgetCandidate(val name: String? = null, val filters: Storage.AttributionReportingFilterPair)
Link copied to clipboard
@Serializable
data class AttributionReportingNamedBudgetDef(val name: String, val budget: Int)
Link copied to clipboard
@Serializable
data class AttributionReportingReportSentParameter(val url: String, val body: Map<String, JsonElement>, val result: Storage.AttributionReportingReportResult, val netError: Int? = null, val netErrorName: String? = null, val httpStatusCode: Int? = null)
Link copied to clipboard
@Serializable
data class AttributionReportingSourceRegistration(val time: Double, val expiry: Int, val triggerData: List<Double>, val eventReportWindows: Storage.AttributionReportingEventReportWindows, val aggregatableReportWindow: Int, val type: Storage.AttributionReportingSourceType, val sourceOrigin: String, val reportingOrigin: String, val destinationSites: List<String>, val eventId: String, val priority: String, val filterData: List<Storage.AttributionReportingFilterDataEntry>, val aggregationKeys: List<Storage.AttributionReportingAggregationKeysEntry>, val debugKey: String? = null, val triggerDataMatching: Storage.AttributionReportingTriggerDataMatching, val destinationLimitPriority: String, val aggregatableDebugReportingConfig: Storage.AttributionReportingAggregatableDebugReportingConfig, val scopesData: Storage.AttributionScopesData? = null, val maxEventLevelReports: Int, val namedBudgets: List<Storage.AttributionReportingNamedBudgetDef>, val debugReporting: Boolean, val eventLevelEpsilon: Double)
Link copied to clipboard
@Serializable
data class AttributionReportingTriggerRegistration(val filters: Storage.AttributionReportingFilterPair, val debugKey: String? = null, val aggregatableDedupKeys: List<Storage.AttributionReportingAggregatableDedupKey>, val eventTriggerData: List<Storage.AttributionReportingEventTriggerData>, val aggregatableTriggerData: List<Storage.AttributionReportingAggregatableTriggerData>, val aggregatableValues: List<Storage.AttributionReportingAggregatableValueEntry>, val aggregatableFilteringIdMaxBytes: Int, val debugReporting: Boolean, val aggregationCoordinatorOrigin: String? = null, val sourceRegistrationTimeConfig: Storage.AttributionReportingSourceRegistrationTimeConfig, val triggerContextId: String? = null, val aggregatableDebugReportingConfig: Storage.AttributionReportingAggregatableDebugReportingConfig, val scopes: List<String>, val namedBudgets: List<Storage.AttributionReportingNamedBudgetCandidate>)
@Serializable
data class AttributionReportingVerboseDebugReportSentParameter(val url: String, val body: List<Map<String, JsonElement>>? = null, val netError: Int? = null, val netErrorName: String? = null, val httpStatusCode: Int? = null)
Link copied to clipboard
@Serializable
data class AttributionScopesData(val values: List<String>, val limit: Double, val maxEventStates: Double)
Link copied to clipboard
@Serializable
data class CacheStorageContentUpdatedParameter(val origin: String, val storageKey: String, val bucketId: String, val cacheName: String)

A cache's contents have been modified.

Link copied to clipboard
@Serializable
data class CacheStorageListUpdatedParameter(val origin: String, val storageKey: String, val bucketId: String)

A cache has been added/deleted.

Link copied to clipboard
@Serializable
data class ClearCookiesParameter(val browserContextId: String? = null)
Link copied to clipboard
@Serializable
data class ClearDataForOriginParameter(val origin: String, val storageTypes: String)
Link copied to clipboard
@Serializable
data class ClearDataForStorageKeyParameter(val storageKey: String, val storageTypes: String)
Link copied to clipboard
@Serializable
data class ClearSharedStorageEntriesParameter(val ownerOrigin: String)
Link copied to clipboard
@Serializable
data class ClearTrustTokensParameter(val issuerOrigin: String)
Link copied to clipboard
@Serializable
data class ClearTrustTokensReturn(val didDeleteTokens: Boolean)
Link copied to clipboard
@Serializable
data class DeleteSharedStorageEntryParameter(val ownerOrigin: String, val key: String)
Link copied to clipboard
@Serializable
data class DeleteStorageBucketParameter(val bucket: Storage.StorageBucket)
@Serializable
data class GetAffectedUrlsForThirdPartyCookieMetadataParameter(val firstPartyUrl: String, val thirdPartyUrls: List<String>)
@Serializable
data class GetAffectedUrlsForThirdPartyCookieMetadataReturn(val matchedUrls: List<String>)
Link copied to clipboard
@Serializable
data class GetCookiesParameter(val browserContextId: String? = null)
Link copied to clipboard
@Serializable
data class GetCookiesReturn(val cookies: List<Network.Cookie>)
Link copied to clipboard
@Serializable
data class GetInterestGroupDetailsParameter(val ownerOrigin: String, val name: String)
Link copied to clipboard
@Serializable
data class GetInterestGroupDetailsReturn(val details: Map<String, JsonElement>)
Link copied to clipboard
@Serializable
data class GetRelatedWebsiteSetsReturn(val sets: List<Storage.RelatedWebsiteSet>)
Link copied to clipboard
@Serializable
data class GetSharedStorageEntriesParameter(val ownerOrigin: String)
Link copied to clipboard
@Serializable
data class GetSharedStorageEntriesReturn(val entries: List<Storage.SharedStorageEntry>)
Link copied to clipboard
@Serializable
data class GetSharedStorageMetadataParameter(val ownerOrigin: String)
Link copied to clipboard
@Serializable
data class GetSharedStorageMetadataReturn(val metadata: Storage.SharedStorageMetadata)
Link copied to clipboard
@Serializable
data class GetStorageKeyForFrameParameter(val frameId: String)
Link copied to clipboard
@Serializable
data class GetStorageKeyForFrameReturn(val storageKey: String)
Link copied to clipboard
@Serializable
data class GetTrustTokensReturn(val tokens: List<Storage.TrustTokens>)
Link copied to clipboard
@Serializable
data class GetUsageAndQuotaParameter(val origin: String)
Link copied to clipboard
@Serializable
data class GetUsageAndQuotaReturn(val usage: Double, val quota: Double, val overrideActive: Boolean, val usageBreakdown: List<Storage.UsageForType>)
Link copied to clipboard
@Serializable
data class IndexedDBContentUpdatedParameter(val origin: String, val storageKey: String, val bucketId: String, val databaseName: String, val objectStoreName: String)

The origin's IndexedDB object store has been modified.

Link copied to clipboard
@Serializable
data class IndexedDBListUpdatedParameter(val origin: String, val storageKey: String, val bucketId: String)

The origin's IndexedDB database list has been modified.

Link copied to clipboard
@Serializable
data class InterestGroupAccessedParameter(val accessTime: Double, val type: Storage.InterestGroupAccessType, val ownerOrigin: String, val name: String, val componentSellerOrigin: String? = null, val bid: Double? = null, val bidCurrency: String? = null, val uniqueAuctionId: String? = null)

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

Link copied to clipboard

Enum of interest group access types.

@Serializable
data class InterestGroupAuctionEventOccurredParameter(val eventTime: Double, val type: Storage.InterestGroupAuctionEventType, val uniqueAuctionId: String, val parentAuctionId: String? = null, val auctionConfig: Map<String, JsonElement>? = null)

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

Link copied to clipboard

Enum of auction events.

Link copied to clipboard

Enum of network fetches auctions can do.

@Serializable
data class InterestGroupAuctionNetworkRequestCreatedParameter(val type: Storage.InterestGroupAuctionFetchType, val requestId: String, val auctions: List<String>)

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

Link copied to clipboard
@Serializable
data class OverrideQuotaForOriginParameter(val origin: String, val quotaSize: Double? = null)
Link copied to clipboard
@Serializable
data class RelatedWebsiteSet(val primarySites: List<String>, val associatedSites: List<String>, val serviceSites: List<String>)

A single Related Website Set object.

Link copied to clipboard
@Serializable
data class ResetSharedStorageBudgetParameter(val ownerOrigin: String)
Link copied to clipboard
@Serializable
data class RunBounceTrackingMitigationsReturn(val deletedSites: List<String>)
Link copied to clipboard
@Serializable
data class SendPendingAttributionReportsReturn(val numSent: Int)
Link copied to clipboard
@Serializable
data class SetAttributionReportingTrackingParameter(val enable: Boolean)
Link copied to clipboard
@Serializable
data class SetCookiesParameter(val cookies: List<Network.CookieParam>, val browserContextId: String? = null)
Link copied to clipboard
@Serializable
data class SetInterestGroupAuctionTrackingParameter(val enable: Boolean)
Link copied to clipboard
@Serializable
data class SetInterestGroupTrackingParameter(val enable: Boolean)
Link copied to clipboard
@Serializable
data class SetProtectedAudienceKAnonymityParameter(val owner: String, val name: String, val hashes: List<String>)
Link copied to clipboard
@Serializable
data class SetSharedStorageEntryParameter(val ownerOrigin: String, val key: String, val value: String, val ignoreIfPresent: Boolean? = null)
Link copied to clipboard
@Serializable
data class SetSharedStorageTrackingParameter(val enable: Boolean)
Link copied to clipboard
@Serializable
data class SetStorageBucketTrackingParameter(val storageKey: String, val enable: Boolean)
Link copied to clipboard
@Serializable
data class SharedStorageAccessedParameter(val accessTime: Double, val scope: Storage.SharedStorageAccessScope, val method: Storage.SharedStorageAccessMethod, val mainFrameId: String, val ownerOrigin: String, val ownerSite: String, val params: Storage.SharedStorageAccessParams)

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

Link copied to clipboard

Enum of shared storage access methods.

Link copied to clipboard
@Serializable
data class SharedStorageAccessParams(val scriptSourceUrl: String? = null, val dataOrigin: String? = null, val operationName: String? = null, val operationId: String? = null, val keepAlive: Boolean? = null, val privateAggregationConfig: Storage.SharedStoragePrivateAggregationConfig? = null, val serializedData: String? = null, val urlsWithMetadata: List<Storage.SharedStorageUrlWithMetadata>? = null, val urnUuid: String? = null, val key: String? = null, val value: String? = null, val ignoreIfPresent: Boolean? = null, val workletOrdinal: Int? = null, val workletTargetId: String? = null, val withLock: String? = null, val batchUpdateId: String? = null, val batchSize: Int? = null)

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

Link copied to clipboard

Enum of shared storage access scopes.

Link copied to clipboard
@Serializable
data class SharedStorageEntry(val key: String, val value: String)

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

Link copied to clipboard
@Serializable
data class SharedStorageMetadata(val creationTime: Double, val length: Int, val remainingBudget: Double, val bytesUsed: Int)

Details for an origin's shared storage.

Link copied to clipboard
@Serializable
data class SharedStoragePrivateAggregationConfig(val aggregationCoordinatorOrigin: String? = null, val contextId: String? = null, val filteringIdMaxBytes: Int, val maxContributions: Int? = null)

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

Link copied to clipboard
@Serializable
data class SharedStorageReportingMetadata(val eventType: String, val reportingUrl: String)

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

Link copied to clipboard
@Serializable
data class SharedStorageUrlWithMetadata(val url: String, val reportingMetadata: List<Storage.SharedStorageReportingMetadata>)

Bundles a candidate URL with its reporting metadata.

@Serializable
data class SharedStorageWorkletOperationExecutionFinishedParameter(val finishedTime: Double, val executionTime: Int, val method: Storage.SharedStorageAccessMethod, val operationId: String, val workletTargetId: String, val mainFrameId: String, val ownerOrigin: String)

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

Link copied to clipboard
@Serializable
data class StorageBucket(val storageKey: String, val name: String? = null)
Link copied to clipboard
@Serializable
data class StorageBucketCreatedOrUpdatedParameter(val bucketInfo: Storage.StorageBucketInfo)
Link copied to clipboard
@Serializable
data class StorageBucketDeletedParameter(val bucketId: String)
Link copied to clipboard
@Serializable
data class StorageBucketInfo(val bucket: Storage.StorageBucket, val id: String, val expiration: Double, val quota: Double, val persistent: Boolean, val durability: Storage.StorageBucketsDurability)
Link copied to clipboard
@Serializable
enum StorageType : Enum<Storage.StorageType>

Enum of possible storage types.

Link copied to clipboard
@Serializable
data class TrackCacheStorageForOriginParameter(val origin: String)
Link copied to clipboard
@Serializable
data class TrackCacheStorageForStorageKeyParameter(val storageKey: String)
Link copied to clipboard
@Serializable
data class TrackIndexedDBForOriginParameter(val origin: String)
Link copied to clipboard
@Serializable
data class TrackIndexedDBForStorageKeyParameter(val storageKey: String)
Link copied to clipboard
@Serializable
data class TrustTokens(val issuerOrigin: String, val count: Double)

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

Link copied to clipboard
@Serializable
data class UntrackCacheStorageForOriginParameter(val origin: String)
@Serializable
data class UntrackCacheStorageForStorageKeyParameter(val storageKey: String)
Link copied to clipboard
@Serializable
data class UntrackIndexedDBForOriginParameter(val origin: String)
Link copied to clipboard
@Serializable
data class UntrackIndexedDBForStorageKeyParameter(val storageKey: String)
Link copied to clipboard
@Serializable
data class UsageForType(val storageType: Storage.StorageType, val usage: Double)

Usage for a storage type.

Properties

Link copied to clipboard

A cache's contents have been modified.

Link copied to clipboard

A cache has been added/deleted.

Link copied to clipboard

The origin's IndexedDB object store has been modified.

Link copied to clipboard

The origin's IndexedDB database list has been modified.

Link copied to clipboard

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

Link copied to clipboard

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

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

Link copied to clipboard

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

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

Functions

Link copied to clipboard
suspend fun clearCookies(browserContextId: String? = null)
suspend fun clearCookies(args: Storage.ClearCookiesParameter, mode: CommandMode = CommandMode.DEFAULT)

Clears cookies.

Link copied to clipboard
suspend fun clearDataForOrigin(args: Storage.ClearDataForOriginParameter, mode: CommandMode = CommandMode.DEFAULT)
suspend fun clearDataForOrigin(origin: String, storageTypes: String)

Clears storage for origin.

Link copied to clipboard
suspend fun clearDataForStorageKey(args: Storage.ClearDataForStorageKeyParameter, mode: CommandMode = CommandMode.DEFAULT)
suspend fun clearDataForStorageKey(storageKey: String, storageTypes: String)

Clears storage for storage key.

Link copied to clipboard
suspend fun clearSharedStorageEntries(ownerOrigin: String)

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

Link copied to clipboard

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

Link copied to clipboard
suspend fun deleteSharedStorageEntry(ownerOrigin: String, key: String)

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

Link copied to clipboard
suspend fun deleteStorageBucket(args: Storage.DeleteStorageBucketParameter, mode: CommandMode = CommandMode.DEFAULT)

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

Returns the list of URLs from a page and its embedded resources that match existing grace period URL pattern rules. https://developers.google.com/privacy-sandbox/cookies/temporary-exceptions/grace-period

Link copied to clipboard
suspend fun getCookies(browserContextId: String? = null): Storage.GetCookiesReturn
suspend fun getCookies(args: Storage.GetCookiesParameter, mode: CommandMode = CommandMode.DEFAULT): Storage.GetCookiesReturn

Returns all browser cookies.

Link copied to clipboard

Gets details for a named interest group.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Gets metadata for an origin's shared storage.

Link copied to clipboard

Returns a storage key given a frame id.

Link copied to clipboard
suspend fun getTrustTokens(mode: CommandMode = CommandMode.DEFAULT): Storage.GetTrustTokensReturn

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

Link copied to clipboard

Returns usage and quota in bytes.

Link copied to clipboard
suspend fun overrideQuotaForOrigin(args: Storage.OverrideQuotaForOriginParameter, mode: CommandMode = CommandMode.DEFAULT)
suspend fun overrideQuotaForOrigin(origin: String, quotaSize: Double? = null)

Override quota for the specified origin

Link copied to clipboard
suspend fun resetSharedStorageBudget(ownerOrigin: String)

Resets the budget for ownerOrigin by clearing all budget withdrawals.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Enables/disables issuing of Attribution Reporting events.

Link copied to clipboard
suspend fun setCookies(args: Storage.SetCookiesParameter, mode: CommandMode = CommandMode.DEFAULT)
suspend fun setCookies(cookies: List<Network.CookieParam>, browserContextId: String? = null)

Sets given cookies.

Link copied to clipboard

Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.

Link copied to clipboard
suspend fun setInterestGroupTracking(enable: Boolean)

Enables/Disables issuing of interestGroupAccessed events.

Link copied to clipboard
Link copied to clipboard
suspend fun setSharedStorageEntry(args: Storage.SetSharedStorageEntryParameter, mode: CommandMode = CommandMode.DEFAULT)
suspend fun setSharedStorageEntry(ownerOrigin: String, key: String, value: String, ignoreIfPresent: Boolean? = null)

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

Link copied to clipboard
suspend fun setSharedStorageTracking(enable: Boolean)

Enables/disables issuing of sharedStorageAccessed events.

Link copied to clipboard
suspend fun setStorageBucketTracking(storageKey: String, enable: Boolean)

Set tracking for a storage key's buckets.

Link copied to clipboard
suspend fun trackCacheStorageForOrigin(origin: String)

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

Link copied to clipboard
suspend fun trackCacheStorageForStorageKey(storageKey: String)

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

Link copied to clipboard
suspend fun trackIndexedDBForOrigin(origin: String)
suspend fun trackIndexedDBForOrigin(args: Storage.TrackIndexedDBForOriginParameter, mode: CommandMode = CommandMode.DEFAULT)

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

Link copied to clipboard
suspend fun trackIndexedDBForStorageKey(storageKey: String)

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

Link copied to clipboard

Unregisters origin from receiving notifications for cache storage.

Link copied to clipboard
suspend fun untrackCacheStorageForStorageKey(storageKey: String)

Unregisters storage key from receiving notifications for cache storage.

Link copied to clipboard
suspend fun untrackIndexedDBForOrigin(origin: String)

Unregisters origin from receiving notifications for IndexedDB.

Link copied to clipboard
suspend fun untrackIndexedDBForStorageKey(storageKey: String)

Unregisters storage key from receiving notifications for IndexedDB.