Status

Statusタイプは、REST API や RPC API などのさまざまなプログラミング環境に適した論理エラー モデルを定義します。 gRPCによって使用されます。各Statusメッセージには、エラー コード、エラー メッセージ、エラーの詳細という 3 つのデータが含まれています。

このエラー モデルとその操作方法の詳細については、 「API 設計ガイド」を参照してください。

JSON表現
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
田畑
code

integer

ステータス コード。 google.rpc.Codeの列挙値である必要があります。

message

string

開発者向けのエラー メッセージ。英語である必要があります。ユーザー向けのエラー メッセージはローカライズしてgoogle.rpc.Status.detailsフィールドに送信するか、クライアントによってローカライズする必要があります。

details[]

object

エラーの詳細を伝えるメッセージのリスト。 API で使用する共通のメッセージ タイプのセットがあります。

任意の型のフィールドを含むオブジェクト。追加フィールド"@type"タイプを識別する URI が含まれます。例: { "id": 1234, "@type": "types.example.com/standard/id" } 。