Class ScriptProperties

ScriptProperties

非推奨。このクラスは非推奨のため、新しいスクリプトでは使用しないでください。

スクリプト プロパティは、スクリプトによって永続ストレージに保存される Key-Value ペアです。スクリプト プロパティは、スクリプトを実行するユーザーに関係なく、スクリプトごとにスコープ設定されます。

サポート終了のメソッド

メソッド	戻り値の型	概要
deleteAllProperties()	ScriptProperties	すべてのプロパティを削除します。
deleteProperty(key)	ScriptProperties	指定されたキーを持つプロパティを削除します。
getKeys()	String[]	使用可能なすべてのキーを取得します。
getProperties()	Object	使用可能なすべてのプロパティを一度に取得します。
getProperty(key)	String|null	指定されたキーに関連付けられた値を返します。そのような値がない場合は null を返します。
setProperties(properties)	ScriptProperties	指定されたオブジェクトから取得したすべてのプロパティを一括設定します。
setProperties(properties, deleteAllOthers)	ScriptProperties	指定されたオブジェクトから取得したすべてのプロパティを一括設定します。
setProperty(key, value)	ScriptProperties	指定された value を指定されたキーで永続化します。

サポート終了のメソッド

deleteAllProperties()

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

すべてのプロパティを削除します。

ScriptProperties.deleteAllProperties();

戻る

ScriptProperties - チェーン用のこのオブジェクト

関連情報

• deleteProperty(key)

---

deleteProperty(key)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定されたキーを持つプロパティを削除します。

ScriptProperties.deleteProperty('special');

パラメータ

名前	タイプ	説明
key	String	削除するプロパティのキー

戻る

ScriptProperties - チェーン用のこのオブジェクト

関連情報

• deleteAllProperties()

---

getKeys()

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

使用可能なすべてのキーを取得します。

戻る

String[]

---

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)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定されたキーに関連付けられた値を返します。そのような値がない場合は null を返します。

const specialValue = ScriptProperties.getProperty('special');

パラメータ

名前	タイプ	説明
key	String	取得する値のキー

戻る

String|null - キーに関連付けられた値

関連情報

• setProperty(key, value)

---

setProperties(properties)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定されたオブジェクトから取得したすべてのプロパティを一括設定します。

ScriptProperties.setProperties({special: 'sauce', 'meaning': 42});

パラメータ

名前	タイプ	説明
properties	Object	設定するプロパティを含むオブジェクト。

戻る

ScriptProperties - チェーン用のこのオブジェクト

関連情報

• setProperty(key, value)

---

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)

非推奨。この関数は非推奨のため、新しいスクリプトでは使用しないでください。

指定された value を指定されたキーで永続化します。このキーに関連付けられている既存の値はすべて上書きされます。

ScriptProperties.setProperty('special', 'sauce');

パラメータ

名前	タイプ	説明
key	String	プロパティのキー
value	String	キーに関連付ける値

戻る

ScriptProperties - チェーン用のこのオブジェクト

関連情報

• getProperty(key)