GASのプロパティサービス(プロパティストア)とは？3種類の各特徴と使い分け方まとめ

2023年6月11日2023年7月8日

Google Apps Script(GAS)には、プロパティサービス(プロパティストア)と呼ばれる、コードとは別にデータを格納できる機能があります。

プロパティサービスはスクリプトプロパティ、ユーザープロパティ、ドキュメントプロパティの3種類です。

それぞれの特徴と3つのプロパティサービスをどのように使い分けるか解説します。

GASのプロパティサービスとは

Google Apps Script(GAS)にはプロパティサービス(プロパティストア)と呼ばれる機能が用意されています。

プロパティサービスでは、「キーと値」をペアにする形で値や文字列などのデータを保管することが可能です。

例えば、キー：AGE、値：22といった形でGASプロジェクト上にデータを保存しておけます。

通常のGASスクリプトを実行したデータはそのままでは保存して次回の実行に利用することはできませんが、プロパティサービスを利用すればそうした活用も可能です。

また、プロパティサービスはコード上に記述したくない秘密情報を保管しておくことに適しています。

例えば、APIキーやアクセストークン、パスワードなどの悪用されうるものです。

これらをコード上に記述していると、コードが流出すると秘密情報も一緒に漏れてしまいます。

そうした秘匿しておきたい情報を保存するのに、GASのプロパティは便利です。

Google Apps Script(GAS)のプロパティサービスは、3種類用意されています。

それぞれのプロパティにはデータが保存される場所が異なっています。

そこで、スクリプトプロパティ、ユーザープロパティ、ドキュメントプロパティの特徴を紹介します。

Google Apps Script(GAS)のプロパティサービスで最もよく使われるのがスクリプトプロパティです。

スクリプトプロパティはGASプロジェクトに紐づく形で値が保存されます。

そのため、同じGASプロジェクトを編集できるユーザーと共有可能です。

さらに、スクリプトプロパティはGASのスクリプトエディタ上の、プロジェクトの設定からGUI操作で追加・閲覧・削除ができます。

GUIによるプロパティストアの操作は、スクリプトプロパティ唯一の機能です。

ユーザープロパティはGASプロジェクトを実行するユーザーに紐づく形で値が保存されます。

スクリプトプロパティは、GASプロジェクトにアクセスできるユーザー全てが参照できます。

それに対してユーザープロパティは、ユーザープロパティを保存したユーザー以外は取得できません。

個人のパスワードのような、他のGAS実行ユーザーにも知られたくないより秘匿すべき情報を格納するのにユーザープロパティは適しています。

3つ目のドキュメントプロパティはスクリプトプロパティとユーザープロパティに比べると利用頻度は少ないです。

ドキュメントプロパティではドキュメントにデータが紐づいています。

コンテナバインドスクリプトを持つGoogleドキュメントやスプレッドシート、Googleスライドが保存先です。

上記の定義を聞くと、1つのドキュメントに紐づいた複数のGASプロジェクトでドキュメントプロパティを参照できるように感じます。

しかし、実際にはGASプロジェクトAで設定したドキュメントプロパティは、別のGASプロジェクトBから参照することはできません。

各種Googleドキュメント×GASプロジェクトの組み合わせでデータが紐づいているようです。

また、ドキュメントプロパティは保存先がスプレッドシートになるため、コンテナバインドスクリプトのみで実行可能で、スタンドアロンスクリプトでは利用できません。

スクリプトプロパティ、ユーザープロパティ、ドキュメントプロパティ3つを解説しましたが、どのように使い分ければよいでしょうか。

それぞれの特徴を表でまとめると、以下の通りです。