Class CacheService

CacheService

CacheService を使用すると、キャッシュにアクセスしてデータを短期的に保存できます。

このクラスを使用すると、特定のキャッシュ インスタンスを取得できます。公開キャッシュは、スクリプトにアクセスするユーザーに依存しないものに使用します。プライベート キャッシュは、設定や最近のアクティビティなど、ユーザー固有のものに使用します。

キャッシュに書き込まれたデータが有効期限まで保持される保証はありません。すべての読み取りから null を返す準備が必要です。

メソッド

メソッド戻り値の型概要
getDocumentCache()Cache現在のドキュメントとスクリプトを対象範囲とするキャッシュ インスタンスを取得します。
getScriptCache()Cacheスクリプトを対象範囲とするキャッシュ インスタンスを取得します。
getUserCache()Cache現在のユーザーとスクリプトを対象範囲とするキャッシュ インスタンスを取得します。

詳細なドキュメント

getDocumentCache()

現在のドキュメントとスクリプトを対象範囲とするキャッシュ インスタンスを取得します。ドキュメント キャッシュは、スクリプトを含む現在のドキュメントに固有です。これらを使用して、現在のドキュメントに固有のスクリプト情報を保存します。このメソッドが、包含するドキュメントのコンテキストの外部（スタンドアロン スクリプトやウェブアプリなど）から呼び出されると、このメソッドは null を返します。

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

戻る

Cache - ドキュメント キャッシュ インスタンス。包含ドキュメントがない場合、null

getScriptCache()

スクリプトを対象範囲とするキャッシュ インスタンスを取得します。スクリプト キャッシュは、スクリプトのすべてのユーザーに共通します。現在のユーザーに固有ではない情報を保存する場合に使用します。 

// 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 - ユーザー キャッシュ インスタンス