repo_zf1/documentation/manual/ja/module_specs/Zend_Gdata_Gapps.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 24249 -->
<sect1 id="zend.gdata.gapps">
    <title>Google Apps Provisioning の使用法</title>
    <!-- Skip-EN-Revisions: 22742 -->
    <para>注意：このドキュメントでは、英語版のリビジョン 22742 の更新内容をスキップしています。</para>
    <para>
        Google Apps はドメイン管理者向けのサービスで、Google の提供する
        メールやカレンダー、Docs &amp; Spreadsheets
        などをユーザに使用させることができます。
        Provisioning <acronym>API</acronym> は、
        これらのサービスをプログラム上から設定するためのインターフェイスです。
        特に、この <acronym>API</acronym> を使用すると
        ユーザアカウントやニックネーム、グループ、メーリングリストなどの追加、取得、
        更新、削除ができるようになります。
    </para>

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

    <para>
        Google Apps Provisioning <acronym>API</acronym> の使用法や
        <acronym>API</acronym> にアクセスできるようにするための方法については <ulink
        url="http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html">Provisioning
        <acronym>API</acronym> V2.0 Reference</ulink> を参照ください。
    </para>

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

    <sect2 id="zend.gdata.gapps.domain">
        <title>現在のドメインの設定</title>

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

        <sect3 id="zend.gdata.gapps.domain.service">
            <title>サービスクラスへのドメインの設定</title>

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

            <programlisting language="php"><![CDATA[
$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);
]]></programlisting>

        </sect3>

        <sect3 id="zend.gdata.gapps.domain.query">
            <title>クエリクラスへのドメインの設定</title>

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

            <programlisting language="php"><![CDATA[
$domain = "example.com";
$query = new Zend_Gdata_Gapps_UserQuery($domain, $arg);
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$domain = "example.com";
$gdata = new Zend_Gdata_Gapps($client, $domain);
$query = $gdata->newUserQuery($arg);
]]></programlisting>

        </sect3>

    </sect2>

    <sect2 id="zend.gdata.gapps.users">
        <title>ユーザの操作</title>

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

        <sect3 id="zend.gdata.gapps.users.creating">
            <title>ユーザアカウントの作成</title>

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

            <programlisting language="php"><![CDATA[
$gdata->createUser('foo', 'Random', 'User', '••••••••');
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$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);
]]></programlisting>

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

        </sect3>

        <sect3 id="zend.gdata.gapps.users.retrieving">
            <title>ユーザアカウントの取得</title>

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

            <programlisting language="php"><![CDATA[
$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";
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$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";
]]></programlisting>

            <para>
                指定したユーザが発見できない場合は ServiceException
                がスローされ、エラーコード
                <constant>Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST</constant>
                を返します。ServiceExceptions については <xref
                linkend="zend.gdata.gapps.exceptions" />
                を参照ください。
            </para>

        </sect3>

        <sect3 id="zend.gdata.gapps.users.retrievingAll">
            <title>ドメイン内のすべてのユーザの取得</title>

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveAllUsers();

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

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

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->getUserFeed();

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

]]></programlisting>

        </sect3>

        <sect3 id="zend.gdata.gapps.users.updating">
            <title>ユーザアカウントの更新</title>

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

            <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->name->givenName = 'Foo';
$user->name->familyName = 'Bar';
$user = $user->save();
]]></programlisting>

            <sect4 id="zend.gdata.gapps.users.updating.resettingPassword">
                <title>ユーザのパスワードのリセット</title>

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

                <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->login->password = '••••••••';
$user = $user->save();
]]></programlisting>

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

            </sect4>

            <sect4 id="zend.gdata.gapps.users.updating.forcingPasswordChange">
                <title>ユーザに強制的にパスワードを変更させる</title>

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

                <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->login->changePasswordAtNextLogin = true;
$user = $user->save();
]]></programlisting>

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

            </sect4>

            <sect4 id="zend.gdata.gapps.users.updating.suspendingAccount">
                <title>ユーザアカウントの凍結</title>

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

                <programlisting language="php"><![CDATA[
$gdata->suspendUser('foo');
$gdata->restoreUser('foo');
]]></programlisting>

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

                <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->login->suspended = true;
$user = $user->save();
]]></programlisting>

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

            </sect4>

            <sect4 id="zend.gdata.gapps.users.updating.grantingAdminRights">
                <title>管理者権限の付与</title>

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

                <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->login->admin = true;
