Class CacheService

CacheService

借助 CacheService,您可以访问缓存以短期存储数据。

借助此类,您可以获取特定的缓存实例。公共缓存适用于不依赖于哪个用户访问脚本的内容。私密缓存用于存储特定于用户的内容,例如设置或近期活动。

我们无法保证您写入缓存的数据会一直保留到其过期时间。您必须准备好从所有读取中返回 null

方法

方法返回类型简介
getDocumentCache()Cache获取作用域限定为当前文档和脚本的缓存实例。
getScriptCache()Cache获取作用域限定为脚本的缓存实例。
getUserCache()Cache获取作用域限定为当前用户和脚本的缓存实例。

详细文档

getDocumentCache()

获取作用域限定为当前文档和脚本的缓存实例。文档缓存是特定于包含脚本的当前文档的。您可以使用这些属性来存储特定于当前文档的脚本信息。如果此方法是在包含文档的上下文之外调用(例如从独立脚本或 Web 应用调用),则此方法会返回 null

// Gets a cache that is specific to the current document containing the script
const cache = CacheService.getDocumentCache();

返回

Cache - 文档缓存实例,如果没有包含文档,则为 null


getScriptCache()

获取作用域限定为脚本的缓存实例。脚本缓存对脚本的所有用户都是通用的。您可以使用这些 Cookie 存储不特定于当前用户的信息。

// Gets a cache that is common to all users of the script
const cache = CacheService.getScriptCache();

返回

Cache - 脚本缓存实例


getUserCache()

获取作用域限定为当前用户和脚本的缓存实例。用户缓存是特定于脚本的当前用户的。您可以使用这些方法存储特定于当前用户的脚本信息。

// Gets a cache that is specific to the current user of the script
const cache = CacheService.getUserCache();

返回

Cache - 用户缓存实例