ErrorDetail
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
検証エラーまたは内部エラーの原因となったエラーの詳細です。
JSON 表現 |
{
"code": integer,
"field": string,
"message": string,
"value": string,
"fieldIndex": integer
} |
フィールド |
code |
integer
ステータス コード。ErrorCode の列挙値である必要があります。
|
field |
string
リクエスト本文のフィールドへのパス。値は、プロトコル バッファ フィールドを識別する、ドットで区切られた識別子のシーケンスです。例: errorDetails.fieldこのフィールドを識別します
|
message |
string
フィールドがエラーの原因となった理由の説明。メッセージは英語であり、ユーザーへの表示には適さない可能性があります。
|
value |
string
リクエストに失敗した値。
|
fieldIndex |
integer
このエラーを生成したリクエスト フィールドが繰り返される場合、検証が失敗する原因となった、そのフィールドのエントリのゼロベースのインデックスが含まれます。
|
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-25 UTC。
[null,null,["最終更新日 2025-07-25 UTC。"],[[["\u003cp\u003eThe JSON representation details errors encountered during validation or internal processes, providing specific information about the error.\u003c/p\u003e\n"],["\u003cp\u003eError details include a status code, field path, error message, problematic value, and potentially the index within a repeated field.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efield\u003c/code\u003e attribute uses dot-separated identifiers to pinpoint the location of the error within the request body.\u003c/p\u003e\n"],["\u003cp\u003eWhile the \u003ccode\u003emessage\u003c/code\u003e offers a description of the failure, it's intended for internal use and might not be user-friendly.\u003c/p\u003e\n"]]],[],null,["# ErrorDetail\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nDetails an error that resulted in a validation or internal failure.\n\n| JSON representation ||\n|---------------------------------------------------------------------------------------------------------|---|\n| ``` { \"code\": integer, \"field\": string, \"message\": string, \"value\": string, \"fieldIndex\": integer } ``` |\n\n| Fields ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `integer` The status code, which should be an enum value of [ErrorCode](/my-business/reference/rest/Shared.Types/ErrorCode). |\n| `field` | `string` A path leading to a field in the request body. The value is a sequence of dot-separated identifiers that identify a protocol buffer field. For example, \"errorDetails.field\" would identify this field. |\n| `message` | `string` A description of why the field caused a failure. The message is in English and may not be suitable for display to users. |\n| `value` | `string` The value that failed the request. |\n| `fieldIndex` | `integer` If the request field that generated this error is repeated, this will contain the zero based index of the entry in that field which caused validation to fail. |"]]