ドキュメント

サポート

Cloud Code

Cloud Code API の呼び出し

Invoke module endpoints using HTTP requests to the Cloud Code REST API.
読み終わるまでの所要時間 1 分最終更新 23日前

Cloud Code API を呼び出して、モジュールエンドポイントを実行します。詳細については、Cloud Code API のドキュメント を参照してください。

認証

サービスアカウントまたはステートレストークンを使用してプレイヤーまたは信頼されているクライアントとして認証するには、認証 を参照してください。受信したトークンを Bearer トークンとしてリクエストヘッダーで HTTP 認証に使用します。
Authorization: Bearer <BEARER_TOKEN>

モジュールエンドポイントリクエストの実行

POST リクエストを以下の宛先に送信することで、Cloud Code API を呼び出します。
https://cloud-code.services.api.unity.com/v1/projects/<PROJECT_ID>/modules/<MODULE_NAME>/<FUNCTION_NAME>
パスパラメーターを定義します。
  • PROJECT_ID
    - プロジェクトの ID。
  • MODULE_NAME
    - モジュールの名前。
  • FUNCTION_NAME
    - モジュールエンドポイントの名前。これは、コードで定義した
    CloudCodeFunction
    です。
単純な cURL コマンドは以下のようになります。
curl --request POST 'https://cloud-code.services.api.unity.com/v1/projects/<PROJECT_ID>/modules/<MODULE_NAME>/<FUNCTION_NAME>' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer <BEARER_TOKEN>'

リクエストペイロード

メソッドシグネチャ内部でモジュール関数のパラメーターを定義できます。モジュール関数を構造化する方法については、モジュール構造 を参照してください。例えば、以下のメソッドは、文字列パラメーターである weapon と bodyPart を定義します。
[CloudCodeFunction("IntroduceGuard")]public string IntroduceGuard(string weapon, string bodyPart){return $"I used to be an adventurer like you. Then I took an ${weapon} to the ${bodyPart}.";}
これらのパラメーターは、エンドポイントを呼び出すときに JSON としてリクエスト本文内で渡されます。パラメーターの大文字と小文字はメソッドシグネチャと一致している必要があります。
{ "params": { "weapon": "arrow", "bodyPart": "knee" }}
完全な cURL コマンドは以下のようになります。
curl --request POST 'https://cloud-code.services.api.unity.com/v1/projects/<PROJECT_ID>/modules/<MODULE_NAME>/<FUNCTION_NAME>' \--header 'Content-Type: application/json' \--header 'Authorization: Bearer <BEARER_TOKEN>' \--data-raw '{ "params": { "weapon": "arrow", "bodyPart": "knee" }}'

サンプル出力

これはモジュールの出力例です。
{ "output": "I used to be an adventurer like you. Then I took an arrow to the knee."}