このページは Cloud Translation API によって翻訳されました。

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