Previous Next

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->name->givenName . "\n";
echo '苗字: ' . $user->name->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->changePasswordAtNextLoginTRUE に設定します。

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

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

ユーザアカウントの凍結

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

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

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

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

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

管理者権限の付与

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

$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');

Interacting with groups

Google Groups allows people to post messages like an email list. Google is depreciating the Email List API. Google Groups provides some neat features like nested groups and group owners. If you want to start a new email lst, it is advisable to use Google Groups instead. Google's Email List is not compatible with Google Groups. So if you create an email list, it will not show up as a group. The opposite is true as well.

Each group on a domain is represented as an instance of Zend_Gdata_Gapps_GroupEntry.

Creating a group

Groups can be created by calling the createGroup() convenience method:

$gdata->createGroup('friends', 'The Friends Group');

Groups can also be created by instantiating GroupEntry, providing a group id and name for the group, then calling insertGroup() on a service object to upload the entry to the server.

$group = $gdata->newGroupEntry();

$properties[0] = $this->newProperty();
$properties[0]->name = 'groupId';
$properties[0]->value = 'friends';
$properties[1] = $this->newProperty();
$properties[1]->name = 'groupName';
$properties[1]->value = 'The Friends Group';

$group->property = $properties;

$group = $gdata->insertGroup($group);

Retrieving an individual group

To retrieve an individual group, call the retrieveGroup() convenience method:

$entry = $gdata->retrieveGroup('friends');

foreach ($entry->property as $p) {
    echo "Property Name: " . $p->name;
    echo "\nProperty Value: " . $p->value . "\n\n";
}

This will create a Zend_Gdata_Gapps_GroupEntry object which holds the properties about the group.

Alternatively, create a new Zend_Gdata_Gapps_GroupQuery, set its groupId property to the desired group id, and submit the query by calling getGroupEntry() on a service object.

$query = $gdata->newGroupQuery();
$query->setGroupId('friends');
$entry = $gdata->getGroupEntry($query);

foreach ($entry->property as $p) {
    echo "Property Name: " . $p->name;
    echo "\nProperty Value: " . $p->value . "\n\n";
}

Retrieving all groups in a domain

To retrieve all groups in a domain, call the convenience method retrieveAllGroups().

$feed = $gdata->retrieveAllGroups();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

This will create a Zend_Gdata_Gapps_GroupFeed object which holds each group on the domain.

Alternatively, call getGroupFeed() on a service object with no arguments.

$feed = $gdata->getGroupFeed();

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Deleting a group

To delete a group, call the deleteGroup() convenience method:

$gdata->deleteGroup('friends');

Updating a group

Groups can be updated by calling the updateGroup() convenience method:

$gdata->updateGroup('group-id-here', 'Group Name Here');

The first parameter is required. The second, third and fourth parameter, representing the group name, group descscription, and email permission, respectively are optional. Setting any of these optional parameters to null will not update that item.

Retrieving all groups to which a person is a member

To retrieve all groups to which a particular person is a member, call the retrieveGroups() convenience method:

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

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

This will create a Zend_Gdata_Gapps_GroupFeed object which holds each group associated with the specified member.

Alternatively, create a new Zend_Gdata_Gapps_GroupQuery, set its member property to the desired email address, and submit the query by calling getGroupFeed() on a service object.

$query = $gdata->newGroupQuery();
$query->setMember('baz@somewhere.com');
$feed = $gdata->getGroupFeed($query);

