# Google Apps Provisioning の使用法

Google Apps はドメイン管理者向けのサービスで、Google の提供する メールやカレンダー、Docs & Spreadsheets などをユーザに使用させることができます。 Provisioning API は、 これらのサービスをプログラム上から設定するためのインターフェイスです。 特に、この API を使用すると ユーザアカウントやニックネーム、メーリングリストなどの追加、取得、 更新、削除ができるようになります。

このライブラリは Provisioning API バージョン 2.0 を実装しています。 Provisioning API であなたのアカウントにアクセスできるようにするには、 Google Apps コントロールパネル上で手動で有効にする必要があります。 この機能を利用できるのは、特定の種別のアカウントだけに限られます。

Google Apps Provisioning API の使用法や API にアクセスできるようにするための方法については Provisioning API V2.0 Reference を参照ください。

## 認証

Provisioning API は AuthSub による認証をサポートしておらず、 匿名でのアクセスはできません。すべての HTTP 接続は ClientAuth で認証を済ませている必要があります。

## 現在のドメインの設定

Provisioning API を使用するには、 すべてのリクエスト URI で対象のドメインを指定する必要があります。 開発を楽に進めるために、この情報は Gapps サービスクラスとクエリクラスの両方で保持するようにしています。

### サービスクラスへのドメインの設定

リクエスト対象のドメインをサービスクラスに設定するには、 `setDomain()` をコールするか、 あるいはサービスクラスのインスタンスの作成時に指定します。 たとえば次のようになります。

    $domain = "example.com";
    $gdata = new Zend_Gdata_Gapps($client, $domain);

### クエリクラスへのドメインの設定

リクエスト対象のドメインをクエリクラスに設定する方法は、 サービスクラスの場合と同じです。 `setDomain()` をコールするか、 あるいはクエリの作成時に指定します。 たとえば次のようになります。

    $domain = "example.com";
    $query = new Zend_Gdata_Gapps_UserQuery($domain, $arg);

サービスクラスのファクトリメソッドでクエリを作成する際は、 サービスクラスが自動的にクエリクラスのドメインを設定します。 したがってこの場合は、 コンストラクタの引数でドメインを指定する必要がなくなります。

    $domain = "example.com";
    $gdata = new Zend_Gdata_Gapps($client, $domain);
    $query = $gdata->newUserQuery($arg);

## ユーザの操作

Google Apps がホストするドメイン上のユーザアカウントは、 `Zend_Gdata_Gapps_UserEntry` のインスタンスで表されます。 このクラスを使用すると、 アカウント名やユーザ名、パスワード、アクセス権限、 そして容量制限などすべての情報にアクセスできるようになります。

### ユーザアカウントの作成

ユーザアカウントを作成するには、 `createUser()` メソッドを使用します。

    $gdata->createUser('foo', 'Random', 'User', '••••••••');

あるいは UserEntry のインスタンスから作成することもできます。 作成したインスタンスに対してユーザ名や姓、名、パスワードを設定し、 サービスオブジェクトの `insertUser()` をコールすることでそのエントリをサーバにアップロードします。

    $user = $gdata->newUserEntry();
    $user->login = $gdata->newLogin();
    $user->login->username = 'foo';
    $user->login->password = '••••••••';
    $user->name = $gdata->newName();
    $user->name->givenName = 'Random';
    $user->name->familyName = 'User';
    $user = $gdata->insertUser($user);

ユーザのパスワードは、通常はプレーンテキストで指定しなければなりません。 `login->passwordHashFunction` を 'SHA-1' に設定した場合は、パスワードを SHA-1 ダイジェスト形式で指定することもできます。

### ユーザアカウントの取得

各ユーザアカウントを取得するには `retrieveUser()` メソッドをコールします。 ユーザが見つからない場合は `NULL` が返されます。

    $user = $gdata->retrieveUser('foo');

    echo 'ユーザ名: ' . $user->login->userName . "\n";
    echo '名前: ' . $user->login->givenName . "\n";
    echo '苗字: ' . $user->login->familyName . "\n";
    echo '凍結中？: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
    echo '管理者？: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
    echo 'パスワードの変更が必要？: ' .
         ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
    echo '規約に同意した？: ' .
         ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

もうひとつの方法は、まず `Zend_Gdata_Gapps_UserQuery` のインスタンスを作成して username プロパティを (取得したいユーザのユーザ名に) 設定し、サービスオブジェクトの `getUserEntry()` をコールするものです。

    $query = $gdata->newUserQuery('foo');
    $user = $gdata->getUserEntry($query);

    echo 'ユーザ名: ' . $user->login->userName . "\n";
    echo '名前: ' . $user->login->givenName . "\n";
    echo '苗字: ' . $user->login->familyName . "\n";
    echo '凍結中？: ' . ($user->login->suspended ? 'Yes' : 'No') . "\n";
    echo '管理者？: ' . ($user->login->admin ? 'Yes' : 'No') . "\n"
    echo 'パスワードの変更が必要？: ' .
         ($user->login->changePasswordAtNextLogin ? 'Yes' : 'No') . "\n";
    echo '規約に同意した？: ' .
         ($user->login->agreedToTerms ? 'Yes' : 'No') . "\n";

