では、実際にキャッシュサービスを使ってみましょう。まずは、CacheServiceからです。このオブジェクトには、Cacheオブジェクトを取得する以下のメソッドが用意されています。

getPublicCache
パブリックキャッシュのCacheオブジェクトを返すメソッドです。パブリックキャッシュというのは、そのサスクリプトにアクセスできるすべてのユーザーが利用できるキャッシュのことです。通常、キャッシュといえばこちらのタイプでしょう。

getPrivateCache
プライベートキャッシュのCacheオブジェクトを返すメソッドです。これは現在のアクティブユーザーだｋが利用できるキャッシュです。

――これらのメソッドを使って、Cacheオブジェクトを取得します。Cacheオブジェクトには、キャッシュの保管や取得に関するメソッド類がまとめられており、それらを呼び出してキャッシュを使うことになります。では、主なメソッドを整理しましょう。

変数 = 《Cache》.get( キー );

Cacheに保存したキャッシュを取得します。キャッシュは、それぞれ「キー」と呼ばれる名前をつけて保管されています。いわば連想配列のような状態で管理されていると考えると良いでしょう。getは、取り出すキャッシュのキーを指定し、そのキャッシュされたデータを取り出します。キーはテキストの値で指定します。

《Cache》.put( キー , テキスト );
《Cache》.put( キー , テキスト , キャッシュ期間 );

Cacheにテキストデータをキャッシュします。第１引数にはそのテキストに割り当てるキーを、第２引数には保存するテキストを指定します。また第３引数にキャッシュの期間を秒数換算して指定することもできます。キャッシュの保存期間を１日にしたいなら、60 * 60 * 24を設定します。

《Cache》.remove( キー );

Cacheに保存されているキャッシュデータを破棄するためのものです。引数にはキーを指定します。これで、指定されたキーに保存されているキャッシュが消されます。

変数 = 《Cache》.getAll( キー配列 );

多数のキャッシュをまとめて取り出すためのものです。引数には、取り出したいキャッシュのキーを配列にまとめたものを渡します。返り値はJavaScriptオブジェクトとなり、その中に各キーごとにキャッシュデータが保管されています。

《Cache》.putAll( オブジェクト );
《Cache》.putAll( オブジェクト , キャッシュ期間 );

多数のデータをまとめてキャッシュに保管するためのものです。引数は１つで、JavaScriptのオブジェクトとなります。これは、キーとキャッシュデータを連想配列にまとめたものを想像すればいいでしょう。putと同様に、キャッシュする期間を第２引数に指定することも可能です。

《Cache》.removeAll( キー配列 );

キャッシュされているデータを破棄するためのものです。引数には、破棄するキャッシュデータのキーを配列にまとめたものを渡します。これにより、多数のキーのキャッシュデータを一度に削除することができます。


メソッドは、１つ１つのキャッシュを操作するものと、複数のキャッシュをまとめて操作するものが用意されています。まぁ、最初は１つのキャッシュを操作するものだけ覚えておけばよいでしょう。複数操作のものは知らなくても特に困らないので……。