注: 今後数か月にわたり、App Engine ドキュメントサイトの再編成を行い、コンテンツを見つけやすくして、他の Google Cloud プロダクトとより適切に連携できるようにします。同じコンテンツを使用できますが、ナビゲーションは残りの Cloud プロダクトと同じになります。

Node.js 16 が一般提供になりました。

リクエストの処理方法

リージョン ID

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

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

このドキュメントでは、App Engine アプリケーションがリクエストを受信してレスポンスを送信する方法を説明します。詳細については、リクエストのヘッダーとレスポンスのリファレンスをご覧ください。

アプリケーションでサービスを使用している場合は、特定のサービスまたはそのサービスの特定のバージョンへのリクエストを指定できます。サービスのアドレス指定の方法については、リクエストのルーティング方法をご覧ください。

リクエストの処理

アプリケーションは、ウェブサーバーの起動とリクエストの処理を行う役割を果たします。使用する開発言語に対応している任意のウェブフレームワークを使用できます。

App Engine はアプリケーションの複数のインスタンスを実行します。各インスタンスには、リクエストを処理するウェブサーバーがそれぞれ割り当てられます。リクエストがルーティングされるインスタンスは任意に決まるため、同じユーザーから連続して送信されたリクエストが同じインスタンスに届くとは限りません。インスタンスは、複数のリクエストを同時に処理できます。インスタンスの数は、トラフィック量の変化に応じて自動的に調整されます。また、app.yaml ファイルの max_concurrent_requests 要素を設定すると、インスタンスが同時に処理できるリクエストの数を変更できます。

注: 同時リクエストは、デフォルトで App Engine スタンダード環境の Node.js ランタイムで処理されます。app.yaml ファイルに threadsafe 要素は設定できません。

次のサンプルには、サーバーを起動し、ウェブクライアントからルートパス（'/'）へのすべての GET リクエストに「Hello, world!」メッセージを表示して応答する JavaScript コードが含まれています。この応答は、ポート 8080 で実行されているサーバー経由で行われます。

appengine/hello-world/standard/app.js

GitHub で表示

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

最後の数行に注意してください。ここでは、process.env.PORT 変数で指定されるポートをサーバーがリッスンするように設定しています。これは App Engine ランタイムが設定する環境変数です。サーバーは、このポートをリッスンしないとリクエストを受信できません。

割り当てと上限

App Engine は、トラフィックが増加すると、自動的にアプリケーションにリソースを割り当てます。ただし、次のような制限があります。

App Engine は、1 秒未満でリクエストに応答するレイテンシが短いアプリケーション向けに、自動スケーリングのための容量を予約しています。
また、CPU の制約を大きく受けるアプリケーションでも、同じサーバー上の他のアプリケーションとリソースを効率的に共有するために、追加のレイテンシが生じる場合があります。静的ファイルへのリクエストには、このようなレイテンシの制限は適用されません。

アプリケーションが受信する各リクエストには、リクエスト数の上限が適用されます。リクエストへのレスポンスとして送信されるデータは、[送信帯域幅（課金対象）] の上限の対象としてカウントされます。

HTTP リクエストと HTTPS（セキュア）リクエストのどちらにも、リクエスト数、受信帯域幅（課金対象）、送信帯域幅（課金対象）の制限が適用されます。Google Cloud コンソールの割り当ての詳細ページでは、参考のために、[安全なリクエスト数]、[安全な受信帯域幅]、[安全な送信帯域幅] の値もそれぞれ報告されます。これらの値は、HTTPS リクエストにのみ適用されます。詳細については、割り当てページをご覧ください。

リクエストハンドラの使用には、それぞれ次の上限や時間制限が適用されます。

上限と時間制限	量
リクエストサイズ	32 MB
レスポンスサイズ	32 MB
リクエストのタイムアウト	アプリが使用するスケーリングのタイプに依存
最大合計ファイル数（アプリファイルと静的ファイル）	合計 10,000 ファイル 1 ディレクトリあたり 1,000 ファイル
アプリケーションファイルの最大サイズ	32 MB
静的ファイルの最大サイズ	32 MB
すべてのアプリケーションファイルと静的ファイルの最大合計サイズ	最初の 1 GB は無料最初の 1 GB を超えると、以降は 1 GB あたり毎月 $ 0.026
保留中のリクエストのタイムアウト	10 秒
1 つのリクエストヘッダーフィールドの最大サイズ	スタンダード環境の第 2 世代ランタイム用に 8 KB。これらのランタイムへのリクエストでヘッダーフィールドが 8 キロバイトを超えると、HTTP 400 エラーが返されます。

リクエストに関する上限

すべての HTTP/2 リクエストは、アプリケーションサーバーに転送される際に HTTP/1.1 リクエストに変換されます。

レスポンスに関する上限

