Class Cache

Caché

Es una referencia a una caché específica.

Esta clase te permite insertar, recuperar y quitar elementos de una caché. Esto puede ser particularmente útil cuando deseas acceder con frecuencia a un recurso costoso o lento. Por ejemplo, supongamos que tienes un feed RSS en example.com que tarda 20 segundos en recuperarse, pero quieres acelerar el acceso en una solicitud promedio.

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;
}

Aun así, debes esperar 20 segundos si el elemento no está en la caché, pero las llamadas posteriores son muy rápidas hasta que el elemento vence en la caché en 25 minutos.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
get(key)	String|null	Obtiene el valor almacenado en caché para la clave determinada o null si no se encuentra ninguno.
getAll(keys)	Object	Devuelve un objeto JavaScript que contiene todos los pares clave/valor que se encuentran en la caché para un array de claves.
put(key, value)	void	Agrega un par clave-valor a la caché.
put(key, value, expirationInSeconds)	void	Agrega un par clave-valor a la caché, con un tiempo de vencimiento (en segundos).
putAll(values)	void	Agrega un conjunto de pares clave-valor a la caché.
putAll(values, expirationInSeconds)	void	Agrega un conjunto de pares clave-valor a la caché, con un tiempo de vencimiento (en segundos).
remove(key)	void	Quita una entrada de la caché con la clave determinada.
removeAll(keys)	void	Quita un conjunto de entradas de la caché.

Documentación detallada

get(key)

Obtiene el valor almacenado en caché para la clave determinada o null si no se encuentra ninguno.

// Gets the value from the cache for the key 'foo'.
const value = CacheService.getScriptCache().get('foo');

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave que se buscará en la caché.

Volver

String|null: Es el valor almacenado en caché o null si no se encontró ninguno.

---

getAll(keys)

Devuelve un objeto JavaScript que contiene todos los pares clave/valor que se encuentran en la caché para un array de claves.

// 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'}

Parámetros

Nombre	Tipo	Descripción
keys	String[]	Son las claves que se buscarán.

Volver

Object: Es un objeto de JavaScript que contiene los pares clave-valor para todas las claves que se encuentran en la caché.

Consulta también

• get(key)

---

put(key, value)

Agrega un par clave-valor a la caché.

La longitud máxima de una clave es de 250 caracteres. La cantidad máxima de datos que se pueden almacenar por clave es de 100 KB. El valor vence en la caché después de 600 segundos (10 minutos).

El límite de elementos almacenados en caché es de 1,000. Si se escriben más de 1,000 elementos, la caché almacena los 900 elementos más lejanos a la fecha de vencimiento. Este límite puede cambiar.

const cache = CacheService.getScriptCache();
// Puts the value 'bar' into the cache using the key 'foo'
cache.put('foo', 'bar');

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave con la que se almacenará el valor.
value	String	Es el valor que se almacenará en caché.

---

put(key, value, expirationInSeconds)

Agrega un par clave-valor a la caché, con un tiempo de vencimiento (en segundos).

La longitud máxima de una clave es de 250 caracteres. La cantidad máxima de datos que se pueden almacenar por clave es de 100 KB. La hora de vencimiento especificada es solo una sugerencia. Es posible que los datos almacenados en caché se quiten antes de esta hora si se almacenan en caché muchos datos.

El límite de elementos almacenados en caché es de 1,000. Si se escriben más de 1,000 elementos, la caché almacena los 900 elementos más lejanos a la fecha de vencimiento. Este límite puede cambiar.

// Puts the value 'bar' into the cache using the key 'foo', but only for the
// next 20 seconds.
CacheService.getScriptCache().put('foo', 'bar', 20);

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave con la que se almacenará el valor.
value	String	Es el valor que se almacenará en caché.
expirationInSeconds	Integer	Es el tiempo máximo que el valor permanece en la caché, en segundos. El mínimo es de 1 segundo y el máximo es de 21,600 segundos (6 horas).

---

putAll(values)

Agrega un conjunto de pares clave-valor a la caché.

Es similar a las llamadas repetidas a "put", pero más eficiente, ya que solo realiza una llamada. La cantidad de datos que se pueden almacenar por clave es de 100 KB. Los valores vencen en la caché después de 600 segundos (10 minutos).

El límite de elementos almacenados en caché es de 1,000. Si se escriben más de 1,000 elementos, la caché almacena los 900 elementos más lejanos a la fecha de vencimiento. Este límite puede cambiar.

// 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);

Parámetros

Nombre	Tipo	Descripción
values	Object	Objeto JavaScript que contiene claves y valores de cadena.

Consulta también

• put(key, value)

---

putAll(values, expirationInSeconds)

Agrega un conjunto de pares clave-valor a la caché, con un tiempo de vencimiento (en segundos).

Es similar a las llamadas repetidas a "put", pero más eficiente, ya que solo realiza una llamada al servidor de memcache para establecer todos los valores. La longitud máxima de una clave es de 250 caracteres. La cantidad máxima de datos que se pueden almacenar por clave es de 100 KB. El tiempo de vencimiento especificado es solo una sugerencia. Es posible que los datos almacenados en caché se quiten antes de este tiempo si se almacenan en caché muchos datos.

El límite de elementos almacenados en caché es de 1,000. Si se escriben más de 1,000 elementos, la caché almacena los 900 elementos con la fecha de vencimiento más lejana. Este límite puede cambiar.

// 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);

Parámetros

Nombre	Tipo	Descripción
values	Object	Objeto JavaScript que contiene claves y valores de cadena.
expirationInSeconds	Integer	Es el tiempo máximo que el valor permanece en la caché, en segundos. El vencimiento mínimo permitido es de 1 segundo y el vencimiento máximo permitido es de 21, 600 segundos (6 horas). El vencimiento predeterminado es de 600 segundos (10 minutos).

Consulta también

• put(key, value)

---

remove(key)

Quita una entrada de la caché con la clave determinada.

// Removes any cache entries for 'foo'
CacheService.getUserCache().remove('foo');

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave que se quitará de la caché.

---

removeAll(keys)

Quita un conjunto de entradas de la caché.

// Removes entries from the cache with keys 'foo' and 'x'
CacheService.getDocumentCache().removeAll(['foo', 'x']);

Parámetros

Nombre	Tipo	Descripción
keys	String[]	Es el array de claves que se quitarán.