サイト名

初心者必見！GASでドキュメントのプロパティサービスを活用する方法

GASでドキュメントのプロパティサービスってどうやって活用するんだろう？なんか便利そうだけど、まだ手を出せてなくて…。
猫男
猫男
catman
catman
よし、catmanが解説しよう！この方法を知ると、ドキュメントの管理がとても楽になるのさ。

GASでドキュメントのプロパティを扱う基本

GAS（Google Apps Script）では、ドキュメントのプロパティを管理するためにドキュメント プロパティサービスを活用することができる。

プロパティは、ドキュメントに設定するメタ情報のようなものさ。

プロパティを設定する

ドキュメントにプロパティを設定するにはこうするんだ。


function setDocumentProperty() {

  var properties = PropertiesService.getDocumentProperties();
  properties.setProperty("author", "catman");
  
}

このスクリプトでは、PropertiesService.getDocumentProperties()を使い、”author”というキーに”catman”という値を設定した。

プロパティを取得する

設定したプロパティを取得する場合は次のようにする。


function getDocumentProperty() {

  var properties = PropertiesService.getDocumentProperties();
  var author = properties.getProperty("author");
  Logger.log(author);

}

プロパティを取得するときも、まずはPropertiesService.getDocumentProperties()を呼び出し、getPropertyメソッドでキーを指定して値を取得する。

なぜドキュメント プロパティが重要なのか

ドキュメントのプロパティを使うと、いくつかの利点がある。

情報の一元管理

プロパティを使うと、ドキュメントに関する情報を一か所で管理できる。
例えば、著者名や作成日を簡単に保存しておきたいときに便利だ。

状態の保存

ドキュメントの状態を保存する際にも使える。
例えば、ドキュメントが承認済みかどうかといった状況をプロパティで管理すれば、後で確認しやすい。

GASでのドキュメント プロパティ操作を手軽に行おう

  • PropertiesService.getDocumentProperties() を利用して、ドキュメントのプロパティにアクセスする。
  • setPropertyでプロパティを設定し、getPropertyでプロパティを取得する。
  • 情報を一元管理する手段として非常に有効。
なるほど！状態管理とか情報の一元管理に使えるんですね。もっと活用したくなってきました！
猫男
猫男
catman
catman
実際に手を動かしてみると、もっと理解できるようになるさ！次は練習問題に挑戦だ！

練習問題：GASでドキュメントプロパティを操作する

ドキュメントにユーザーの役割をプロパティとして保存し、後でその役割を取得してログに出力せよ。

 

解答・解説


function setAndLogRoleProperty() {

  var properties = PropertiesService.getDocumentProperties();
  properties.setProperty("userRole", "editor");

  var role = properties.getProperty("userRole");
  Logger.log(role);

}

このスクリプトでは、まずドキュメントに対して”userRole”というプロパティを”editor”という値で設定した。
その後、同じプロパティを取得し、Logger.logでログに出力している。
この方法で、ドキュメントにメタ情報を保存して簡単に再利用することができるようになるんだ。

関連記事