動的レスポンスの上限は 32 MB です。スクリプトハンドラが生成したレスポンスの大きさがこの上限を超える場合は、サーバーから内部サーバーエラーステータスコード 500 を示す空のレスポンスが返されます。以前の Blobstore または Cloud Storage からのデータを処理するレスポンスには、この上限は適用されません。
第 2 世代ランタイムでは、レスポンスヘッダーの上限は 8 KB です。この上限を超えるレスポンスヘッダーは HTTP 502 エラーを返し、ログに upstream sent too big header while reading response header from upstream が記録されます。

リクエストヘッダー

受信した HTTP リクエストには、クライアントから送信された HTTP ヘッダーが含まれています。セキュリティ上の理由から、一部のヘッダーは、アプリケーションに到達する前に中間プロキシによってサニタイズ（リスクのある部分などを削除）または修正されます。

詳細については、リクエストヘッダーのリファレンスをご覧ください。

リクエストタイムアウトの処理

App Engine はリクエストの存続時間が短いアプリケーション（通常は数百ミリ秒程度）向けに最適化されています。効率的なアプリは、大部分のリクエストに短時間で応答します。そうでないアプリは、App Engine のインフラストラクチャに合わせて適切にスケールされません。このレベルのパフォーマンスを実現するには、システムによって要求される最大リクエストタイムアウト内に、すべてのアプリがレスポンスを返す必要があります。

アプリがこの期限を超過すると、App Engine はリクエストハンドラを中断します。

レスポンス

生成するレスポンスにはサイズの上限があり、レスポンスはクライアントに返される前に変更される可能性があります。

詳細については、リクエストに対するレスポンスのリファレンスをご覧ください。

レスポンスのストリーミング

App Engine は、レスポンスのストリーミングをサポートしていません。つまり、リクエスト 1 件のデータをチャンクに分けて順に送信することはできません。コードからのデータ全体が前述のように収集されて、単一の HTTP レスポンスとして送信されます。

レスポンスの圧縮

コードから返されるレスポンスで、以下の両方の条件が満たされる場合、App Engine はレスポンスのデータを圧縮します。

リクエストに、gzip を値として含む Accept-Encoding ヘッダーが含まれる。
レスポンスに、HTML、CSS、JavaScript などのテキストベースのデータが含まれる。

App Engine の静的ファイルまたはディレクトリハンドラによって返されるレスポンスの場合、次の条件がすべて満たされると、レスポンスデータが圧縮されます。

リクエストの値の 1 つとして、gzip が指定された Accept-Encoding が含まれる。
クライアントが、圧縮形式のレスポンスデータを受信できる。Google フロントエンドは、圧縮されたレスポンスを受信できないことがわかっているクライアントのリストを保持しています。これらのクライアントは、リクエストヘッダーに Accept-Encoding: gzip が含まれている場合でも、アプリの静的ハンドラから圧縮データを受信することはありません。
レスポンスに、HTML、CSS、JavaScript などのテキストベースのデータが含まれる。

次の点にご注意ください。

クライアントは Accept-Encoding と User-Agent の両方のリクエストヘッダーを gzip に設定することにより、テキストベースのコンテンツタイプの圧縮を強制できます。
リクエストで Accept-Encoding ヘッダーに gzip を指定しない場合、App Engine でレスポンスデータが圧縮されません。
Google フロントエンドは、App Engine の静的ファイルとディレクトリハンドラからのレスポンスをキャッシュに保存します。最初にキャッシュに保存されるレスポンスデータの種類、レスポンスに指定した Vary ヘッダー、リクエストに含まれるヘッダーなど、さまざまな要因によって、クライアントが圧縮データをリクエストしても圧縮されていないデータを受信する場合があります。また、その逆の場合もあります。詳細については、レスポンスのキャッシュ保存をご覧ください。

レスポンスのキャッシュ保存

Google フロントエンド、場合によってはユーザーのブラウザおよびその他の中間キャッシングプロキシサーバーは、レスポンスに指定した標準キャッシングヘッダーの指示に従って、アプリのレスポンスをキャッシュに保存します。これらのレスポンスヘッダーは、フレームワークを介して、またはコード内で直接指定するか、App Engine の静的ファイルとディレクトリハンドラを使用して指定できます。

Google フロントエンドでは、キャッシュキーはリクエストの完全な URL です。

静的コンテンツのキャッシュ保存

更新された静的コンテンツの公開後すぐにクライアントが受信できるように、css/v1/styles.css などのバージョニングされたディレクトリから静的コンテンツを配信することをおすすめします。Google フロントエンドは、キャッシュが期限切れになるまで、キャッシュの検証（更新されたコンテンツの確認）を行いません。キャッシュが期限切れになった後でも、リクエスト URL のコンテンツが変更されるまでキャッシュは更新されません。

app.yaml で設定できる次のレスポンスヘッダーは、Google フロントエンドがコンテンツをキャッシュに保存する方法とタイミングに影響します。