指定したユーザが発見できない場合は ServiceException がスローされ、エラーコード `Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST` を返します。ServiceExceptions については を参照ください。

### ドメイン内のすべてのユーザの取得

ドメイン内のすべてのユーザを取得するには、 `retrieveAllUsers()` メソッドをコールします。

    $feed = $gdata->retrieveAllUsers();

    foreach ($feed as $user) {
        echo "  * " . $user->login->username . ' (' . $user->name->givenName .
            ' ' . $user->name->familyName . ")\n";
    }

これは `Zend_Gdata_Gapps_UserFeed` オブジェクトを作成します。 このオブジェクトは、ドメイン上の各ユーザの情報を保持しています。

あるいは、何もオプションを指定せずに `getUserFeed()` をコールする方法もあります。 大きなドメインでは、このフィードが サーバ側で複数ページに分割される可能性があることに注意しましょう。 ページ分割についての詳細は を参照ください。

    $feed = $gdata->getUserFeed();

    foreach ($feed as $user) {
        echo "  * " . $user->login->username . ' (' . $user->name->givenName .
            ' ' . $user->name->familyName . ")\n";
    }

### ユーザアカウントの更新

ユーザアカウントを更新するいちばん簡単な方法は、 まず先ほどの方法でユーザを取得し、 必要な箇所を変更し、最後にそのユーザの `save()` をコールするというものです。 これにより、変更内容がサーバに反映されます。

    $user = $gdata->retrieveUser('foo');
    $user->name->givenName = 'Foo';
    $user->name->familyName = 'Bar';
    $user = $user->save();

#### ユーザのパスワードのリセット

ユーザのパスワードをリセットして新しい値を設定するには、 `login->password` プロパティを変更します。

    $user = $gdata->retrieveUser('foo');
    $user->login->password = '••••••••';
    $user = $user->save();

現在のパスワードをこの方式で取得することはできません。 セキュリティ上の理由により、Provisioning API では現在のパスワードを取得できないようになっているからです。

#### ユーザに強制的にパスワードを変更させる

次にログインしたときに強制的にパスワードを変更させるようにするには、 `login->changePasswordAtNextLogin` を `TRUE` に設定します。

    $user = $gdata->retrieveUser('foo');
    $user->login->changePasswordAtNextLogin = true;
    $user = $user->save();

同様に、強制しないようにするなら `login->changePasswordAtNextLogin` を `FALSE` に設定します。

#### ユーザアカウントの凍結

ユーザのログインを制限したいがアカウント自体は残しておきたいという場合は、 そのアカウントを凍結します。 アカウントを凍結したり凍結を解除したりするには `suspendUser()` メソッドおよび `restoreUser()` メソッドを使用します。

    $gdata->suspendUser('foo');
    $gdata->restoreUser('foo');

あるいは、UserEntry のプロパティ `login->suspended` を `TRUE` に設定します。

    $user = $gdata->retrieveUser('foo');
    $user->login->suspended = true;
    $user = $user->save();

アクセス制限を解除するには、同様に `login->suspended` を `FALSE` に設定します。

#### 管理者権限の付与

ユーザに対してドメインの管理者権限を付与するには、プロパティ `login->admin` を `TRUE` に設定します。

    $user = $gdata->retrieveUser('foo');
    $user->login->admin = true;
    $user = $user->save();

だいたい予想はつくでしょうが、 `login->admin` プロパティを `FALSE` に設定すれば管理者権限を剥奪することができます。

### ユーザアカウントの削除

ユーザアカウントを削除するには、単純に UserEntry の `delete()` をコールするだけです。

    $user = $gdata->retrieveUser('foo');
    $user->delete();

そのアカウントの UserEntry オブジェクトが手元にないのなら、 `deleteUser()` メソッドを使用します。

    $gdata->deleteUser('foo');

## ニックネームの操作

ニックネームは、既存のユーザのメールアドレスのエイリアスとなります。 ニックネームには、name と owner のふたつのプロパティがあります。 あるニックネームあてに送信されたメールは、 そのニックネームの持ち主であるユーザに転送されます。

ニックネームは `Zend_Gdata_Gapps_NicknameEntry` のインスタンスで表されます。

### ニックネームの作成

ニックネームを作成するには `createNickname()` メソッドをコールします。

    $gdata->createNickname('foo', 'bar');

