Belirli bir önbelleğe yapılan referans.
Bu sınıf, öğeleri bir önbelleğe eklemenize, önbellekten almanıza ve kaldırmanıza olanak tanır. Bu özellik, özellikle pahalı veya yavaş bir kaynağa sık sık erişmek istediğinizde yararlı olabilir. Örneğin, example.com adresinde 20 saniyede getirilen bir RSS özet akışınız olduğunu ancak ortalama bir istekte erişimi hızlandırmak istediğinizi varsayalım.
function getRssFeed() { const cache = CacheService.getScriptCache(); const cached = cache.get('rss-feed-contents'); if (cached != null) { return cached; } const result = UrlFetchApp.fetch( 'http://example.com/my-slow-rss-feed.xml'); // takes 20 seconds const contents = result.getContentText(); cache.put('rss-feed-contents', contents, 1500); // cache for 25 minutes return contents; }
Öğe önbellekte değilse 20 saniye beklemeniz gerekir. Ancak öğenin 25 dakika içinde önbellekten süresi dolana kadar sonraki aramalar çok hızlıdır.
Yöntemler
| Yöntem | Dönüş türü | Kısa açıklama |
|---|---|---|
get(key) | String|null | Belirtilen anahtarın önbelleğe alınmış değerini veya bulunamazsa null değerini alır. |
get | Object | Bir anahtar dizisi için önbellekte bulunan tüm anahtar/değer çiftlerini içeren bir JavaScript nesnesi döndürür. |
put(key, value) | void | Önbelleğe bir anahtar/değer çifti ekler. |
put(key, value, expirationInSeconds) | void | Önbelleğe, süre sonu süresi (saniye cinsinden) olan bir anahtar/değer çifti ekler. |
put | void | Önbelleğe bir dizi anahtar/değer çifti ekler. |
put | void | Önbelleğe, süre sonu süresi (saniye cinsinden) olan bir dizi anahtar/değer çifti ekler. |
remove(key) | void | Belirtilen anahtarı kullanarak önbellekten bir girişi kaldırır. |
remove | void | Önbellekten bir dizi girişi kaldırır. |
Ayrıntılı belgeler
get(key)
Belirtilen anahtarın önbelleğe alınmış değerini veya bulunamazsa null değerini alır.
// Gets the value from the cache for the key 'foo'. const value = CacheService.getScriptCache().get('foo');
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
key | String | Önbellekte aranacak anahtar. |
Return
String|null: Önbelleğe alınan değer veya bulunamadıysa null.
get All(keys)
Bir anahtar dizisi için önbellekte bulunan tüm anahtar/değer çiftlerini içeren bir JavaScript nesnesi döndürür.
// Gets a set of values from the cache const values = CacheService.getDocumentCache().getAll(['foo', 'x', 'missing']); // If there were values in the cache for 'foo' and 'x' but not 'missing', then // 'values' is: {'foo': 'somevalue', 'x': 'othervalue'}
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
keys | String[] | Aranacak anahtarlar. |
Return
Object: Önbellekte bulunan tüm anahtarların anahtar/değer çiftlerini içeren bir JavaScript nesnesi.
Aşağıdaki kaynakları da incelemenizi öneririz:
put(key, value)
Önbelleğe bir anahtar/değer çifti ekler.
Anahtarın maksimum uzunluğu 250 karakterdir. Anahtar başına depolanabilecek maksimum veri miktarı 100 KB'tır. Değerin önbellekteki geçerlilik süresi 600 saniyedir (10 dakika).
Önbelleğe alınan öğelerin sınırı 1.000'dir. 1.000'den fazla öğe yazılırsa önbellek, geçerlilik süresi en uzun olan 900 öğeyi depolar. Bu sınır değişebilir.
const cache = CacheService.getScriptCache(); // Puts the value 'bar' into the cache using the key 'foo' cache.put('foo', 'bar');
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
key | String | Değerin depolanacağı anahtar. |
value | String | Önbelleğe alınacak değer. |
put(key, value, expirationInSeconds)
Önbelleğe, süre sonu süresi (saniye cinsinden) olan bir anahtar/değer çifti ekler.
Anahtarın maksimum uzunluğu 250 karakterdir. Anahtar başına depolanabilecek maksimum veri miktarı 100 KB'tır. Belirtilen geçerlilik süresi yalnızca bir öneridir. Çok fazla veri önbelleğe alınırsa önbelleğe alınan veriler bu süreden önce kaldırılabilir.
Önbelleğe alınan öğelerin sınırı 1.000'dir. 1.000'den fazla öğe yazılırsa önbellek, geçerlilik süresi en uzun olan 900 öğeyi depolar. Bu sınır değişebilir.
// Puts the value 'bar' into the cache using the key 'foo', but only for the // next 20 seconds. CacheService.getScriptCache().put('foo', 'bar', 20);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
key | String | Değerin depolanacağı anahtar. |
value | String | Önbelleğe alınacak değer. |
expiration | Integer | Değerin önbellekte kalacağı maksimum süre (saniye cinsinden). Minimum süre 1 saniye, maksimum süre ise 21.600 saniyedir (6 saat). |
put All(values)
Önbelleğe bir dizi anahtar/değer çifti ekler.
"Put" için yapılan tekrarlı çağrılara benzer ancak anahtar başına depolanabilecek veri miktarı 100 KB olduğundan yalnızca bir çağrı yapıldığı için daha verimlidir. Değerlerin süresi 600 saniye (10 dakika) sonra önbellekte dolar.
Önbelleğe alınan öğelerin sınırı 1.000'dir. 1.000'den fazla öğe yazılırsa önbellek, geçerlilik süresi en uzun olan 900 öğeyi depolar. Bu sınır değişebilir.
// Puts a set of values into the cache with the keys 'foo', 'x', and 'key'. const values = { foo: 'bar', x: 'y', key: 'value', }; CacheService.getUserCache().putAll(values);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
values | Object | Dize anahtarları ve değerleri içeren bir JavaScript nesnesi. |
Aşağıdaki kaynakları da incelemenizi öneririz:
put All(values, expirationInSeconds)
Önbelleğe, süre sonu süresi (saniye cinsinden) olan bir dizi anahtar/değer çifti ekler.
"Put" için yapılan tekrarlı çağrılara benzer ancak tüm değerleri ayarlamak için memcache sunucusuna yalnızca bir çağrı yaptığı için daha verimlidir. Anahtarın maksimum uzunluğu 250 karakterdir. Anahtar başına depolanabilecek maksimum veri miktarı 100 KB'tır. Belirtilen son kullanma süresi yalnızca bir öneridir. Çok fazla veri önbelleğe alınırsa önbelleğe alınan veriler bu süreden önce kaldırılabilir.
Önbelleğe alınan öğelerin sınırı 1.000'dir. 1.000'den fazla öğe yazılırsa önbellek, geçerlilik süresi en uzun olan 900 öğeyi depolar. Bu sınır değişebilir.
// Puts a set of values into the cache with the keys 'foo', 'x', and 'key'. const values = { foo: 'bar', x: 'y', key: 'value', }; CacheService.getUserCache().putAll(values, 20);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
values | Object | Dize anahtarları ve değerleri içeren bir JavaScript nesnesi. |
expiration | Integer | Değerin önbellekte kalacağı maksimum süre (saniye cinsinden). İzin verilen minimum geçerlilik süresi 1 saniye, izin verilen maksimum geçerlilik süresi ise 21.600 saniyedir (6 saat). Varsayılan geçerlilik süresi 600 saniyedir (10 dakika). |
Aşağıdaki kaynakları da incelemenizi öneririz:
remove(key)
Belirtilen anahtarı kullanarak önbellekten bir girişi kaldırır.
// Removes any cache entries for 'foo' CacheService.getUserCache().remove('foo');
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
key | String | Önbellekten kaldırılacak anahtar. |
remove All(keys)
Önbellekten bir dizi girişi kaldırır.
// Removes entries from the cache with keys 'foo' and 'x' CacheService.getDocumentCache().removeAll(['foo', 'x']);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
keys | String[] | Kaldırılacak anahtarlar dizisi. |