Cache Service
Stay organized with collections
Save and categorize content based on your preferences.
Cache
This service allows a script to temporarily cache results that take time to
fetch/compute. Public caches are for things that are not dependent on which user
is accessing your script. Private caches are for things which are user-specific,
like settings or recent activity.
Classes
| Name | Brief description |
Cache | A reference to a particular cache. |
CacheService | CacheService allows you to access a cache for short term storage of data. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eApps Script Cache service provides temporary storage for script results, improving performance by avoiding redundant computations or fetches.\u003c/p\u003e\n"],["\u003cp\u003eTwo types of caches are available: public caches for shared data and private caches for user-specific information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCacheService\u003c/code\u003e offers methods to access document, script, or user-scoped caches, while the \u003ccode\u003eCache\u003c/code\u003e class provides methods for data manipulation within a cache instance, like adding, retrieving, and removing entries.\u003c/p\u003e\n"],["\u003cp\u003eCache entries can have optional expiration times, allowing for automatic removal after a specified duration.\u003c/p\u003e\n"]]],[],null,["# Cache Service\n\nCache\n\nThis service allows a script to temporarily cache results that take time to\nfetch/compute. Public caches are for things that are not dependent on which user\nis accessing your script. Private caches are for things which are user-specific,\nlike settings or recent activity.\n\nClasses\n-------\n\n| Name | Brief description |\n|------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Cache](/apps-script/reference/cache/cache) | A reference to a particular cache. |\n| [CacheService](/apps-script/reference/cache/cache-service) | CacheService allows you to access a cache for short term storage of data. |\n\n[Cache](/apps-script/reference/cache/cache)\n-------------------------------------------\n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------------------|\n| [get(key)](/apps-script/reference/cache/cache#get(String)) | `String` | Gets the cached value for the given key, or `null` if none is found. |\n| [getAll(keys)](/apps-script/reference/cache/cache#getAll(String)) | `Object` | Returns a JavaScript Object containing all key/value pairs found in the cache for an array of keys. |\n| [put(key, value)](/apps-script/reference/cache/cache#put(String,String)) | `void` | Adds a key/value pair to the cache. |\n| [put(key, value, expirationInSeconds)](/apps-script/reference/cache/cache#put(String,String,Integer)) | `void` | Adds a key/value pair to the cache, with an expiration time (in seconds). |\n| [putAll(values)](/apps-script/reference/cache/cache#putAll(Object)) | `void` | Adds a set of key/value pairs to the cache. |\n| [putAll(values, expirationInSeconds)](/apps-script/reference/cache/cache#putAll(Object,Integer)) | `void` | Adds a set of key/value pairs to the cache, with an expiration time (in seconds). |\n| [remove(key)](/apps-script/reference/cache/cache#remove(String)) | `void` | Removes an entry from the cache using the given key. |\n| [removeAll(keys)](/apps-script/reference/cache/cache#removeAll(String)) | `void` | Removes a set of entries from the cache. |\n\n[CacheService](/apps-script/reference/cache/cache-service)\n----------------------------------------------------------\n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------|\n| [getDocumentCache()](/apps-script/reference/cache/cache-service#getDocumentCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the current document and script. |\n| [getScriptCache()](/apps-script/reference/cache/cache-service#getScriptCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the script. |\n| [getUserCache()](/apps-script/reference/cache/cache-service#getUserCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the current user and script. |"]]