あるいは NicknameEntry のインスタンスから作成することもできます。 作成したインスタンスに対して名前と所有者を設定し、 サービスオブジェクトの `insertNickname()` をコールすることでそのエントリをサーバにアップロードします。

    $nickname = $gdata->newNicknameEntry();
    $nickname->login = $gdata->newLogin('foo');
    $nickname->nickname = $gdata->newNickname('bar');
    $nickname = $gdata->insertNickname($nickname);

### ニックネームの取得

ニックネームを取得するには `retrieveNickname()` メソッドをコールします。 ユーザが見つからない場合は `NULL` が返されます。

    $nickname = $gdata->retrieveNickname('bar');

    echo 'ニックネーム: ' . $nickname->nickname->name . "\n";
    echo '所有者: ' . $nickname->login->username . "\n";

もうひとつの方法は、まず `Zend_Gdata_Gapps_NicknameQuery` のインスタンスを作成して nickname プロパティを (取得したいニックネームに) 設定し、サービスオブジェクトの `getNicknameEntry()` をコールするものです。

    $query = $gdata->newNicknameQuery('bar');
    $nickname = $gdata->getNicknameEntry($query);

    echo 'ニックネーム: ' . $nickname->nickname->name . "\n";
    echo '所有者: ' . $nickname->login->username . "\n";

ユーザの場合と同様、指定したニックネームが発見できない場合は ServiceException がスローされ、エラーコード `Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST` を返します。ServiceExceptions については を参照ください。

### あるユーザのすべてのニックネームの取得

指定したユーザのすべてのニックネームを取得するには、 `retrieveNicknames()` メソッドをコールします。

    $feed = $gdata->retrieveNicknames('foo');

    foreach ($feed as $nickname) {
        echo '  * ' . $nickname->nickname->name . "\n";
    }

これは `Zend_Gdata_Gapps_NicknameFeed` オブジェクトを作成します。 このオブジェクトは、指定したユーザのニックネームに関する情報を保持します。

あるいは、新しい `Zend_Gdata_Gapps_NicknameQuery` を作成して username プロパティをそのユーザに設定し、 サービスオブジェクトの `getNicknameFeed()` をコールすることもできます。

    $query = $gdata->newNicknameQuery();
    $query->setUsername('foo');
    $feed = $gdata->getNicknameFeed($query);

    foreach ($feed as $nickname) {
        echo '  * ' . $nickname->nickname->name . "\n";
    }

### ドメイン内のすべてのニックネームの取得

フィード内のすべてのニックネームを取得するには、 `retrieveAllNicknames()` メソッドをコールします。

    $feed = $gdata->retrieveAllNicknames();

    foreach ($feed as $nickname) {
        echo '  * ' . $nickname->nickname->name . ' => ' .
            $nickname->login->username . "\n";
    }

これは `Zend_Gdata_Gapps_NicknameFeed` オブジェクトを作成します。 このオブジェクトは、ドメイン上の各ニックネームの情報を保持しています。

あるいは、サービスオブジェクトの `getNicknameFeed()` を引数なしでコールする方法もあります。

    $feed = $gdata->getNicknameFeed();

    foreach ($feed as $nickname) {
        echo '  * ' . $nickname->nickname->name . ' => ' .
            $nickname->login->username . "\n";
    }

### ニックネームの削除

ニックネームを削除するには、単純に NicknameEntry の `delete()` をコールするだけです。

    $nickname = $gdata->retrieveNickname('bar');
    $nickname->delete();

そのニックネームの NicknameEntry オブジェクトが手元にないのなら、 `deleteNickname()` メソッドを使用します。

    $gdata->deleteNickname('bar');

## メーリングリストの操作

メーリングリストは、複数のユーザのメールアドレスを ひとつのメールアドレスに対応させるものです。 このドメインのメンバー以外であっても、 メーリングリストに参加することができます。

ドメイン上のメーリングリストの情報は、 `Zend_Gdata_Gapps_EmailListEntry` のインスタンスとして表されます。

### メーリングリストの作成

メーリングリストを作成するには `createEmailList()` メソッドを使用します。

    $gdata->createEmailList('friends');

あるいは EmailListEntry のインスタンスから作成することもできます。 作成したインスタンスに対してメーリングリストの名前を設定し、 サービスオブジェクトの `insertEmailList()` をコールすることでそのエントリをサーバにアップロードします。

    $list = $gdata->newEmailListEntry();
    $list->emailList = $gdata->newEmailList('friends');
    $list = $gdata->insertEmailList($list);

### あるアカウントが購読しているすべてのメーリングリストの取得

特定の参加者が購読しているすべてのメーリングリストを取得するには `retrieveEmailLists()` メソッドをコールします。

    $feed = $gdata->retrieveEmailLists('baz@somewhere.com');

    foreach ($feed as $list) {
        echo '  * ' . $list->emailList->name . "\n";
    }

