非推奨。このクラスは非推奨のため、新しいスクリプトでは使用しないでください。
スクリプト プロパティは、スクリプトによって永続ストアに格納される Key-Value ペアです。スクリプトのプロパティ どのユーザーがスクリプトを実行するかにかかわらず、スクリプトごとにスコープが限定されます。
サポート終了のメソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
|
| すべてのプロパティを削除します。 |
|
| 指定されたキーのプロパティを削除します。 |
| String[] | 使用可能なすべての鍵を取得します。 |
| Object | 使用可能なすべてのプロパティを一度に取得します。 |
| String | 指定されたキーに関連付けられた値を返します。値がない場合は null を返します。 |
|
| 指定されたオブジェクトから取得されるすべてのプロパティを一括設定します。 |
|
| 指定されたオブジェクトから取得されるすべてのプロパティを一括設定します。 |
|
| 指定された値を指定されたキーで保持します。 |
サポート終了のメソッド
deleteAllProperties()
deleteAllProperties()
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
すべてのプロパティを削除します。
ScriptProperties.deleteAllProperties();
戻る
- このオブジェクト(チェーン用)ScriptProperties
関連情報
deleteProperty(key)
deleteProperty(key)
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
指定されたキーのプロパティを削除します。
ScriptProperties.deleteProperty('special');
パラメータ
名前 | 型 | 説明 |
---|---|---|
key | String | 削除するプロパティのキー |
戻る
- このオブジェクト(チェーン用)ScriptProperties
関連情報
getKeys()
getKeys()
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
使用可能なすべての鍵を取得します。
戻る
String[]
getProperties()
getProperties()
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
使用可能なすべてのプロパティを一度に取得します。
この場合、ライブビューではなくコピーが提供されるため、返されたオブジェクトのプロパティを変更しても、 ストレージで更新することも、その逆も可能です。
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]); }
戻る
Object
- Key-Value ペアを含むプロパティのコピー
getProperty(key)
getProperty(key)
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
指定されたキーに関連付けられた値を返します。値がない場合は null を返します。
var specialValue = ScriptProperties.getProperty('special');
パラメータ
名前 | 型 | 説明 |
---|---|---|
key | String | 取得する値のキー |
戻る
String
- キーに関連付けられた値
関連情報
setProperties(properties)
setProperties(properties)
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
指定されたオブジェクトから取得されるすべてのプロパティを一括設定します。
ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});
パラメータ
名前 | 型 | 説明 |
---|---|---|
properties | Object | 設定するプロパティを含むオブジェクト。 |
戻る
- このオブジェクト(チェーン用)ScriptProperties
関連情報
setProperties(properties, deleteAllOthers)
setProperties(properties, deleteAllOthers)
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
指定されたオブジェクトから取得されるすべてのプロパティを一括設定します。
// This deletes all other properties ScriptProperties.setProperties({special: 'sauce', 'meaning': 42}, true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
properties | Object | 設定するプロパティを含むオブジェクト。 |
deleteAllOthers | Boolean | 既存のすべてのプロパティを削除するかどうかを指定できます。 |
戻る
- このオブジェクト(チェーン用)ScriptProperties
関連情報
setProperty(key, value)
setProperty(key, value)
非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。
指定された値を指定されたキーで保持します。これに関連付けられている既存の値で キーが上書きされます。
ScriptProperties.setProperty('special', 'sauce');
パラメータ
名前 | 型 | 説明 |
---|---|---|
key | String | プロパティのキー |
value | String | そのキーに関連付ける値を指定します。 |
戻る
- このオブジェクト(チェーン用)ScriptProperties