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

概要

アプリ ID サービスの機能へのアクセスを提供します。

App Identity API の詳細については、概要をご覧ください。

内容

exception google.appengine.api.app_identity.app_identity.BackendDeadlineExceeded ソース

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

バックエンド サービスへの通信がタイムアウトしました。

exception google.appengine.api.app_identity.app_identity.BlobSizeTooLarge ソース

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

署名する blob のサイズが上限を超えています。

exception google.appengine.api.app_identity.app_identity.InternalError ソース

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

未指定の内部エラーが発生しました。

exception google.appengine.api.app_identity.app_identity.InvalidScope ソース

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

スコープが無効です。

exception google.appengine.api.app_identity.app_identity.NotAllowed ソース

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

オペレーションが許可されていません。

exception google.appengine.api.app_identity.app_identity.OperationNotImplemented ソース

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

このオペレーションがサービス アカウントに実装されていません。

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

ベース: exceptions.Exception

ベースのエラータイプ。

google.appengine.api.app_identity.app_identity.create_rpc(deadline=None, callback=None) ソース

App Identity API で使用する RPC オブジェクトを作成します。

パラメータ
  • deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

  • callback - オプションで完了時に呼び出して実行できます。

戻り値

このサービスに特化した apiproxy_stub_map.UserRPC オブジェクト。

google.appengine.api.app_identity.app_identity.make_sign_blob_call(rpc, bytes_to_sign) ソース

blob に署名するために RPC 呼び出しを実行します。

パラメータ
  • rpc – UserRPC インスタンス。

  • bytes_to_sign – 署名が必要な blob。

戻り値

署名鍵の名前と署名を含むタプル。

発生するエラー

TypeError – bytes_to_sign が文字列でない場合。

google.appengine.api.app_identity.app_identity.make_get_public_certificates_call(rpc) ソース

RPC 呼び出しを実行して、公開証明書のリストを取得します。

パラメータ

rpc – UserRPC インスタンス。

戻り値

PublicCertificate オブジェクトのリスト。

google.appengine.api.app_identity.app_identity.make_get_service_account_name_call(rpc) ソース

アプリのサービス アカウント名を取得します。

パラメータ

rpc – UserRPC オブジェクト。

戻り値

アプリのサービス アカウント名。

google.appengine.api.app_identity.app_identity.sign_blob(bytes_to_sign, deadline=None) ソース

blob に署名します。

パラメータ
  • bytes_to_sign – 署名が必要な blob。

  • deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

戻り値

署名鍵の名前と署名を含むタプル。

google.appengine.api.app_identity.app_identity.get_public_certificates(deadline=None) ソース

公開証明書を取得します。

パラメータ

deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

戻り値

PublicCertificate オブジェクトのリスト。

class google.appengine.api.app_identity.app_identity.PublicCertificate(key_name, x509_certificate_pem) ソース

ベース: オブジェクト

公開証明書に関する情報を指定するクラス。

key_name

証明書の名前。

x509_certificate_pem

PEM 形式の X.509 証明書

google.appengine.api.app_identity.app_identity.get_service_account_name(deadline=None) ソース

アプリのサービス アカウント名を取得します。

パラメータ

deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

戻り値

アプリのサービス アカウント名。

google.appengine.api.app_identity.app_identity.get_application_id() ソース

アプリのアプリケーション ID を取得します。

戻り値

アプリのアプリケーション ID。

google.appengine.api.app_identity.app_identity.get_default_version_hostname() ソース

アプリのデフォルト バージョンの標準ホスト名を取得します。

たとえば、application_idmy-app の場合、結果は my-app.appspot.com になります。

戻り値

アプリのデフォルト バージョンの標準ホスト名。

google.appengine.api.app_identity.app_identity.get_access_token(scopes, service_account_id=None) ソース

アプリに代わって動作する OAuth 2.0 アクセス トークン。

このトークンはキャッシュに格納されます。

App Engine アプリケーションのサービス アカウントにトークンが生成され、キャッシュに格納されます。

各アプリケーションには Google アカウントが関連付けられます。この関数は、実行中のアプリに対応する OAuth 2.0 アクセス トークンを返します。返されたアクセス トークンは、有効期限が切れるまで安全にキャッシュと再利用を行うことができます。このメソッドは、インプロセス キャッシュと memcache の両方を使用してアクセス トークンをキャッシュに格納します。

パラメータ

scopes – リクエスト API スコープの文字列または文字列のリスト。

戻り値

PairAccess トークン文字列とエポック時刻からの有効期限(秒)。

google.appengine.api.app_identity.app_identity.get_access_token_uncached(scopes, deadline=None, service_account_id=None) ソース

アプリケーションに代わって動作する OAuth 2.0 アクセス トークンを生成します。

このメソッドは非同期で、キャッシュに格納されません。ほとんどのデベロッパーは、代わりに get_access_token を使用する必要があります。

パラメータ
  • scopes – リクエスト API スコープの文字列または文字列のリスト。

  • deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

戻り値

PairAccess トークン文字列とエポック時刻からの有効期限(秒)。

google.appengine.api.app_identity.app_identity.make_get_access_token_call(rpc, scopes, service_account_id=None) ソース

アプリケーションに代わって動作する OAuth 2.0 アクセス トークンを生成します。

このメソッドは非同期で、キャッシュに格納されません。ほとんどのデベロッパーは、代わりに get_access_token を使用する必要があります。

パラメータ
  • rpc – RPC オブジェクト。

  • scopes – リクエスト API スコープの文字列または文字列のリスト。

発生するエラー

InvalidScope – スコープが指定されていないか、無効な場合。

google.appengine.api.app_identity.app_identity.get_default_gcs_bucket_name(deadline=None) ソース

アプリのデフォルトの Google Cloud Storage バケット名を取得します。

パラメータ

deadline - 任意で指定するオペレーションの期限(秒単位)。デフォルト値はシステム固有の期限(通常は 5 秒)です。

戻り値

アプリのデフォルトのバケット名。

google.appengine.api.app_identity.app_identity.make_get_default_gcs_bucket_name_call(rpc) ソース

アプリのデフォルトの Google Cloud Storage バケット名を取得します。

パラメータ

rpc – UserRPC オブジェクト。

戻り値

アプリのデフォルトの Google Cloud Storage バケット名。

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

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

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