BadRequest

클라이언트 요청의 위반사항을 설명합니다. 이 오류 유형은 요청의 구문 측면에 중점을 둡니다.

JSON 표현
{
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
필드
fieldViolations[]

object (FieldViolation)

클라이언트 요청의 모든 위반사항을 설명합니다.

FieldViolation

단일 잘못된 요청 필드를 설명하는 데 사용되는 메시지 유형입니다.

JSON 표현
{
  "field": string,
  "description": string,
  "reason": string,
  "localizedMessage": {
    object (LocalizedMessage)
  }
}
필드
field

string

요청 본문의 필드로 연결되는 경로입니다. 값은 프로토콜 버퍼 필드를 식별하는 점으로 구분된 식별자 시퀀스입니다.

한 가지 예를 살펴보겠습니다.

message CreateContactRequest {
  message EmailAddress {
    enum Type {
      TYPE_UNSPECIFIED = 0;
      HOME = 1;
      WORK = 2;
    }

    optional string email = 1;
    repeated EmailType type = 2;
  }

  string fullName = 1;
  repeated EmailAddress email_addresses = 2;
}

이 예에서 프로토콜 field는 다음 값 중 하나를 사용할 수 있습니다.

  • fullName 값 위반의 경우 fullName
  • 첫 번째 email_addresses 메시지의 email 필드 위반에 대한 email_addresses[1].email
  • 세 번째 email_addresses 메시지의 두 번째 type 값에 대한 위반의 경우 email_addresses[3].type[2]

JSON에서 동일한 값은 다음과 같이 표현됩니다.

  • fullName 값 위반의 경우 fullName
  • 첫 번째 emailAddresses 메시지의 email 필드 위반에 대한 emailAddresses[1].email
  • 세 번째 emailAddresses 메시지의 두 번째 type 값에 대한 위반의 경우 emailAddresses[3].type[2]
description

string

요청 요소가 잘못된 이유에 대한 설명입니다.

reason

string

필드 수준 오류의 이유입니다. 필드 수준 오류의 근본 원인을 식별하는 상수 값입니다. google.rpc.ErrorInfo.domain 범위 내에서 FieldViolation의 유형을 고유하게 식별해야 합니다. 최대 63자(영문 기준)여야 하며 UPPER_SNAKE_CASE를 나타내는 정규 표현식 [A-Z][A-Z0-9_]+[A-Z0-9]와 일치해야 합니다.

localizedMessage

object (LocalizedMessage)

API 소비자에게 반환해도 안전한 필드 수준 오류의 현지화된 오류 메시지를 제공합니다.

LocalizedMessage

RPC 오류에 연결할 수 있는 사용자에게 반환해도 안전한 현지화된 오류 메시지를 제공합니다.

JSON 표현
{
  "locale": string,
  "message": string
}
필드
locale

string

https://www.rfc-editor.org/rfc/bcp/bcp47.txt에 정의된 사양에 따라 사용되는 언어입니다. 예: 'en-US', 'fr-CH', 'es-MX'

message

string

위 언어로 된 현지화된 오류 메시지입니다.