google.appengine.api.users モジュール

概要

データストア データ型として使用される User Python データストア クラス。

内容

google.appengine.api.users.CreateLoginURL(dest_url=None, _auth_domain=None, federated_identity=None)ソース

リダイレクトのためのログイン URL をコンピューティングします。

パラメータ
  • dest_url - ログイン完了後のユーザーの最終宛先 URL を示す文字列。dest_url にホストが指定されていない場合は、現在のリクエストに指定されているホストが使用されます。

  • federated_identity - 廃止されているため、使用しないでください。None 以外の値に設定すると、NotAllowedError が発生します。

戻り値

ログイン URL(文字列)。ログイン URL には Google アカウントが使用されます。

発生

NotAllowedError - federated_identity が None 以外の場合。

google.appengine.api.users.CreateLogoutURL(dest_url, _auth_domain=None)ソース

リクエストに指定されている宛先 URL とログアウト URL をコンピューティングします。

この関数は、Google アカウント アプリケーションに対して機能します。

パラメータ

dest_url - ユーザーがログアウトした後のユーザーの最終宛先 URL を示す文字列。dest_url にホストが指定されていない場合は、現在のリクエストに指定されているホストが使用されます。

戻り値

ログアウト URL(文字列)。

exception google.appengine.api.users.Errorソース

ベース: exceptions.Exception

Base User エラータイプ。

google.appengine.api.users.GetCurrentUser()ソース

リクエストを行っているユーザーに関連する情報を取得します。

戻り値:

google.appengine.api.users.IsCurrentUserAdmin()ソース

リクエストを行っているユーザーがアプリケーション管理者であるかどうかを示します。

管理者ステータスはデータストアに保持されないので、is_current_user_admin() は、User クラスのメンバー関数とは異なる関数です。ステータスは現在のリクエストを行っているユーザーについてのみ存在します。

戻り値

ユーザーが管理者の場合は True、他のすべてのユーザータイプに対しては False が返されます。

exception google.appengine.api.users.NotAllowedErrorソース

ベース: google.appengine.api.users.Error

リクエストされたリダイレクト URL は許可されていません。

exception google.appengine.api.users.RedirectTooLongErrorソース

ベース: google.appengine.api.users.Error

生成されたリダイレクト URL が長すぎます。

class google.appengine.api.users.User(email=None, _auth_domain=None, _user_id=None, federated_identity=None, federated_provider=None, _strict_mode=True)ソース

ベース: object

ユーザーのメールアドレス、ニックネーム、ID を示します。

ニックネームは Google ユーザーを一意に識別する文字列です。人が読める形式であり、ユーザー名に似ています。このニックネームがメールアドレスである場合がありますが、それ以外の場合はメールアドレスとは異なるニックネームを使用します。

ユーザーは Google アカウントのユーザーです。

federated_identityfederated_provider は廃止されているため、使用しないでください。

auth_domain()ソース

ユーザーの認証ドメインを取得します。

戻り値

認証ドメインを含む文字列。このメソッドは内部メソッドであるため、クライアント アプリケーションでは使用しないでください。

email()ソース

ユーザーのメールアドレスを返します。

federated_identity()ソース

廃止されているため、使用しないでください。

戻り値

ユーザーの連携 ID を含む文字列。ユーザーが連携ユーザーではない場合は None が返されます。

federated_provider()ソース

廃止されているため、使用しないでください。

戻り値

連携プロバイダを含む文字列。ユーザーが連携ユーザーではない場合は None が返されます。

nickname()ソース

ユーザーのニックネームを返します。

ニックネームは、人間が読める形式の文字列として、このアプリケーションを使用するユーザーに割り当てられる一意の識別子です。ユーザーによっては、メールアドレスが使用される場合や、メールアドレスの一部が使用される場合があります。

戻り値

ユーザーのニックネーム(文字列)。

user_id()ソース

ユーザーのユーザー ID を取得します。

戻り値

永続的な一意の識別文字列または None。メールアドレスが明示的に設定されている場合は、None が返されます。

exception google.appengine.api.users.UserNotFoundErrorソース

ベース: google.appengine.api.users.Error

メール引数が指定されておらず、ユーザーがログインしていません。

google.appengine.api.users.create_login_url(dest_url=None, _auth_domain=None, federated_identity=None)ソース

リダイレクトのためのログイン URL をコンピューティングします。

パラメータ
  • dest_url - ログイン完了後のユーザーの最終宛先 URL を示す文字列。dest_url にホストが指定されていない場合は、現在のリクエストに指定されているホストが使用されます。

  • federated_identity - 廃止されているため、使用しないでください。None 以外の値に設定すると、NotAllowedError が発生します。

戻り値

ログイン URL(文字列)。ログイン URL には Google アカウントが使用されます。

発生

NotAllowedError - federated_identity が None 以外の場合。

google.appengine.api.users.create_logout_url(dest_url, _auth_domain=None)ソース

リクエストに指定されている宛先 URL とログアウト URL をコンピューティングします。

この関数は、Google アカウント アプリケーションに対して機能します。

パラメータ

dest_url - ユーザーがログアウトした後のユーザーの最終宛先 URL を示す文字列。dest_url にホストが指定されていない場合は、現在のリクエストに指定されているホストが使用されます。

戻り値

ログアウト URL(文字列)。

google.appengine.api.users.get_current_user()ソース

リクエストを行っているユーザーに関連する情報を取得します。

戻り値:

google.appengine.api.users.is_current_user_admin()ソース

リクエストを行っているユーザーがアプリケーション管理者であるかどうかを示します。

管理者ステータスはデータストアに保持されないので、is_current_user_admin() は、User クラスのメンバー関数とは異なる関数です。ステータスは現在のリクエストを行っているユーザーについてのみ存在します。

戻り値

ユーザーが管理者の場合は True、他のすべてのユーザータイプに対しては False が返されます。

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

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

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