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