HTTPS リクエストを発行する

リージョン ID

REGION_ID は、アプリの作成時に選択したリージョンに基づいて Google が割り当てる省略形のコードです。一部のリージョン ID は、一般的に使用されている国や州のコードと類似しているように見える場合がありますが、このコードは国または州に対応するものではありません。2020 年 2 月以降に作成されたアプリの場合、REGION_ID.r は App Engine の URL に含まれています。この日付より前に作成されたアプリの場合、URL のリージョン ID は省略可能です。

詳しくは、リージョン ID をご覧ください。

このページでは、第 2 世代ランタイム用の URL 取得サービスを使用して、App Engine アプリから HTTP(S) リクエストを発行する方法について説明します。

このページの手順に沿って操作を行う前に、言語固有のソリューションを使用して HTTP(S) リクエストを発行してから URL 取得サービスを使用することをおすすめします。URL 取得の主なユースケースは、別の App Engine アプリに HTTP(S) リクエストを発行し、そのリクエストでアプリの ID を表明する必要がある場合です。

リクエストサイズの上限と URL 取得リクエストで送信されるヘッダーの詳細については、アウトバウンドリクエストをご覧ください。

デフォルトでは、Java ランタイムで実行されるアプリケーションは、java.net.HttpURLConnection などの HTTP(S) リクエストに標準の Java クラスを使用します。他の Java アプリケーションの場合と同じように、リクエストを送信します。

標準ランタイムネットワーククラスを使用する

標準の Java ネットワーククラスを使用する場合、アプリは次の機能にアクセスできます。

リクエストデータに設定されている 32 MB の制限は適用されません。
HTTP 2.0 をサポートします。
Java 用 Cloud クライアントライブラリからアクセス可能な Google Cloudベースの API をすべてサポートします。

URL 取得を使用する

Java アプリで URL 取得を使用する場合は、appengine-web.xml に次の行を追加します。

 <url-stream-handler>urlfetch</url-stream-handler>

例:

<xml version="1.0" encoding="utf-8">
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
  <!-- ... -->
  <url-stream-handler>urlfetch</url-stream-handler>
  <!-- ... -->
</appengine-web-app>

HTTP リクエストを発行する

URL 取得サービスを使用してアウトバウンド HTTP(S) リクエストを発行するには、java.net.URLConnection を使用します。

以下のスニペットでは、基本的な HTTP GET リクエストを実行します。アプリケーションは新しい URL オブジェクトを作成し、次にオブジェクトの openStream() メソッドを呼び出して、その URL のコンテンツを取得します。

URL url = new URL("http://api.icndb.com/jokes/random");
BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream()));
StringBuffer json = new StringBuffer();
String line;

while ((line = reader.readLine()) != null) {
  json.append(line);
}
reader.close();

高度なリクエストの場合は、次のように java.net.HttpURLConnection を使用します。

新しい URL オブジェクトを作成します。
URL オブジェクトの openConnection() メソッドを呼び出して。新しい URLConnection オブジェクトを作成します。
HttpURLConnection オブジェクト型に URLConnection オブジェクトをキャストして新しい HttpURLConnection オブジェクトを作成します。
HttpURLConnection オブジェクトのリクエストメソッドを設定します。
リクエストの出力ストリームを作成します。
リクエストのペイロードをストリームに書き込みます。
ストリームを閉じます。

次のスニペットは、HttpURLConnection を使用してより高度なリクエストを実行し、PUT リクエストを使用してウェブフォームからデータを送信する方法を示しています。

URL url = new URL("http://jsonplaceholder.typicode.com/posts/" + id);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
// Enable output for the connection.
conn.setDoOutput(true);
conn.setRequestProperty("Content-Type", "application/json; charset=UTF-8");
conn.setRequestProperty("Accept", "application/json");
// Set HTTP request method.
conn.setRequestMethod("PUT");

// Create JSON request.
JSONObject jsonObj =
    new JSONObject().put("userId", 1).put("id", id).put("title", text).put("body", text);

OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream());
writer.write(jsonObj.toString());
writer.close();

int respCode = conn.getResponseCode(); // New items get NOT_FOUND on PUT
if (respCode == HttpURLConnection.HTTP_OK || respCode == HttpURLConnection.HTTP_NOT_FOUND) {
  req.setAttribute("error", "");
  StringBuilder response = new StringBuilder();
  String line;

  // Read input data stream.
  BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
  while ((line = reader.readLine()) != null) {
    response.append(line);
  }
  reader.close();
  req.setAttribute("response", response.toString());
} else {
  req.setAttribute("error", conn.getResponseCode() + " " + conn.getResponseMessage());
}

リクエストタイムアウトを設定する

URL 取得を使用する場合は、appengine-web.xml ファイルの appengine.api.urlfetch.defaultDeadline 設定を使用して、リクエストのデフォルト期限を調整します。

ヘッダーを設定する

URL 取得を使用している場合は、HttpURLConnection オブジェクトの setRequestProperty() メソッドを呼び出して、送信リクエストに HTTP ヘッダーを設定できます。次のスニペットでは、X-MyApp-Version ヘッダーを 2.7.3 に設定しています。

conn.setRequestProperty("X-MyApp-Version", "2.7.3");

リダイレクトを無効にする

デフォルトでは、HttpURLConnection は HTTP リダイレクトに従います。

URL 取得を使用している場合、基本の URL 取得サービスはデフォルトで最大 5 回のリダイレクトを行います。これらのリダイレクトでは、認証ヘッダーなどの機密情報がリダイレクト先に転送される可能性があります。アプリで HTTP リダイレクトが不要な場合は、リダイレクトを無効にすることをおすすめします。

この動作を無効にするには、HttpURLConnection オブジェクトの setInstanceFollowRedirects() メソッドに値 false を渡します。

conn.setInstanceFollowRedirects(false);

アプリで java.net ではなく基礎となる urlfetch パッケージを直接使用する場合は、アプリで doNotFollowRedirects を指定する必要があります。