これは `Zend_Gdata_Gapps_EmailListFeed` オブジェクトを作成します。 このオブジェクトは、指定した参加者に関連するメーリングリストの情報を保持します。

あるいは、新しい `Zend_Gdata_Gapps_EmailListQuery` を作成して recipient プロパティをそのメールアドレスに設定し、 サービスオブジェクトの `getEmailListFeed()` をコールすることもできます。

    $query = $gdata->newEmailListQuery();
    $query->setRecipient('baz@somewhere.com');
    $feed = $gdata->getEmailListFeed($query);

    foreach ($feed as $list) {
        echo '  * ' . $list->emailList->name . "\n";
    }

### ドメイン内のすべてのメーリングリストの取得

ドメイン内のすべてのメーリングリストを取得するには `retrieveAllEmailLists()` メソッドをコールします。

    $feed = $gdata->retrieveAllEmailLists();

    foreach ($feed as $list) {
        echo '  * ' . $list->emailList->name . "\n";
    }

これは `Zend_Gdata_Gapps_EmailListFeed` オブジェクトを作成します。 このオブジェクトは、ドメイン上の各メーリングリストに関する情報を保持します。

あるいは、サービスオブジェクトの `getEmailListFeed()` を引数なしでコールする方法もあります。

    $feed = $gdata->getEmailListFeed();

    foreach ($feed as $list) {
        echo '  * ' . $list->emailList->name . "\n";
    }

### メーリングリストの削除

メーリングリストを削除するには deleteEmailList() メソッドをコールします。

    $gdata->deleteEmailList('friends');

## メーリングリストの参加者の操作

メーリングリストの各参加者は、 `Zend_Gdata_Gapps_EmailListRecipient` のインスタンスとして表されます。 このクラスを使用すると、メーリングリストにメンバーを追加したり、 そこからメンバーを削除したりすることができます。

### メーリングリストへの参加者の追加

メーリングリストにメンバーを追加するには `addRecipientToEmailList()` メソッドをコールします。

    $gdata->addRecipientToEmailList('bar@somewhere.com', 'friends');

### メーリングリストの参加者一覧の取得

`retrieveAllRecipients()` メソッドを使用すると、メーリングリストの参加者一覧を取得できます。

    $feed = $gdata->retrieveAllRecipients('friends');

    foreach ($feed as $recipient) {
        echo '  * ' . $recipient->who->email . "\n";
    }

あるいは、新しい EmailListRecipientQuery を作成して emailListName プロパティをそのメーリングリストに設定し、 サービスオブジェクトの `getEmailListRecipientFeed()` をコールすることもできます。

    $query = $gdata->newEmailListRecipientQuery();
    $query->setEmailListName('friends');
    $feed = $gdata->getEmailListRecipientFeed($query);

    foreach ($feed as $recipient) {
        echo '  * ' . $recipient->who->email . "\n";
    }

これは `Zend_Gdata_Gapps_EmailListRecipientFeed` オブジェクトを作成します。 このオブジェクトは、指定したメーリングリストの各参加者に関する情報を保持します。

### ある参加者のメーリングリストからの削除

メーリングリストからメンバーを削除するには `removeRecipientFromEmailList()` メソッドをコールします。

    $gdata->removeRecipientFromEmailList('baz@somewhere.com', 'friends');

## エラー処理

`Zend_Gdata` が標準でスローする例外に加えて、 Provisioning API によるリクエストでは `Zend_Gdata_Gapps_ServiceException` がスローされる可能性があります。これらの例外は、 API 固有のエラーが原因でリクエストが失敗したことを表します。

ServiceException のインスタンスには、 ひとつあるいは複数の Error オブジェクトが含まれます。 これらのオブジェクトにはエラーコードとエラーの原因、そして (オプションで) その例外を引き起こした入力が含まれます。 エラーコードの完全な一覧は、Zend Framework API ドキュメントで `Zend_Gdata_Gapps_Error` の部分を参照ください。 さらに、正式なエラーの一覧は Google Apps Provisioning API V2.0 Reference: Appendix D で見ることができます。

ServiceException に含まれるすべてのエラーの一覧は `getErrors()` で配列として取得できますが、 特定のエラーが発生したのかどうかだけを知りたいこともあります。 そのような場合には `hasError()` をコールします。

以下の例は、 リクエストしたリソースが存在しなかった場合を検出し、 適切に処理するものです。

    function retrieveUser ($username) {
        $query = $gdata->newUserQuery($username);
        try {
            $user = $gdata->getUserEntry($query);
        } catch (Zend_Gdata_Gapps_ServiceException $e) {
            // ユーザが見つからなかった場合は null を設定します
            if ($e->hasError(Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST)) {
                $user = null;
            } else {
                throw $e;
            }
        }
        return $user;
    }