ドキュメント

Unity Engine

Unity Engine

Unity ウェブ リクエスト API の概要

Unity のリクエストI の主な用途とアーキテクチャを理解します。
読み終わるまでの所要時間 6 分最終更新 5日前

UnityWebRequest
は、ウェブ サービスとの通信、ファイル転送、ランタイムのストリーミング データのためのUnityのHTTP/HTTPSネットワークAPIです。
Unity ウェブ リクエスト システムの一般的な用途は次のとおりです。
  • ランタイムに次のようなコンテンツをダウンロードする。
    • リモートサーバからのアセットバンドル (通常の AssetBundle または Addressables システムを使用する場合)。
    • 設定、Localization、およびライブチューニング用のテキスト/JSON。
    • 動的コンテンツの画像 (テクスチャとして) とオーディオ (AudioClip として)。
    • リモートマニフェストによるビルド時またはランタイムのパッチ適用。
  • 次のようなサーバへのデータのアップロード
    • プレイヤーメトリクス。
    • 保存されたゲームステート。
    • エラー/例外ログとクラッシュレポート。
    • カスタムテレメトリとAnalytics。
  • コンテンツ配信ネットワーク、認証とセキュリティ、支払いプラットフォーム、Multiplayer Services、診断、リモートビルドパイプラインとの統合。
  • 低トラフィック、ネットワークMultiplayer、およびチェスなどのターン制ゲームの実装。

アーキテクチャ

Unity ウェブ リクエスト システムは、次の 2 つのレイヤーで構成されています。
  • 高レベル API (HLAPI) は、低レベル API をラップし、一般的な操作に便利なインターフェースを提供します。
  • LLAPI(Low-Level API)は、より上級者向けの運用に最大限の柔軟性を提供します。
システムは HTTP トランザクションを以下の操作に分割します。
  • サーバーにデータを送信する。
  • サーバーからデータを受信する。
  • HTTP フローコントロール(リダイレクトやエラー処理例えば)。
これらの各操作は、特定のタイプのオブジェクトによってマネージされ、これを使用してトランザクションの側面をカスタマイズおよびコントロールできます。
  • UploadHandler
    オブジェクトは、サーバーへのデータの送信を処理します。
  • DownloadHandler
    オブジェクトは、サーバーから受信したデータの受信、バッファリング、および後処理を処理します。
  • UnityWebRequest
    オブジェクトは、他の 2 つのオブジェクトを管理し、HTTP フローコントロールも処理します。このオブジェクトは、カスタム ヘッダーと URL が定義され、エラーとリダイレクト情報が格納される場所です。

Data sent from user code passes through an UploadHandler and then a UnityWebRequest before reaching the HTTP web server. Data received from the server passes through a UnityWebRequest and then a DownloadHandler before reaching user code.

以下の、HTTP トランザクションの概要です。
  • オブジェクトを作成します。
  • UnityWebRequest
    オブジェクトを設定します。
    • カスタムヘッダーを設定します。
    • HTTP Verb を設定します (
      GET
      、
      POST
      、
      HEAD
      など)。カスタム Verb はすべてのプラットフォームで使用できます。
    • URL を設定します。
  • (任意)アップロードハンドラーを作成し、ウェブリクエストにアタッチ、設定、添付します。
    • アップロードするデータを指定します。
    • アップロードする HTTP フォームを指定します。
  • (任意) ダウンロードハンドラーを作成し、ウェブリクエストにアタッチ、設定、添付します。
  • ウェブ リクエストを送信します。
  • (任意)ダウンロード ハンドラーから受信したデータを読み取ります。
  • (任意)
    UnityWebRequest
    オブジェクトからエラー情報、HTTP 状態コード、および反応ヘッダーを読み取ります。
これらの手順を示す詳細なコード例については、
UploadHandlerRaw
の API ドキュメントを参照してください。

追加リソース