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[1].email بسبب مخالفة في الحقل email للرسالة الأولى email_addresses
  • email_addresses[3].type[2] بسبب مخالفة في القيمة الثانية type في الرسالة الثالثة email_addresses

في JSON، يتم تمثيل القيم نفسها على النحو التالي:

  • fullName لانتهاك في قيمة fullName
  • emailAddresses[1].email بسبب مخالفة في الحقل email للرسالة الأولى emailAddresses
  • emailAddresses[3].type[2] بسبب مخالفة في القيمة الثانية type في الرسالة الثالثة emailAddresses
description

string

وصف لسبب عدم صلاحية عنصر الطلب.

reason

string

سبب الخطأ على مستوى الحقل. هذه قيمة ثابتة تحدّد السبب المباشر للخطأ على مستوى الحقل. يجب أن يحدّد بشكل فريد نوع FieldViolation ضمن نطاق google.rpc.ErrorInfo.domain. يجب ألا يزيد عدد الأحرف عن 63 حرفًا وأن يتطابق مع التعبير العادي [A-Z][A-Z0-9_]+[A-Z0-9] الذي يمثّل UPPER_SNAKE_CASE.

localizedMessage

object (LocalizedMessage)

توفّر هذه السمة رسالة خطأ مترجَمة للأخطاء على مستوى الحقل، ويمكن إرجاعها بأمان إلى مستهلك واجهة برمجة التطبيقات.

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

رسالة الخطأ المترجَمة باللغة المحدّدة أعلاه