[ Web Proxy ]

Viewing: https://developer.android.com/reference/android/adservices/ondevicepersonalization/KeyValueStore

KeyValueStore | API reference | Android Developers Skip to main content

[Android Developers]

Essentials Design & Plan Develop Google Play Blog

English
Deutsch
Espaol Amrica Latina
Franais
Indonesia
Polski
Portugus Brasil
Ting Vit

Android Studio

Stay organized with collections Save and categorize content based on your preferences.

Added in API level 35
Deprecated in API level 37

Summary: Methods

KeyValueStore

Kotlin |Java

public interface KeyValueStore

android.adservices.ondevicepersonalization.KeyValueStore

Known indirect subclasses

MutableKeyValueStore

MutableKeyValueStore This interface was deprecated in API level 37. The ODP APIs are deprecated and will not be supported in future Android releases. There is no direct replacement API available. Developers currently integrated with these APIs must cease further integration efforts. For comprehensive details regarding this deprecation and the future roadmap of Privacy Sandbox on Android, please consult the official Privacy Sandbox developer documentation and announcements: https://privacysandbox.google.com

This interface was deprecated in API level 37.
The ODP APIs are deprecated and will not be supported in future Android releases. There is no direct replacement API available. Developers currently integrated with these APIs must cease further integration efforts. For comprehensive details regarding this deprecation and the future roadmap of Privacy Sandbox on Android, please consult the official Privacy Sandbox developer documentation and announcements: https://privacysandbox.google.com

An interface to a read-only key-value store. Used as a Data Access Object for the REMOTE_DATA table.

See also:

IsolatedService.getRemoteData(RequestToken)

Summary

Public methods
`abstract byte[]`	`get(String key)` Looks up a key in a read-only store.
`abstract Set<String>`	`keySet()` Returns a Set view of the keys contained in the REMOTE_DATA table.

Public methods

get

Added in API level 35

public abstract byte[] get (String key)

Looks up a key in a read-only store.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`key`	`String`: The key to look up. This value cannot be `null`.

Returns
`byte[]`	the value to which the specified key is mapped, or null if there contains no mapping for the key.

keySet

Added in API level 35

public abstract Set<String> keySet ()

Returns a Set view of the keys contained in the REMOTE_DATA table.
This method may take several seconds to complete, so it should only be called from a worker thread.

Returns
`Set<String>`	This value cannot be `null`.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-08-03 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-08-03 UTC."],[],[]]