Class PropertiesService

PropertiesService

1 つのスクリプト、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 - スクリプトの現在のユーザーのみがアクセスできるプロパティ ストア