Class ScriptProperties

ScriptProperties

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

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

サポート終了のメソッド

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

サポート終了のメソッド

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 を返します。

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

パラメータ

名前	型	説明
key	String	取得する値のキーです。

リターン

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

関連ドキュメント

• 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)

非推奨。この関数は非推奨であるため、新しいスクリプトでは使用できません。

指定されたキーを使用して、指定された値を保持します。このキーに関連付けられている既存の値はすべて上書きされます。

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

パラメータ

名前	型	説明
key	String	プロパティのキー
value	String	その値を使用します。

リターン

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

関連ドキュメント

• getProperty(key)