Class PropertiesService

PropertiesService

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

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

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

メソッド

メソッド戻り値の型概要
getDocumentProperties()Properties開いているドキュメント、スプレッドシート、フォーム内で、すべてのユーザーがアクセスできるプロパティ ストア（このスクリプト専用）を取得します。
getScriptProperties()Propertiesすべてのユーザーがアクセスできるプロパティ ストアを取得します。ただし、このスクリプト内でのみアクセスできます。
getUserProperties()Properties現在のユーザーまたは有効なユーザーのみがアクセスできるプロパティ ストアを、このスクリプト内でのみ取得します。

詳細なドキュメント

getDocumentProperties()

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

戻る

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

getScriptProperties()

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

戻る

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

getUserProperties()

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

戻る

Properties - スクリプトの現在のユーザーまたは有効なユーザーのみがアクセスできるプロパティ ストア。