Users PHP API の概要

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

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

ユーザーがアプリケーションにログイン済みのときは、アプリケーションがユーザーのメールアドレスにアクセスできます。現在のユーザーが管理者(「管理ユーザー」と呼ばれることもあります)かどうかを検出することもでき、アプリの管理者専用領域の実装が容易になります。

PHP でのユーザー認証

以下の例では、アプリケーションにログインしたユーザーに対し、パーソナライズされたメッセージとログアウト用のリンクを表示します。ユーザーがログインしていない場合は、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 アカウント
  • G Suite ドメインのアカウント

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

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

ログインとログアウト

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

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

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

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

ユーザーがアプリにログインした状態になるのは、アプリの画面の指示に従ってユーザーが自分のアカウントのメールアドレスとパスワードを入力した場合のみです。これは、ユーザーが自分の Google アカウントを使用して別のアプリケーションにログイン済みかどうかとは無関係です。

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

ユーザーがアプリにログイン済みのときは、そのユーザーがアプリに対して要求を行うたびにアプリがアカウントのメールアドレスにアクセスすることができます。アプリからユーザー 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 人の一意のユーザーがいることを表します。

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

PHP の App Engine スタンダード環境