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

概要

URL ダウンロード API。

目次

google.appengine.api.urlfetch.Fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None) ソース

指定された HTTP URL を取得します。結果が返されるまでブロックします。

URL は、次のいずれかの HTTP メソッドで取得されます。

  • GET

  • POST

  • HEAD

  • PUT

  • DELETE

  • PATCH

結果を取得するため、HTTP/1.1 互換のプロキシが使用されます。

パラメータ

  • method – 定数。GET、POST、HEAD、PUT、DELETE または PATCH。あるいは、文字列と同じ HTTP メソッド。

  • payload – POST、PUT または PATCH ペイロード（メソッドは GET、HEAD、DELETE ではないことを意味します）。メソッドが POST、PUT、PATCH でない場合、この引数は無視されます。

  • headers – リクエストと一緒に送信される HTTP ヘッダーのディクショナリ。

  • allow_truncated – True に設定すると、サイズの大きいレスポンスは切り詰められて返されますが、エラーは発生しません。それ以外の場合、ResponseTooLargeError はレスポンスが切り捨てられるときに発生します。

  • follow_redirects – True（デフォルト）に設定すると、リダイレクトが透過的に追跡されます。リダイレクトの回数が 5 回未満の場合、レスポンスには最終宛先のペイロードが含まれます。レスポンス ステータスは 200 です。ただし、リダイレクト チェーンの情報は失われます。 False に設定すると、Location ヘッダーを含む HTTP レスポンスが表示され、リダイレクトは行われません。

  • deadline – オペレーションの期限（秒）

  • validate_certificate – True に設定すると、証明書が有効で、信頼できる CA によって署名され、ホスト名が証明書に一致していない限り、リクエストはサーバーに送信されません。None の値は、基礎となる urlfetch 実装によって動作が選択されることを示します。

戻り値

次のフィールドを含むオブジェクト:

  • content: サーバーからのレスポンスを含む文字列。

  • status_code: サーバーから返された HTTP ステータス コード。

  • headers: サーバーから返されたヘッダーのディクショナリ。

戻り値の型

オブジェクト

発生

urlfetch_errors.Error - エラーが発生した場合。詳しくは、urlfetch_errors モジュールをご覧ください。

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

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

パラメータ

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

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

戻り値

このサービス専用の apiproxy_stub_map.UserRPC オブジェクト。

google.appengine.api.urlfetch.fetch(url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, deadline=None, validate_certificate=None) ソース

指定された HTTP URL を取得します。結果が返されるまでブロックします。

URL は、次のいずれかの HTTP メソッドで取得されます。

  • GET

  • POST

  • HEAD

  • PUT

  • DELETE

  • PATCH

結果を取得するため、HTTP/1.1 互換のプロキシが使用されます。

パラメータ

  • method – 定数。GET、POST、HEAD、PUT、DELETE または PATCH。あるいは、文字列と同じ HTTP メソッド。

  • payload – POST、PUT または PATCH ペイロード（メソッドは GET、HEAD、DELETE ではないことを意味します）。メソッドが POST、PUT、PATCH でない場合、この引数は無視されます。

  • headers – リクエストと一緒に送信される HTTP ヘッダーのディクショナリ。

  • allow_truncated – True に設定すると、サイズの大きいレスポンスは切り詰められて返されますが、エラーは発生しません。それ以外の場合、ResponseTooLargeError はレスポンスが切り捨てられるときに発生します。

  • follow_redirects – True（デフォルト）に設定すると、リダイレクトが透過的に追跡されます。リダイレクトの回数が 5 回未満の場合、レスポンスには最終宛先のペイロードが含まれます。レスポンス ステータスは 200 です。ただし、リダイレクト チェーンの情報は失われます。 False に設定すると、Location ヘッダーを含む HTTP レスポンスが表示され、リダイレクトは行われません。

  • deadline – オペレーションの期限（秒）

  • validate_certificate – True に設定すると、証明書が有効で、信頼できる CA によって署名され、ホスト名が証明書に一致していない限り、リクエストはサーバーに送信されません。None の値は、基礎となる urlfetch 実装によって動作が選択されることを示します。

戻り値

次のフィールドを含むオブジェクト:

  • content: サーバーからのレスポンスを含む文字列。

  • status_code: サーバーから返された HTTP ステータス コード。

  • headers: サーバーから返されたヘッダーのディクショナリ。

戻り値の型

オブジェクト

発生

urlfetch_errors.Error - エラーが発生した場合。詳しくは、urlfetch_errors モジュールをご覧ください。

google.appengine.api.urlfetch.get_default_fetch_deadline() ソース

create_rpc() の deadline パラメータのデフォルト値を取得します。

google.appengine.api.urlfetch.make_fetch_call(rpc, url, payload=None, method=1, headers={}, allow_truncated=False, follow_redirects=True, validate_certificate=None) ソース

指定された HTTP URL を取得するために RPC 呼び出しを実行します。

最初の引数は UserRPC インスタンスです。残りの引数の詳細については、urlfetch.fetch をご覧ください。

発生

  • InvalidMethodError – リクエストされたメソッドが _VALID_METHODS にない場合。

  • ResponseTooLargeError – レスポンス ペイロードが大きすぎる場合。

  • InvalidURLError – リクエストされた URL のコンテンツまたはサイズに問題がある場合。

戻り値

関数に渡された RPC オブジェクト。

google.appengine.api.urlfetch.set_default_fetch_deadline(value) ソース

create_rpc() の deadline パラメータのデフォルト値を設定します。

これはスレッド固有の設定です。この設定はローカルのスレッドに格納されます。 この関数は、値の型または範囲をチェックしません。 デフォルト値は None です。

create_rpc()fetch()関連情報

パラメータ

value - create_rpc() の deadline パラメータに使用するデフォルト値。