foreach ($feed->entry as $entry) {
    foreach ($entry->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
    echo "\n\n";
}

Interacting with group members

Each member subscribed to a group is represented by an instance of Zend_Gdata_Gapps_MemberEntry. Through this class, individual recipients can be added and removed from groups.

Adding a member to a group

To add a member to a group, simply call the addMemberToGroup() convenience method:

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

Check to see if member belongs to group

To check to see if member belongs to group, simply call the isMember() convenience method:

$isMember = $gdata->isMember('bar@somewhere.com', 'friends');
var_dump($isMember);

The method returns a boolean value. If the member belongs to the group specified, the method returns true, else it returns false.

Removing a member from a group

To remove a member from a group, call the removeMemberFromGroup() convenience method:

$gdata->removeMemberFromGroup('baz', 'friends');

Retrieving the list of members to a group

The convenience method retrieveAllMembers() can be used to retrieve the list of members of a group:

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

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Alternatively, construct a new MemberQuery, set its groupId property to match the desired group id, and call getMemberFeed() on a service object.

$query = $gdata->newMemberQuery();
$query->setGroupId('friends');
$feed = $gdata->getMemberFeed($query);

foreach ($feed as $member) {
    foreach ($member->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

This will create a Zend_Gdata_Gapps_MemberFeed object which holds each member for the selected group.

Interacting with group owners

Each owner associated with a group is represented by an instance of Zend_Gdata_Gapps_OwnerEntry. Through this class, individual owners can be added and removed from groups.

Adding an owner to a group

To add an owner to a group, simply call the addOwnerToGroup() convenience method:

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

Retrieving the list of the owner of a group

The convenience method retrieveGroupOwners() can be used to retrieve the list of the owners of a group:

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

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

Alternatively, construct a new OwnerQuery, set its groupId property to match the desired group id, and call getOwnerFeed() on a service object.

$query = $gdata->newOwnerQuery();
$query->setGroupId('friends');
$feed = $gdata->getOwnerFeed($query);

foreach ($feed as $owner) {
    foreach ($owner->property as $p) {
        echo "Property Name: " . $p->name;
        echo "\nProperty Value: " . $p->value . "\n\n";
    }
}

This will create a Zend_Gdata_Gapps_OwnerFeed object which holds each member for the selected group.

Check to see if an email is the owner of a group

To check to see if an email is the owner of a group, simply call the isOwner() convenience method:

$isOwner = $gdata->isOwner('bar@somewhere.com', 'friends');
var_dump($isOwner);

The method returns a boolean value. If the email is the owner of the group specified, the method returns true, else it returns false.

Removing an owner from a group

To remove an owner from a group, call the removeOwnerFromGroup() convenience method:

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

メーリングリストの操作

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

ドメイン上のメーリングリストの情報は、 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;
}
Previous Next
Zend Framework の紹介
概要
インストール
Zend Framework を学ぶ(主に英語)
クイックスタート(ごく一部のみ日本語)
Zend Framework & MVC Introduction
プロジェクトを作成
Create A Layout
モデルとデータベーステーブルの作成
Create A Form
おめでとう!
オートローディング(英語)
Introduction
Goals and Design
Basic Autoloader Usage
Resource Autoloading
Conclusion
プラグイン(英語)
Introduction
Using Plugins
Conclusion
Zend_Layout 入門(英語)
Introduction
Using Zend_Layout
Zend_Layout: Conclusions
Zend_View プレイスフォルダ入門(英語)
Introduction
Basic Placeholder Usage
Standard Placeholders
View Placeholders: Conclusion
Zend Form デコレータを理解して使う(ごく一部のみ日本語)
Introduction
Decorator Basics
Layering Decorators
Rendering Individual Decorators
Creating and Rendering Composite Elements
結論
Zend_Session, Zend_Auth, Zend_Acl 入門(英語)
Building Multi-User Applications With Zend Framework
Managing User Sessions In ZF
Authenticating Users in Zend Framework
Building an Authorization System in Zend Framework
Zend_Search_Lucene 入門(一部日本語)
Zend_Search_Lucene Introduction
Lucene Index Structure
インデックスのオープンと生成
索引付け
検索
サポートされるクエリー
検索結果のページ化
Zend_Paginator 入門(英語)
Introduction
Simple Examples
Pagination Control and ScrollingStyles
Putting it all Together
Zend Framework リファレンス
Zend_Acl
導入
アクセス制御の洗練
高度な使用法
Zend_Amf
導入
Zend_Amf_Server(日本語)
Zend_Application
導入
Zend_Application クイックスタート
Theory of Operation
コア機能
利用できるリソースプラグイン
Zend_Auth
導入
データベースのテーブルでの認証
ダイジェスト認証
HTTP 認証アダプタ
LDAP 認証
Open ID 認証
Zend_Barcode
導入
Barcode creation using Zend_Barcode class
Zend_Barcode Objects
Zend_Barcode Renderers
Zend_Cache
導入
キャッシュの仕組み
Zend_Cache のフロントエンド
Zend_Cache のバックエンド
The Cache Manager
Zend_Captcha
導入
Captcha の方法
CAPTCHA アダプタ
SimpleCloud API: Zend_Cloud
Document Service Introduction
Queue Service Introduction
StorageService Introduction
Zend_CodeGenerator
導入
Zend_CodeGeneratorサンプル
Zend_CodeGenerator リファレンス
Zend_Config
導入
動作原理
Zend_Config_Ini(日本語)
Zend_Config_Json
Zend_Config_Xml(日本語)
Zend_Config_Yaml
Zend_Config_Writer
Zend_Config_Writer(日本語)
Zend_Console_Getopt
導入
Getopt の規則の宣言
オプションおよび引数の取得
Zend_Console_Getopt の設定
Zend_Controller
Zend_Controller クイックスタート
Zend_Controller の基本
フロントコントローラ
リクエストオブジェクト
標準のルータ
ディスパッチャ
アクションコントローラ
アクションヘルパー
レスポンスオブジェクト
プラグイン
モジュラーディレクトリ構造の規約の使用
MVC での例外
Zend_Currency
Zend_Currency について
Using Zend_Currency
Options for currencies
What makes a currency?
Where is the currency?
How does the currency look like?
How much is my currency?
Calculating with currencies
Exchanging currencies
Additional informations on Zend_Currency
Zend_Date
導入
動作原理
基本メソッド
Zend_Date API の概要
日付の作成
日付関数全般用の定数
動作例
Zend_Db
Zend_Db_Adapter(日本語)
Zend_Db_Statement(日本語)
Zend_Db_Profiler(日本語)
Zend_Db_Select(日本語)
Zend_Db_Table(日本語)
Zend_Db_Table_Row(日本語)
Zend_Db_Table_Rowset(日本語)
導入
Zend_Db_Table_Definition(日本語)
Zend_Debug
変数の出力
Zend_Dojo
導入
Zend_Dojo_Data: dojo.data エンベロープ
Dojo ビューヘルパー
Dojoフォーム要素とデコレーター
Zend_Dojo build layer support
Zend_Dom
導入
Zend_Dom_Query(日本語)
Zend_Exception
例外の使用法
基本的な使用法
Previous Exceptions (前の例外)
Zend_Feed
導入
フィードの読み込み
ウェブページからのフィードの取得
RSS フィードの使用
Atom フィードの使用
単一の Atom エントリの処理
フィードおよびエントリの構造の変更
独自のフィードクラスおよびエントリクラス
Zend_Feed_Reader
Zend_Feed_Writer
Zend_Feed_Pubsubhubbub
Zend_File
Zend_File_Transfer(日本語)
Zend_File_Transfer 用のバリデータ
Filters for Zend_File_Transfer
Zend_Filter
導入
標準のフィルタクラス群
フィルタチェイン
フィルタの書き方
Zend_Filter_Input(日本語)
Zend_Filter_Inflector(日本語)
Zend_Form
Zend_Form(日本語)
Zend_Form クイックスタート
Zend_Form_Element を用いたフォーム要素の作成
Zend_Form によるフォームの作成
Zend_Form_Decorator による独自のフォームマークアップの作成
Zend Framework に同梱されている標準のフォーム要素
Zend Framework に同梱されている標準のデコレータ
Zend_Form の国際化
Zend_Form の高度な使用法
Zend_Gdata
導入
AuthSub による認証
Using the Book Search Data API
ClientLogin による認証
Google Calendar の使用法
Google Documents List Data API の使用法
Using Google Health
Google Spreadsheets の使用法
Google Apps Provisioning の使用法
Google Base の使用法
Picasa Web Albums の使用法
YouTube Data API の使用法
Gdata の例外処理
Zend_Http
導入
Zend_Http_Client - 高度な使用法
Zend_Http_Client - 接続アダプタ
Zend_Http_Cookie および Zend_Http_CookieJar
Zend_Http_Response(日本語)
Zend_Http_UserAgent
The UserAgent Device Interface
The UserAgent Features Adapter
The WURFL UserAgent Features Adapter
The DeviceAtlas UserAgent Features Adapter
The TeraWurfl UserAgent Features Adapter
The UserAgent Storage Interface
The Session UserAgent Storage Adapter
Zend_InfoCard
導入
Zend_Json
導入
基本的な使用法
Zend_Json の高度な使用法
XML から JSON への変換
Zend_Json_Server - JSON-RPCサーバー
Zend_Layout
導入
Zend_Layout クイックスタート
Zend_Layout の設定オプション
Zend_Layout の高度な使用法
Zend_Ldap
導入
API概要
利用シナリオ
ツール
Zend_Ldap_Nodeを使用してLDAPツリーへのオブジェクト指向アクセス
LDAPサーバから情報を取得
LDIFへ、または、からのLDAPデータシリアライズ
Zend_Loader
ファイルやクラスの動的な読み込み
The Autoloader
Resource Autoloaders
プラグインのロード
Zend_Locale
導入
Zend_Locale の使用法
正規化および地域化
日付および時刻の扱い
サポートするロケール
Zend_Log
概要
ライター
フォーマッタ
フィルタ
Using the Factory to Create a Log
Zend_Mail
導入
SMTP 経由での送信
SMTP 接続による複数のメールの送信
異なる転送手段の使用
HTML メール
ファイルの添付
受信者の追加
MIME バウンダリの制御
追加のヘッダ
文字セット
エンコーディング
SMTP 認証
セキュアな SMTP トランスポート
メールメッセージの読み込み
Zend_Markup
導入
さあ始めましょう
Zend_Markup パーサー
Zend_Markup レンダラー
Zend_Measure
導入
計測値の作成
計測値の出力
計測値の操作
計測値の型
Zend_Memory
概要
メモリマネージャ
メモリオブジェクト
Zend_Mime
Zend_Mime(日本語)
Zend_Mime_Message(日本語)
Zend_Mime_Part(日本語)
Zend_Navigation
導入
画面
Containers
Zend_Oauth
Introduction to OAuth
Zend_OpenId
導入
Zend_OpenId_Consumer の基本
Zend_OpenId_Provider(日本語)
Zend_Paginator
導入
使用法
設定
高度な使用法
Zend_Pdf
導入
PDF ドキュメントの作成および読み込み
PDF ドキュメントへの変更内容の保存
ページの操作
描画
Interactive Features
ドキュメントの情報およびメタデータ
Zend_Pdf モジュールの使用例
Zend_ProgressBar
Zend_ProgressBar(日本語)
Zend_Queue
導入
使用例
フレームワーク
アダプタ
Zend_Queueのカスタマイズ
Stomp(日本語)
Zend_Reflection
導入
Zend_Reflectionサンプル
Zend_Reflectionリファレンス
Zend_Registry
レジストリの使用法
Zend_Rest
導入
Zend_Rest_Client(日本語)
Zend_Rest_Server(日本語)
Zend_Search_Lucene
概要
インデックスの構築
インデックスの検索
クエリ言語
クエリ作成用の API
文字セット
拡張性
Java Lucene との相互運用
応用
ベストプラクティス
Zend_Serializer
導入
Zend_Serializer_Adapter
Zend_Server
導入
Zend_Server_Reflection(日本語)
Zend_Service
導入
Zend_Service_Akismet(日本語)
Zend_Service_Amazon(日本語)
Zend_Service_Amazon_Ec2(日本語)
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Storage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs(日本語)
Zend_Service_Amazon_Ec2:リージョンおよび利用可能ゾーン
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
Zend_Service_Audioscrobbler(日本語)
Zend_Service_Delicious(日本語)
Zend_Service_DeveloperGarden
Zend_Service_Ebay
Zend_Service_Ebay_Finding
Zend_Service_Flickr(日本語)
Zend_Service_LiveDocx
Zend_Service_Nirvanix(日本語)
Zend_Service_ReCaptcha(日本語)
Zend_Service_ShortUrl
Zend_Service_Simpy(日本語)
Zend_Service_SlideShare(日本語)
Zend_Service_StrikeIron(日本語)
Zend_Service_StrikeIron: バンドルされているサービス
Zend_Service_StrikeIron: 応用編
Zend_Service_Technorati(日本語)
Zend_Service_Twitter
Zend_Service_WindowsAzure
Zend_Service_WindowsAzure_Storage_Blob
Zend_Service_WindowsAzure_Diagnostics_Manager
Zend_Service_WindowsAzure_Storage_Queue
Zend_Service_WindowsAzure_Storage_Table
Zend_Service_Yahoo(日本語)
Zend_Session
導入
基本的な使用法
高度な使用法
グローバルセッションの管理
Zend_Session_SaveHandler_DbTable(日本語)
Zend_Soap
Zend_Soap_Server(日本語)
Zend_Soap_Client(日本語)
WSDLアクセッサ
自動検出
Zend_Tag
導入
Zend_Tag_Cloud
Zend_Test
導入
Zend_Test_PHPUnit(日本語)
Zend_Test_PHPUnit_Db(日本語)
Zend_Text
Zend_Text_Figlet(日本語)
Zend_Text_Table(日本語)
Zend_TimeSync
導入
Zend_TimeSync の動作
Zend_Tool
Using Zend_Tool On The Command Line
Extending Zend_Tool
Zend_Tool_Framework
導入
CLIツールの使用
アーキテクチャ
Zend_Tool_Frameworkを利用してプロバイダを作成する
出荷されたシステムプロバイダー
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
導入
プロジェクトを作成
Zend_Tool Project Providers
Zend_Tool_Project Internals
Zend_Translate
導入
Zend_Translate のアダプタ
翻訳アダプタの使用法
ソースファイルの作成
翻訳用の追加機能
Plural notations for Translation
Zend_Uri
Zend_Uri(日本語)
Zend_Validate
導入
標準のバリデーションクラス群
バリデータチェイン
バリデータの書き方
検証メッセージ(一部日本語)
Zend_Version
Zend Framework のバージョンの取得
Zend_View
導入
コントローラスクリプト
ビュースクリプト
ビューヘルパー
Zend_View_Abstract(日本語)
Zend_Wildfire
Zend_Wildfire(日本語)
Zend_XmlRpc
導入
Zend_XmlRpc_Client
Zend_XmlRpc_Server(日本語)
ZendX_Console_Process_Unix
ZendX_Console_Process_Unix
ZendX_JQuery
Introduction
ZendX_JQuery View Helpers
ZendX_JQuery Form Elements and Decorators
Zend Framework のシステム要件
導入
Zend Framework 移行上の注意
Zend Framework 1.10(一部日本語)
Zend Framework 1.9(一部日本語)
Zend Framework 1.8(日本語)
Zend Framework 1.7(日本語)
Zend Framework 1.6(日本語)
Zend Framework 1.5(日本語)
Zend Framework 1.0(日本語)
Zend Framework 0.9(日本語)
Zend Framework 0.8(日本語)
Zend Framework 0.6(日本語)
Zend Framework PHP 標準コーディング規約
概要
PHP ファイルの書式
命名規約
コーディングスタイル
Zend Framework ドキュメント標準(一部日本語)
概要
ドキュメントファイル形式
推奨事項
Zend Framework MVC アプリケーションのために推奨されるプロジェクト構造
概要
推奨されるプロジェクト・ディレクトリ構造
モジュール構造
リライト設定ガイド
Zend Framework パフォーマンスガイド
導入
クラスの読み込み
Zend_Dbパフォーマンス
国際化(i18n)とローカライズ(l10n)
ビューのレンダリング
著作権に関する情報