Google フロントエンドでコンテンツがキャッシュに保存されるようにするには、Cache-Control を public に設定する必要があります。Cache-Control private または no-store ディレクティブを指定しなければ、Google フロントエンドによってキャッシュに保存されることもあります。app.yaml でこのヘッダーを設定しない場合、App Engine で静的ファイルまたはディレクトリハンドラによって処理されるすべてのレスポンスにこのヘッダーが自動的に追加されます。詳しくは、追加または置換されるヘッダーをご覧ください。
Vary: リクエストで送信されるヘッダーに基づいて、URL に対してさまざまなレスポンスがキャッシュから返されるようにするには、Accept、Accept-Encoding、Origin、X-Origin のうち 1 つ以上を Vary レスポンスヘッダーに設定します。

カーディナリティが高い可能性があるため、他の Vary 値についてはデータがキャッシュに保存されません。

例:
1. 次のレスポンスヘッダーを指定します。
  
  Vary: Accept-Encoding
2. アプリは Accept-Encoding: gzip ヘッダーを含むリクエストを受信します。App Engine は圧縮されたレスポンスを返し、Google フロントエンドはレスポンスデータの gzip 圧縮されたバージョンをキャッシュに保存します。この URL に対する Accept-Encoding: gzip ヘッダーを含む後続のすべてのリクエストは、キャッシュが無効になる（キャッシュの有効期限が切れた後にコンテンツが変更されたことによる）までキャッシュから gzip 圧縮されたデータを受信します。
3. アプリは、Accept-Encoding ヘッダーが含まれていないリクエストを受信します。App Engine は圧縮されていないレスポンスを返し、Google フロントエンドはレスポンスデータの圧縮されていないバージョンをキャッシュに保存します。この URL に対する Accept-Encoding ヘッダーが含まれていない後続のすべてのリクエストは、キャッシュが無効になるまでキャッシュから圧縮されたデータを受信します。
Vary レスポンスヘッダーを指定しない場合、Google フロントエンドは URL に対して 1 つのキャッシュエントリを作成し、作成したエントリをリクエストのヘッダーにかかわらず、すべてのリクエストで使用します。例:
1. Vary: Accept-Encoding レスポンスヘッダーが指定されていません。
2. リクエストには Accept-Encoding: gzip ヘッダーが含まれ、レスポンスデータの gzip 圧縮されたバージョンがキャッシュに保存されます。
3. 2 番目のリクエストには Accept-Encoding: gzip ヘッダーが含まれていません。ただし、キャッシュにはレスポンスデータの gzip 圧縮されたバージョンが含まれているため、クライアントが圧縮されていないデータをリクエストした場合でも、レスポンスは gzip 圧縮されます。

リクエスト内のヘッダーもキャッシュ保存に影響します。

リクエストに Authorization ヘッダーが含まれている場合、コンテンツは Google フロントエンドによってキャッシュに保存されません。

キャッシュの有効期限

デフォルトでは、App Engine の静的ファイルとディレクトリハンドラによってレスポンスに追加されるキャッシュヘッダーは、クライアントとウェブプロキシ（Google フロントエンドなど）が 10 分後にキャッシュを期限切れにするよう指示します。

任意の有効期限が設定された状態でファイルが転送された場合、一般的にユーザーは自身のブラウザキャッシュを消去しても、ウェブプロキシのキャッシュからファイルを消去することはできません。アプリの新しいバージョンを再度デプロイしても、キャッシュはリセットされません。静的ファイルを変更する場合には、有効期限は短く（1 時間未満）設定してください。多くの場合、デフォルトの 10 分で十分です。

app.yaml ファイルで default_expiration 要素を指定すると、すべての静的ファイルとディレクトリハンドラのデフォルトの有効期限を変更できます。個別のハンドラに特定の有効期限を設定するには、app.yaml ファイルのハンドラ要素内で expiration 要素を指定します。

有効期限要素の時間で指定する値は、Cache-Control と Expires の HTTP レスポンスヘッダーの設定に使用されます。

HTTPS 接続の強制

セキュリティ上の理由から、すべてのアプリケーションは、https で接続するようクライアントに促すべきです。特定のページまたはドメイン全体で http よりも https を優先するようにブラウザに指示するには、レスポンスに Strict-Transport-Security ヘッダーを設定します。例:

Strict-Transport-Security: max-age=31536000; includeSubDomains

アプリによって配信される静的コンテンツにこのヘッダーを設定するには、アプリの静的ファイルとディレクトリハンドラにヘッダーを追加します。

コードから生成されるレスポンスに対してこのヘッダーを設定するには、helmet パッケージを使用します。

非同期バックグラウンド作業の処理

バックグラウンド作業とは、HTTP レスポンスを配信した後、アプリがリクエストに対して行う作業です。バックグラウンド作業をアプリ内で実施することは避け、コードを見直して、レスポンスを配信する前にすべての非同期オペレーションが完了するようにしてください。

長時間実行ジョブには、Cloud Tasks の使用をおすすめします。Cloud Tasks では、HTTP リクエストが長時間継続し、非同期処理が終了した後にのみレスポンスを返します。