※現在、DomainUser/UserManagerは、Deprecated（非推奨）となっており、今後使えなくなる予定です。本記事は、「間もなく使えなくなる」ということを念頭に置いてお読み下さい。「Google Apps Script」という名前でありながら、
Google Appsに関する機能というのはあまり充実していなかった感があります。が、ようやくGoogle Apps管理の機能が追加されました。
Domain Servicesと呼ばれるもので、Google Appsの登録ドメインの詳細を扱うためのサービスのようです。現時点ではユーザー管理のためのクラスが用意されています。
Google Appsでは、専用のドメインを登録し、そのドメインのユーザーを管理画面から作成して利用します。このユーザーを管理するクラスが「
UserManager」です。このクラスには、ドメインの登録ユーザーの情報を取得するためのメソッドがいろいろと用意されています。
これらのメソッドを使って取得されるユーザー情報は、「
DomainUser」というクラスのオブジェクトの形になっています。このオブジェクトには、ユーザーに関する各種の情報を取得するためのメソッド類が用意されています。これらを呼び出すことで、ユーザーの各種情報が手に入ります。またいくつかの情報に関しては、値を変更するメソッドも用意されています。
この
UserManagerと
DomainUserの基本を理解することが、
Domain Servicesを活用するための基本だといってよいでしょう。
UserManagerから
DomainUserを取得するためのメソッドには、以下のようなものがあります。
変数 = UserManager.getAllUsers();
ドメインに登録されているすべてのユーザーを
DomainUser配列として返します。
変数 = UserManager.getUser( 利用者名 );
引数に指定した名前の
DomainUserオブジェクトを返します。引数に指定するのは、登録されているアカウントの名前です。例えば、
syoda@tuyano.comのユーザーなら、アカウント名は「
syoda」となります。
変数 = UserManager.getUser( [User] );
引数に
Userオブジェクトを指定して
DomainUserオブジェクトを取得するものです。ユーザー情報というのは
Domain Servicesだけでなく、他のサービスでも扱われることがあります。これは、そうした場合に得られる
Userから
DomainUserを得るためのものです。
とりあえず、この３種のメソッドを覚えておけば、ドメインから必要なユーザー情報を
DomainUserとして取り出せるようになります。この他、以下のメソッドも覚えておくとよいでしょう。
変数 = UserManager.getDomain();
ドメイン名を取得するメソッドです。返り値は、ドメイン名をテキストで表したものになります。