Class CacheService
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
CacheService
O serviço de cache permite acessar um cache para armazenamento de dados de curto prazo.
Essa classe permite acessar uma instância de cache específica. Os caches públicos são para coisas que não
dependem de qual usuário está acessando o script. Os caches privados são para coisas
específicas do usuário, como configurações ou atividades recentes.
Não há garantia de que os dados gravados no cache vão permanecer até o tempo de expiração. Você
precisa estar preparado para receber null de todas as leituras.
Métodos
| Método | Tipo de retorno | Breve descrição |
getDocumentCache() | Cache | Recebe a instância de cache com o escopo definido para o documento e o script atuais. |
getScriptCache() | Cache | Extrai a instância de cache com escopo definido para o script. |
getUserCache() | Cache | Recebe a instância de cache com escopo definido para o usuário e o script atuais. |
Documentação detalhada
getDocumentCache()
Recebe a instância de cache com o escopo definido para o documento e o script atuais. Os caches de documentos são específicos
do documento atual que contém o script. Use-os para armazenar informações de script específicas do documento atual. Se esse método for chamado fora do contexto de um
documento que o contém (como um script independente ou um app da Web), ele vai retornar null.
// Gets a cache that is specific to the current document containing the script
const cache = CacheService.getDocumentCache();
Retornar
Cache: uma instância de cache de documento ou null se não houver um documento que contenha
getScriptCache()
Extrai a instância de cache com escopo definido para o script. Os caches de script são comuns a todos os usuários do
script. Use-os para armazenar informações que não são específicas do usuário atual.
// Gets a cache that is common to all users of the script
const cache = CacheService.getScriptCache();
Retornar
Cache: uma instância de cache de script.
getUserCache()
Recebe a instância de cache com escopo definido para o usuário e o script atuais. Os caches do usuário são específicos para o
usuário atual do script. Use-os para armazenar informações de script específicas do
usuário atual.
// Gets a cache that is specific to the current user of the script
const cache = CacheService.getUserCache();
Retornar
Cache: uma instância de cache do usuário
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003e\u003ccode\u003eCacheService\u003c/code\u003e provides short-term storage for script data, offering document, script, and user-specific scopes.\u003c/p\u003e\n"],["\u003cp\u003eData stored using \u003ccode\u003eCacheService\u003c/code\u003e is not guaranteed to persist and may return \u003ccode\u003enull\u003c/code\u003e when retrieved.\u003c/p\u003e\n"],["\u003cp\u003eThree cache instances are available: \u003ccode\u003egetDocumentCache()\u003c/code\u003e for document-specific data, \u003ccode\u003egetScriptCache()\u003c/code\u003e for script-wide data, and \u003ccode\u003egetUserCache()\u003c/code\u003e for user-specific data.\u003c/p\u003e\n"],["\u003cp\u003eWhen using \u003ccode\u003egetDocumentCache()\u003c/code\u003e, it returns \u003ccode\u003enull\u003c/code\u003e if called outside a document context (standalone script or web app).\u003c/p\u003e\n"]]],[],null,["# Class CacheService\n\nCacheService\n\nCacheService allows you to access a cache for short term storage of data.\n\nThis class lets you get a specific cache instance. Public caches are for things that are not\ndependent on which user is accessing your script. Private caches are for things which are\nuser-specific, like settings or recent activity.\n\nThe data you write to the cache is not guaranteed to persist until its expiration time. You\nmust be prepared to get back `null` from all reads. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------|---------------------------------------------|--------------------------------------------------------------------|\n| [getDocumentCache()](#getDocumentCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the current document and script. |\n| [getScriptCache()](#getScriptCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the script. |\n| [getUserCache()](#getUserCache()) | [Cache](/apps-script/reference/cache/cache) | Gets the cache instance scoped to the current user and script. |\n\nDetailed documentation\n----------------------\n\n### `get``Document``Cache()`\n\nGets the cache instance scoped to the current document and script. Document caches are specific\nto the current document which contains the script. Use these to store script information that\nis specific to the current document. If this method is called outside of the context of a\ncontaining document (such as from a standalone script or web app), this method returns `null`.\n\n```javascript\n// Gets a cache that is specific to the current document containing the script\nconst cache = CacheService.getDocumentCache();\n```\n\n#### Return\n\n\n[Cache](/apps-script/reference/cache/cache) --- a document cache instance, or `null` if there is no containing document\n\n*** ** * ** ***\n\n### `get``Script``Cache()`\n\nGets the cache instance scoped to the script. Script caches are common to all users of the\nscript. Use these to store information that is not specific to the current user.\n\n```javascript\n// Gets a cache that is common to all users of the script\nconst cache = CacheService.getScriptCache();\n```\n\n#### Return\n\n\n[Cache](/apps-script/reference/cache/cache) --- a script cache instance\n\n*** ** * ** ***\n\n### `get``User``Cache()`\n\nGets the cache instance scoped to the current user and script. User caches are specific to the\ncurrent user of the script. Use these to store script information that is specific to the\ncurrent user.\n\n```javascript\n// Gets a cache that is specific to the current user of the script\nconst cache = CacheService.getUserCache();\n```\n\n#### Return\n\n\n[Cache](/apps-script/reference/cache/cache) --- a user cache instance"]]
