CacheService を使用すると、キャッシュにアクセスしてデータを短期間保存できます。
このクラスを使用すると、特定のキャッシュ インスタンスを取得できます。公開キャッシュは、スクリプトにアクセスするユーザーに依存しない対象です。プライベート キャッシュは、設定や最近のアクティビティなど、ユーザー固有のキャッシュです。
キャッシュに書き込んだデータは、その有効期限まで保持されるとは限りません。すべての読み取りから null
を取得できるように準備する必要があります。
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDocumentCache() | Cache | 現在のドキュメントとスクリプトをスコープとするキャッシュ インスタンスを取得します。 |
getScriptCache() | Cache | スクリプトをスコープとするキャッシュ インスタンスを取得します。 |
getUserCache() | Cache | 現在のユーザーとスクリプトをスコープとするキャッシュ インスタンスを取得します。 |
詳細なドキュメント
getDocumentCache()
現在のドキュメントとスクリプトをスコープとするキャッシュ インスタンスを取得します。ドキュメント キャッシュは、スクリプトを含む現在のドキュメントに固有のキャッシュです。これらを使用して、現在のドキュメントに固有のスクリプト情報を保存します。含まれるドキュメントのコンテキスト(スタンドアロン スクリプトやウェブアプリなど)の外部でこのメソッドが呼び出された場合、このメソッドは null
を返します。
// Gets a cache that is specific to the current document containing the script var cache = CacheService.getDocumentCache();
リターン
Cache
- ドキュメント キャッシュ インスタンス。含まれているドキュメントがない場合は null
getScriptCache()
スクリプトをスコープとするキャッシュ インスタンスを取得します。スクリプト キャッシュは、スクリプトのすべてのユーザーに共通です。現在のユーザーに固有ではない情報を保存する場合に使用します。
// Gets a cache that is common to all users of the script var cache = CacheService.getScriptCache();
リターン
Cache
- スクリプト キャッシュ インスタンス
getUserCache()
現在のユーザーとスクリプトをスコープとするキャッシュ インスタンスを取得します。ユーザー キャッシュはスクリプトの現在のユーザーに固有です。現在のユーザーに固有のスクリプト情報を保存する場合に使用します。
// Gets a cache that is specific to the current user of the script var cache = CacheService.getUserCache();
リターン
Cache
- ユーザー キャッシュ インスタンス