$user = $user->save();
]]></programlisting>

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

            </sect4>

        </sect3>

        <sect3 id="zend.gdata.gapps.users.deleting">
            <title>ユーザアカウントの削除</title>

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

            <programlisting language="php"><![CDATA[
$user = $gdata->retrieveUser('foo');
$user->delete();
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$gdata->deleteUser('foo');
]]></programlisting>

        </sect3>

    </sect2>

    <sect2 id="zend.gdata.gapps.nicknames">
        <title>ニックネームの操作</title>

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

        <para>
            ニックネームは
            <classname>Zend_Gdata_Gapps_NicknameEntry</classname>
            のインスタンスで表されます。
        </para>

        <sect3 id="zend.gdata.gapps.nicknames.creating">
            <title>ニックネームの作成</title>

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

            <programlisting language="php"><![CDATA[
$gdata->createNickname('foo', 'bar');
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$nickname = $gdata->newNicknameEntry();
$nickname->login = $gdata->newLogin('foo');
$nickname->nickname = $gdata->newNickname('bar');
$nickname = $gdata->insertNickname($nickname);
]]></programlisting>

        </sect3>

        <sect3 id="zend.gdata.gapps.nicknames.retrieving">
            <title>ニックネームの取得</title>

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

            <programlisting language="php"><![CDATA[
$nickname = $gdata->retrieveNickname('bar');

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

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

            <programlisting language="php"><![CDATA[
$query = $gdata->newNicknameQuery('bar');
$nickname = $gdata->getNicknameEntry($query);

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

            <para>
                ユーザの場合と同様、指定したニックネームが発見できない場合は
                ServiceException がスローされ、エラーコード
                <constant>Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST</constant>
                を返します。ServiceExceptions については <xref
                linkend="zend.gdata.gapps.exceptions" />
                を参照ください。
            </para>

        </sect3>

        <sect3 id="zend.gdata.gapps.nicknames.retrievingUser">
            <title>あるユーザのすべてのニックネームの取得</title>

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveNicknames('foo');

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

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

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

            <programlisting language="php"><![CDATA[
$query = $gdata->newNicknameQuery();
$query->setUsername('foo');
$feed = $gdata->getNicknameFeed($query);

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

        </sect3>

        <sect3 id="zend.gdata.gapps.nicknames.retrievingAll">
            <title>ドメイン内のすべてのニックネームの取得</title>
            <para>
                フィード内のすべてのニックネームを取得するには、
                <methodname>retrieveAllNicknames()</methodname> メソッドをコールします。
            </para>

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveAllNicknames();

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

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

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->getNicknameFeed();

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

        </sect3>

        <sect3 id="zend.gdata.gapps.nicknames.deleting">
            <title>ニックネームの削除</title>

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

            <programlisting language="php"><![CDATA[
$nickname = $gdata->retrieveNickname('bar');
$nickname->delete();
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$gdata->deleteNickname('bar');
]]></programlisting>

        </sect3>

    </sect2>

    <!-- TODO : to be translated -->
    <sect2 id="zend.gdata.gapps.groups">
        <title>Interacting with groups</title>

        <para>
            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.
        </para>

        <para>
            Each group on a domain is represented as an instance of
            <classname>Zend_Gdata_Gapps_GroupEntry</classname>.
        </para>

        <sect3 id="zend.gdata.gapps.groups.creating">
            <title>グループを作成</title>

            <para>
                <methodname>createGroup()</methodname> という便利なメソッドを呼び出すと、
                グループが作成できます。
            </para>

            <programlisting language="php"><![CDATA[
$gdata->createGroup('friends', 'The Friends Group');
]]></programlisting>

            <!-- TODO : to be translated -->
            <para>
                Groups can also be created by instantiating
                GroupEntry, providing a group id and name for the group, 
                then calling <methodname>insertGroup()</methodname> on a service
                object to upload the entry to the server.
            </para>

            <programlisting language="php"><![CDATA[
$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);
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groups.retrieveGroup">
            <title>Retrieving an individual group</title>

            <para>
                To retrieve an individual group, call the
                <methodname>retrieveGroup()</methodname> convenience method:
            </para>

            <programlisting language="php"><![CDATA[
$entry = $gdata->retrieveGroup('friends');

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

            <para>
                This will create a <classname>Zend_Gdata_Gapps_GroupEntry</classname> 
                object which holds the properties about the group.
            </para>

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

            <programlisting language="php"><![CDATA[
$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";
}
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groups.retrievingAll">
            <title>Retrieving all groups in a domain</title>

            <para>
                To retrieve all groups in a domain, call the convenience
                method <methodname>retrieveAllGroups()</methodname>.
            </para>

            <programlisting language="php"><![CDATA[
$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";
}
]]></programlisting>

            <para>
                This will create a <classname>Zend_Gdata_Gapps_GroupFeed</classname> 
                object which holds each group on the domain.
            </para>

            <para>
                Alternatively, call <methodname>getGroupFeed()</methodname> on a
                service object with no arguments.
            </para>

            <programlisting language="php"><![CDATA[
$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";
}
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groups.deleting">
            <title>グループを削除</title>

            <para>
                グループを削除するには、deleteGroup() という便利なメソッドを呼び出します。
            </para>

            <programlisting language="php"><![CDATA[
$gdata->deleteGroup('friends');
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groups.updating">
            <title>グループを更新</title>

            <para>
                <methodname>updateGroup()</methodname> という便利なメソッドを呼び出すと、
                グループが更新できます。
            </para>

            <programlisting language="php"><![CDATA[
$gdata->updateGroup('group-id-here', 'Group Name Here');
]]></programlisting>

            <!-- TODO : to be translated -->
            <para>
                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.
            </para>
        </sect3>

        <sect3 id="zend.gdata.gapps.groups.retrieve">
            <title>Retrieving all groups to which a person is a member</title>

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

            <programlisting language="php"><![CDATA[
$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";
}
]]></programlisting>

            <para>
                This will create a <classname>Zend_Gdata_Gapps_GroupFeed</classname>
                object which holds each group associated with the specified member.
            </para>

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

            <programlisting language="php"><![CDATA[
$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";
}
]]></programlisting>
        </sect3>
    </sect2>

    <sect2 id="zend.gdata.gapps.groupMembers">
        <title>Interacting with group members</title>

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

        <sect3 id="zend.gdata.gapps.groupMembers.adding">
            <title>Adding a member to a group</title>

            <para>
                To add a member to a group, simply call the
                <methodname>addMemberToGroup()</methodname> convenience method:
            </para>

            <programlisting language="php"><![CDATA[
$gdata->addMemberToGroup('bar@somewhere.com', 'friends');
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groupMembers.check">
            <title>Check to see if member belongs to group</title>

            <para>
                To check to see if member belongs to group, simply call the
                <methodname>isMember()</methodname> convenience method:
            </para>

            <programlisting language="php"><![CDATA[
$isMember = $gdata->isMember('bar@somewhere.com', 'friends');
var_dump($isMember);
]]></programlisting>

            <para>
                The method returns a boolean value. If the member belongs to the
                group specified, the method returns true, else it returns false.
            </para>
        </sect3>

        <sect3 id="zend.gdata.gapps.groupMembers.removing">
            <title>Removing a member from a group</title>

            <para>
                To remove a member from a group, call the
                <methodname>removeMemberFromGroup()</methodname> convenience
                method:
            </para>

            <programlisting language="php"><![CDATA[
$gdata->removeMemberFromGroup('baz', 'friends');
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groupMembers.retrieving">
            <title>Retrieving the list of members to a group</title>

            <para>
                The convenience method <methodname>retrieveAllMembers()</methodname>
                can be used to retrieve the list of members of a group:
            </para>

            <programlisting language="php"><![CDATA[
$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";
    }
}
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$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";
    }
}
]]></programlisting>

            <para>
                This will create a <classname>Zend_Gdata_Gapps_MemberFeed</classname>
                object which holds each member for the selected group.
            </para>
        </sect3>
    </sect2>

    <sect2 id="zend.gdata.gapps.groupOwners">
        <title>Interacting with group owners</title>

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

        <sect3 id="zend.gdata.gapps.groupOwners.adding">
            <title>Adding an owner to a group</title>

            <para>
                To add an owner to a group, simply call the
                <methodname>addOwnerToGroup()</methodname> convenience method:
            </para>

            <programlisting language="php"><![CDATA[
$gdata->addOwnerToGroup('bar@somewhere.com', 'friends');
]]></programlisting>
        </sect3>

        <sect3 id="zend.gdata.gapps.groupOwners.retrieving">
            <title>Retrieving the list of the owner of a group</title>

            <para>
                The convenience method <methodname>retrieveGroupOwners()</methodname>
                can be used to retrieve the list of the owners of a group:
            </para>

            <programlisting language="php"><![CDATA[
$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";
    }
}
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$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";
    }
}
]]></programlisting>

            <para>
                This will create a <classname>Zend_Gdata_Gapps_OwnerFeed</classname>
                object which holds each member for the selected group.
            </para>
        </sect3>

        <sect3 id="zend.gdata.gapps.groupOwners.check">
            <title>Check to see if an email is the owner of a group</title>

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

            <programlisting language="php"><![CDATA[
$isOwner = $gdata->isOwner('bar@somewhere.com', 'friends');
var_dump($isOwner);
]]></programlisting>

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

        <sect3 id="zend.gdata.gapps.groupOwners.removing">
            <title>Removing an owner from a group</title>

            <para>
                To remove an owner from a group, call the
                <methodname>removeOwnerFromGroup()</methodname> convenience
                method:
            </para>

            <programlisting language="php"><![CDATA[
$gdata->removeOwnerFromGroup('baz@somewhere.com', 'friends');
]]></programlisting>
        </sect3>
    </sect2>

    <sect2 id="zend.gdata.gapps.emailLists">
        <title>メーリングリストの操作</title>

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

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

        <sect3 id="zend.gdata.gapps.emailLists.creating">
            <title>メーリングリストの作成</title>

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

            <programlisting language="php"><![CDATA[
$gdata->createEmailList('friends');
]]></programlisting>

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

            <programlisting language="php"><![CDATA[
$list = $gdata->newEmailListEntry();
$list->emailList = $gdata->newEmailList('friends');
$list = $gdata->insertEmailList($list);
]]></programlisting>

        </sect3>

        <sect3 id="zend.gdata.gapps.emailList.retrieve">
            <title>あるアカウントが購読しているすべてのメーリングリストの取得</title>

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveEmailLists('baz@somewhere.com');

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

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

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

            <programlisting language="php"><![CDATA[
$query = $gdata->newEmailListQuery();
$query->setRecipient('baz@somewhere.com');
$feed = $gdata->getEmailListFeed($query);

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

        </sect3>

        <sect3 id="zend.gdata.gapps.emailLists.retrievingAll">
            <title>ドメイン内のすべてのメーリングリストの取得</title>

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveAllEmailLists();

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

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

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->getEmailListFeed();

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

        </sect3>

        <sect3 id="zend.gdata.gapps.emailList.deleting">
            <title>メーリングリストの削除</title>

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

            <programlisting language="php"><![CDATA[
$gdata->deleteEmailList('friends');
]]></programlisting>

        </sect3>

    </sect2>

    <sect2 id="zend.gdata.gapps.emailListRecipients">
        <title>メーリングリストの参加者の操作</title>

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

        <sect3 id="zend.gdata.gapps.emailListRecipients.adding">
            <title>メーリングリストへの参加者の追加</title>

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

            <programlisting language="php"><![CDATA[
$gdata->addRecipientToEmailList('bar@somewhere.com', 'friends');
]]></programlisting>

        </sect3>

        <sect3 id="zend.gdata.gapps.emailListRecipients.retrieving">
            <title>メーリングリストの参加者一覧の取得</title>

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

            <programlisting language="php"><![CDATA[
$feed = $gdata->retrieveAllRecipients('friends');

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

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

            <programlisting language="php"><![CDATA[
$query = $gdata->newEmailListRecipientQuery();
$query->setEmailListName('friends');
$feed = $gdata->getEmailListRecipientFeed($query);

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

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

        </sect3>

        <sect3 id="zend.gdata.gapps.emailListRecipients.removing">
            <title>ある参加者のメーリングリストからの削除</title>

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

            <programlisting language="php"><![CDATA[
$gdata->removeRecipientFromEmailList('baz@somewhere.com', 'friends');
]]></programlisting>

        </sect3>

    </sect2>

    <sect2 id="zend.gdata.gapps.exceptions">
        <title>エラー処理</title>

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

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

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

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

        <programlisting language="php"><![CDATA[
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;
}
]]></programlisting>

    </sect2>

</sect1>