Class UserProperties
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
PropertiPengguna
Tidak digunakan lagi. Class ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Properti Pengguna adalah pasangan nilai kunci yang unik untuk pengguna. Cakupan Properti Pengguna adalah per pengguna; skrip apa pun yang berjalan dengan identitas pengguna dapat mengakses Properti Pengguna hanya untuk pengguna tersebut.
Metode yang tidak digunakan lagi
Metode yang tidak digunakan lagi
deleteAllProperties()
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Menghapus semua properti.
UserProperties.deleteAllProperties();
Pulang pergi
UserProperties
Lihat juga
deleteProperty(key)
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Menghapus properti dengan kunci yang diberikan.
UserProperties.deleteProperty('special');
Parameter
| Nama | Jenis | Deskripsi |
key | String | kunci untuk properti yang akan dihapus |
Pulang pergi
UserProperties
Lihat juga
getKeys()
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Mendapatkan semua kunci yang tersedia.
Pulang pergi
String[]
getProperties()
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Dapatkan semua properti yang tersedia sekaligus.
Tindakan ini akan memberikan salinan, bukan tampilan langsung, sehingga mengubah properti pada objek yang ditampilkan tidak akan memperbaruinya di penyimpanan dan sebaliknya.
UserProperties.setProperties({
"cow" : "moo",
"sheep" : "baa",
"chicken" : "cluck"
});
// Logs "A cow goes: moo"
Logger.log("A cow goes: %s", UserProperties.getProperty("cow"));
// This makes a copy. Any changes that happen here will not
// be written back to properties.
var animalSounds = UserProperties.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]);
}
Pulang pergi
Object — salinan properti yang berisi key-value pair
getProperty(key)
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Menampilkan nilai yang terkait dengan kunci yang diberikan, atau null jika tidak ada nilai tersebut.
const specialValue = UserProperties.getProperty('special');
Parameter
| Nama | Jenis | Deskripsi |
key | String | kunci untuk nilai yang akan diambil |
Pulang pergi
String — nilai yang terkait dengan kunci
Lihat juga
setProperties(properties)
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Menetapkan secara massal semua properti yang diambil dari objek tertentu.
UserProperties.setProperties({special: 'sauce', 'meaning': 42});
Parameter
| Nama | Jenis | Deskripsi |
properties | Object | objek yang berisi properti yang akan ditetapkan. |
Pulang pergi
UserProperties
Lihat juga
setProperties(properties, deleteAllOthers)
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Menetapkan secara massal semua properti yang diambil dari objek tertentu.
// This deletes all other properties
UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
Parameter
| Nama | Jenis | Deskripsi |
properties | Object | objek yang berisi properti yang akan ditetapkan. |
deleteAllOthers | Boolean | apakah akan menghapus semua properti yang ada. |
Pulang pergi
UserProperties
Lihat juga
setProperty(key, value)
Tidak digunakan lagi. Fungsi ini tidak digunakan lagi dan tidak boleh digunakan dalam skrip baru.
Mempertahankan nilai yang ditentukan dengan kunci yang diberikan. Nilai apa pun yang ada dan terkait dengan kunci ini akan ditimpa.
UserProperties.setProperty('special', 'sauce');
Parameter
| Nama | Jenis | Deskripsi |
key | String | kunci untuk properti |
value | String | nilai yang akan dikaitkan dengan kunci |
Pulang pergi
UserProperties
Lihat juga
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 2025-07-26 UTC."],[[["\u003cp\u003e\u003ccode\u003eUserProperties\u003c/code\u003e is deprecated and should not be used in new scripts.\u003c/p\u003e\n"],["\u003cp\u003eUser Properties are key-value pairs unique to a user, accessible only by scripts running under that user's identity.\u003c/p\u003e\n"],["\u003cp\u003eAll methods within \u003ccode\u003eUserProperties\u003c/code\u003e are deprecated, including those for setting, getting, and deleting properties.\u003c/p\u003e\n"],["\u003cp\u003eDespite being deprecated, \u003ccode\u003eUserProperties\u003c/code\u003e provides functionalities like \u003ccode\u003egetProperties()\u003c/code\u003e which returns a copy of the properties, and \u003ccode\u003edeleteAllProperties()\u003c/code\u003e to remove all properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should avoid using \u003ccode\u003eUserProperties\u003c/code\u003e and explore alternative solutions for managing user-specific data in new scripts.\u003c/p\u003e\n"]]],[],null,["# Class UserProperties\n\nUserProperties\n\n\n**Deprecated.** This class is deprecated and should not be used in new scripts.\n\nUser Properties are key-value pairs unique to a user. User Properties are scoped per user; any\nscript running under the identity of a user can access User Properties for that user only. \n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|------------------------------------------------------------------------------|---------------------|----------------------------------------------------------------------------------------|\n| [deleteAllProperties()](#deleteAllProperties()) | [UserProperties](#) | Deletes all properties. |\n| [deleteProperty(key)](#deleteProperty(String)) | [UserProperties](#) | 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)) | [UserProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperties(properties, deleteAllOthers)](#setProperties(Object,Boolean)) | [UserProperties](#) | Bulk-sets all the properties drawn from the given object. |\n| [setProperty(key, value)](#setProperty(String,String)) | [UserProperties](#) | 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\nUserProperties.deleteAllProperties();\n```\n\n#### Return\n\n\n[UserProperties](#) --- 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\nUserProperties.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[UserProperties](#) --- 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\nUserProperties.setProperties({\n \"cow\" : \"moo\",\n \"sheep\" : \"baa\",\n \"chicken\" : \"cluck\"\n});\n\n// Logs \"A cow goes: moo\"\nLogger.log(\"A cow goes: %s\", UserProperties.getProperty(\"cow\"));\n\n// This makes a copy. Any changes that happen here will not\n// be written back to properties.\nvar animalSounds = UserProperties.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 = UserProperties.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\nUserProperties.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[UserProperties](#) --- 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\nUserProperties.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[UserProperties](#) --- 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\nUserProperties.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[UserProperties](#) --- this object, for chaining\n\n#### See also\n\n- [getProperty(key)](#getProperty(String))"]]
