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