注: PHP 5 は、2024 年 1 月 30 日にサポートが終了しました。既存の PHP 5 アプリケーションは引き続き実行され、トラフィックを受信します。ただし、サポート終了日を過ぎると、ランタイムを使用するアプリケーションの再デプロイが App Engine によってブロックされることがあります。サポートされている最新バージョンの PHP に移行することをおすすめします。

以前のバンドルサービス用の Users API

Users API をアプリケーションで使用すると、次のことができます。

現在のユーザーがログイン済みかどうかを検出する。
適切なログインページにユーザーをリダイレクトする。
Google アカウントを持っていないアプリケーションユーザーに、アカウントを作成するように求める。

ユーザーがアプリにログイン済みのときは、アプリからユーザーのメールアドレスにアクセスできます。現在のユーザーが管理者（管理ユーザー）かどうかを検出することもでき、アプリの管理者専用領域の実装が容易になります。

PHP 5 でのユーザー認証

以下の例では、アプリケーションにログインしたユーザーに対し、パーソナライズされたメッセージとログアウト用のリンクを表示します。ユーザーがログインしていない場合は、Google アカウントのログインページへのリンクを表示します。

まず、ファイルの先頭で UserService クラスを読み込みます。

use google\appengine\api\users\UserService;

次に、ユーザーサービスを呼び出して現在のユーザーに関する情報を取得します。

$user = UserService::getCurrentUser();

if (isset($user)) {
    return sprintf('Welcome, %s! (<a href="%s">sign out</a>)',
        $user->getNickname(),
        UserService::createLogoutUrl('/'));
} else {
    return sprintf('<a href="%s">Sign in or register</a>',
        UserService::createLoginUrl('/'));
}

app.yaml を使用した強制ログインと管理者アクセス

ページへのアクセスにユーザーログインが必要なページがある場合は、これを app.yaml ファイルで強制できます。ログインを求めるよう構成されている URL にユーザーがアクセスしたとき、そのユーザーがログインしていない場合、App Engine ではユーザーを適切な Google ログインページにリダイレクトし、ログインまたは登録が完了した後に再びアプリの URL に移動させます。

ハンドラ構成で、ユーザーをアプリケーションの登録管理者に制限することもできます。つまり、ユーザーには閲覧者、編集者、オーナーまたは App Engine 管理者のロールが付与されている必要があります。この機能を使用すれば、サイト内に管理者専用のセクションを容易に実装できます。別の認可メカニズムを導入する必要はありません。

URL に対する認証を構成する方法については、app.yaml リファレンスのログインまたは管理者ステータスの要求方法に関する説明をご覧ください。

認証のオプション

アプリでユーザーの認証を行うには、次のオプションのいずれかを使用します。

Google アカウント
Google Workspace ドメインのアカウント

認証のオプションを選択する

アプリを作成した後で、どの認証オプションを使用するかを選択できます。デフォルトでは、Google アカウントがアプリでの認証に使用されます。Google Workspace のドメインなど、別のオプションを選択するには、Google Cloud Console でプロジェクトの [設定] ページに移動して、[編集] をクリックします。[Google 認証] プルダウンメニューで認証のタイプを選択して [保存] をクリックします。

ログインとログアウト

選択した認証オプションを使用してユーザーがアプリにログイン済みかどうかをアプリで検出できます。ユーザーがログインしていない場合は、Google アカウントでのログインまたは新しい Google アカウント作成のページに移動させることができます。ログインページの URL をアプリで取得するには、Users API のメソッドを呼び出します。認証を必要とするページをユーザーが訪問した際、アプリでこの URL をリンクとして表示するか、URL への HTTP リダイレクトを発行します。

Google アカウントまたは Google Workspace を認証に使用するアプリの場合、ユーザーがログインするときに、そのアプリケーションの名前がログインページに表示されます。表示される名前は、アプリケーションの登録時に指定したアプリケーション名です。この名前は、Google Cloud Console の [認証情報] ページの [アプリケーション名] フィールドで変更できます。

ログインまたは Google アカウントの作成が完了すると、ユーザーは再びアプリケーションにリダイレクトされます。アプリは、ログイン URL を生成するメソッドにリダイレクト URL を渡します。

Users API には、アプリからログアウトするための URL を生成するメソッドがあります。このログアウト URL は、アプリに対するユーザーの認証を解除してから、元のアプリの URL にリダイレクトしますが、特に何かを表示することはありません。

ユーザーがアプリにログインした状態になるのは、アプリの画面の指示に従ってユーザーが自身のアカウントのメールアドレスとパスワードを入力した場合のみです。これは、ユーザーが自身の Google アカウントを使用して別のアプリにログインした場合にも該当します。

アカウント情報にアクセスする

ユーザーがアプリにログインした状態である間は、ユーザーがアプリに対してリクエストを行うたびにアプリからアカウントのメールアドレスにアクセスできます。アプリからユーザー ID にアクセスすることもできます。ユーザー ID はユーザーを一意に識別するものであり、これはユーザーがアカウントのメールアドレスを変更した場合であっても同様です。

アプリは現在のユーザーが管理者かどうかを特定することもできます。管理ユーザーとは、閲覧者、編集者、オーナー、App Engine アプリ管理者のロールが付与されているユーザーです。この機能を利用すると、アプリの管理用の機能を開発できます。他のユーザーは認証不要であってもかまいません。Go、Java、PHP、Python の API を利用して、URL を「管理者専用」に簡単に構成できます。

Google アカウントと開発用サーバー

開発用サーバーでは、Google アカウントのシステムをシミュレートするために架空のログイン画面が使用されます。アプリケーションが Users API を呼び出してログイン画面の URL を取得するときに、API からは特別な開発用サーバー URL が返されます。この URL ではメールアドレスの入力が要求されますが、パスワードは要求されません。この画面では任意のメールアドレスを入力でき、アプリはユーザーがそのアドレスのアカウントでログインしたものとして動作します。

この架空のログイン画面には、架空アカウントが管理者かどうかを指定するためのチェックボックスもあります。管理者のアカウントには、閲覧者、編集者、オーナー、App Engine アプリ管理者のロールが付与されています。このチェックボックスをオンにすると、アプリはユーザーが管理者アカウントでログインしたものとして動作します。

同様に、Users API からは架空のログインを取り消すためのログアウト URL も返されます。

開発用サーバーの User オブジェクトの一意の ID はメールアドレスから計算されます。2 つの異なるメールアドレスは常に、開発用サーバーの 2 名の異なるユーザーを表します。