Class PropertiesService

PropertiesService

スクリプトは、1 つのスクリプト、1 つのスクリプトのユーザー、または 1 つのアドオンが使用されるドキュメントにスコープされた Key-Value ペア形式のシンプルなデータを保存できます。スクリプト間でプロパティを共有することはできません。各タイプのプロパティを使用する条件について詳しくは、プロパティ サービスに関するガイドをご覧ください。

// Sets three properties of different types.
var documentProperties = PropertiesService.getDocumentProperties();
var scriptProperties = PropertiesService.getScriptProperties();
var userProperties = PropertiesService.getUserProperties();

documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
userProperties.setProperty('DISPLAY_UNITS', 'metric');

Methods

方法戻り値の型概要
getDocumentProperties()Propertiesすべてのユーザーが開いているドキュメント、スプレッドシート、フォームからアクセスできるプロパティ ストア(このスクリプトのみ)を取得します。
getScriptProperties()Propertiesこのスクリプト内からのみ、すべてのユーザーがアクセスできるプロパティ ストアを取得します。
getUserProperties()Properties現在のユーザーのみがこのスクリプト内でのみアクセスできるプロパティ ストアを取得します。

詳細なドキュメント

getDocumentProperties()

すべてのユーザーが開いているドキュメント、スプレッドシート、フォームからアクセスできるプロパティ ストア(このスクリプトのみ)を取得します。これは、スクリプトがアドオンとして公開され、実行中の場合、または Google ファイル形式にバインドされている場合にのみ使用できます。ドキュメント プロパティが利用できない場合、このメソッドは null を返します。スクリプトが作成したドキュメントのプロパティに、そのスクリプト以外からアクセスすることはできません。同じドキュメントにアクセスする他のスクリプトからアクセスすることもできません。

戻る

Properties - 現在のドキュメントのすべてのユーザーがアクセスできるこのスクリプトのプロパティ ストア。スクリプトがアドオンまたは Google Workspace ファイルにバインドされていない場合は null


getScriptProperties()

このスクリプト内からのみ、すべてのユーザーがアクセスできるプロパティ ストアを取得します。

戻る

Properties - スクリプトのすべてのユーザーがアクセスできるプロパティ ストア


getUserProperties()

現在のユーザーのみがこのスクリプト内でのみアクセスできるプロパティ ストアを取得します。

戻る

Properties - スクリプトの現在のユーザーのみがアクセスできるプロパティ ストア