Class ScriptProperties
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Propiedades de la secuencia de comandos
Obsoleto. Esta clase está obsoleta y no se debe usar en secuencias de comandos nuevas.
Las propiedades de la secuencia de comandos son pares clave-valor que una secuencia de comandos almacena en un almacenamiento persistente. Las propiedades de la secuencia de comandos se asignan por secuencia de comandos, independientemente de qué usuario la ejecute.
Métodos obsoletos
deleteAllProperties()
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Borra todas las propiedades.
ScriptProperties.deleteAllProperties();
Volver
ScriptProperties
: Este objeto, para encadenar
Consulta también
deleteProperty(key)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Borra la propiedad con la clave determinada.
ScriptProperties.deleteProperty('special');
Parámetros
Nombre | Tipo | Descripción |
key | String | clave de la propiedad que se borrará |
Volver
ScriptProperties
: Este objeto, para encadenar
Consulta también
getKeys()
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Obtén todas las claves disponibles.
Volver
String[]
getProperties()
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Obtén todas las propiedades disponibles de una sola vez.
Esto proporciona una copia, no una vista en vivo, por lo que cambiar las propiedades del objeto que se muestra no las actualizará en el almacenamiento ni viceversa.
ScriptProperties.setProperties({
"cow" : "moo",
"sheep" : "baa",
"chicken" : "cluck"
});
// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", ScriptProperties.getProperty("cow"));
// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = ScriptProperties.getProperties();
// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for(var kind in animalSounds) {
Logger.log("A %s goes %s!", kind, animalSounds[kind]);
}
Volver
Object
: Es una copia de las propiedades que contienen pares clave-valor.
getProperty(key)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Muestra el valor asociado con la clave proporcionada o nulo si no hay un valor de ese tipo.
const specialValue = ScriptProperties.getProperty('special');
Parámetros
Nombre | Tipo | Descripción |
key | String | clave del valor que se recuperará |
Volver
String
: Es el valor asociado con la clave.
Consulta también
setProperties(properties)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Establece de forma masiva todas las propiedades extraídas del objeto determinado.
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});
Parámetros
Nombre | Tipo | Descripción |
properties | Object | Un objeto que contiene las propiedades que se deben establecer. |
Volver
ScriptProperties
: Este objeto, para encadenar
Consulta también
setProperties(properties, deleteAllOthers)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Establece de forma masiva todas las propiedades extraídas del objeto determinado.
// This deletes all other properties
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Parámetros
Nombre | Tipo | Descripción |
properties | Object | Un objeto que contiene las propiedades que se deben establecer. |
deleteAllOthers | Boolean | si quieres borrar todas las propiedades existentes. |
Volver
ScriptProperties
: Este objeto, para encadenar
Consulta también
setProperty(key, value)
Obsoleto. Esta función dejó de estar disponible y no se debe usar en secuencias de comandos nuevas.
Conserva el valor especificado en con la clave proporcionada. Se sobrescribirá cualquier valor existente asociado con esta clave.
ScriptProperties.setProperty('special', 'sauce');
Parámetros
Nombre | Tipo | Descripción |
key | String | clave para la propiedad |
value | String | valor para asociar con la clave |
Volver
ScriptProperties
: Este objeto, para encadenar
Consulta también
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003eScriptProperties is deprecated and should not be used in new scripts, serving as a persistent key-value store scoped per script.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for setting, getting, and deleting properties, but these are all deprecated.\u003c/p\u003e\n"],["\u003cp\u003eDespite offering functionalities like bulk operations and property retrieval, developers should refrain from using them in new projects.\u003c/p\u003e\n"],["\u003cp\u003eThe class is primarily for legacy scripts and should be replaced with more modern alternatives for data persistence.\u003c/p\u003e\n"]]],[],null,["# Class ScriptProperties\n\nScriptProperties\n\n\n**Deprecated.** This class is deprecated and should not be used in new scripts.\n\nScript Properties are key-value pairs stored by a script in a persistent store. Script Properties\nare scoped per script, regardless of which user runs the script. \n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------------|\n| [deleteAllProperties()](#deleteAllProperties()) | [ScriptProperties](#) | Deletes all properties. |\n| [deleteProperty(key)](#deleteProperty(String)) | [ScriptProperties](#) | Deletes the property with the given key. |\n| [getKeys()](#getKeys()) | `String[]` | Get all of the available keys. |\n| [getProperties()](#getProperties()) | `Object` | Get all of the available properties at once. |\n| [getProperty(key)](#getProperty(String)) | `String` | Returns the value associated with the provided key, or null if there is no such value. |\n| [setProperties(properties)](#setProperties(Object)) | [ScriptProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperties(properties, deleteAllOthers)](#setProperties(Object,Boolean)) | [ScriptProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperty(key, value)](#setProperty(String,String)) | [ScriptProperties](#) | Persists the specified in value with the provided key. |\n\nDeprecated methods\n------------------\n\n### `delete``All``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes all properties.\n\n```javascript\nScriptProperties.deleteAllProperties();\n```\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteProperty(key)](#deleteProperty(String))\n\n*** ** * ** ***\n\n### `delete``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nDeletes the property with the given key.\n\n```javascript\nScriptProperties.deleteProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|----------------------------|\n| `key` | `String` | key for property to delete |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [deleteAllProperties()](#deleteAllProperties())\n\n*** ** * ** ***\n\n### `get``Keys()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available keys.\n\n#### Return\n\n\n`String[]`\n\n*** ** * ** ***\n\n### `get``Properties()`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nGet all of the available properties at once.\n\nThis gives a copy, not a live view, so changing the properties on the returned object won't\nupdate them in storage and vice versa.\n\n```javascript\nScriptProperties.setProperties({\n \"cow\" : \"moo\",\n \"sheep\" : \"baa\",\n \"chicken\" : \"cluck\"\n});\n\n// Logs \"A cow goes: moo\"\nLogger.log(\"A cow goes: %s\", ScriptProperties.getProperty(\"cow\"));\n\n// This makes a copy. Any changes that happen here will not\n// be written back to properties.\nvar animalSounds = ScriptProperties.getProperties();\n\n// Logs:\n// A chicken goes cluck!\n// A cow goes moo!\n// A sheep goes baa!\nfor(var kind in animalSounds) {\n Logger.log(\"A %s goes %s!\", kind, animalSounds[kind]);\n}\n```\n\n#### Return\n\n\n`Object` --- a copy of the properties containing key-value pairs\n\n*** ** * ** ***\n\n### `get``Property(key)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nReturns the value associated with the provided key, or null if there is no such value.\n\n```javascript\nconst specialValue = ScriptProperties.getProperty('special');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------|----------|-------------------------------|\n| `key` | `String` | key for the value to retrieve |\n\n#### Return\n\n\n`String` --- the value associated with the key\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\nScriptProperties.setProperties({special: 'sauce', 'meaning': 42});\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|--------------|----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Properties(properties, deleteAllOthers)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nBulk-sets all the properties drawn from the given object.\n\n```javascript\n// This deletes all other properties\nScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------|-----------|---------------------------------------------|\n| `properties` | `Object` | an object containing the properties to set. |\n| `delete``All``Others` | `Boolean` | whether to delete all existing properties. |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [setProperty(key, value)](#setProperty(String,String))\n\n*** ** * ** ***\n\n### `set``Property(key, value)`\n\n\n**Deprecated.** This function is deprecated and should not be used in new scripts.\n\nPersists the specified in value with the provided key. Any existing value associated with this\nkey will be overwritten.\n\n```javascript\nScriptProperties.setProperty('special', 'sauce');\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------------------|\n| `key` | `String` | key for property |\n| `value` | `String` | value to associate with the key |\n\n#### Return\n\n\n[ScriptProperties](#) --- this object, for chaining\n\n#### See also\n\n- [getProperty(key)](#getProperty(String))"]]