Class UserProperties

ユーザー プロパティ

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

ユーザー プロパティは、ユーザーに固有の Key-Value ペアです。ユーザー プロパティはユーザーごとにスコープが設定されます。ユーザーの ID で実行されるスクリプトは、そのユーザーのユーザー プロパティにのみアクセスできます。

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

サポート終了のメソッド

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

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

UserProperties.deleteAllProperties();

戻る

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

関連情報

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

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

UserProperties.deleteProperty('special');

パラメータ

名前型説明
keyString削除するプロパティのキー

戻る

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

関連情報

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

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

戻る

String[]

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

使用可能なすべてのプロパティを一度に取得します。

これはライブビューではなくコピーを取得するため、返されたオブジェクトのプロパティを変更しても、ストレージ内のプロパティは更新されません。その逆も同様です。

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]);
}

戻る

Object - Key-Value ペアを含むプロパティのコピー

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

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

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

パラメータ

名前型説明
keyString取得する値のキー

戻る

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

関連情報

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

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

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

パラメータ

名前型説明
propertiesObject設定するプロパティを含むオブジェクト。

戻る

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

関連情報

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

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

// This deletes all other properties
UserProperties.setProperties({special: 'sauce', 'meaning': 42}, true);

パラメータ

名前型説明
propertiesObject設定するプロパティを含むオブジェクト。
deleteAllOthersBoolean既存のプロパティをすべて削除するかどうか。

戻る

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

関連情報

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

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

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

パラメータ

名前型説明
keyStringプロパティのキー
valueStringキーに関連付ける値

戻る

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

関連情報