REST Resource: schemas

المورد: المخطط

نوع مورد واجهة برمجة التطبيقات. بالنسبة إلى موارد المخطط، تكون القيمة هي admin#directory#schema دائمًا.

تمثيل JSON
{
  "schemaId": string,
  "schemaName": string,
  "fields": [
    {
      object (SchemaFieldSpec)
    }
  ],
  "displayName": string,
  "kind": string,
  "etag": string
}
الحقول
schemaId

string

المعرّف الفريد للمخطط (للقراءة فقط)

schemaName

string

اسم المخطط.

يجب أن تكون قيمة كل schemaName فريدة ضمن العميل. تؤدي إعادة استخدام اسم إلى خطأ 409: Entity already exists.

fields[]

object (SchemaFieldSpec)

تمثّل هذه السمة قائمة الحقول في المخطط.

displayName

string

الاسم المعروض للمخطط.

kind

string

هذا هو مصدر هذا المرجع.

etag

string

علامة ETag للمورد.

SchemaFieldSpec

يمكنك استخدام المخططات لإضافة حقول مخصصة إلى الملفات الشخصية للمستخدمين. يمكنك استخدام هذه الحقول لتخزين معلومات مثل المشروعات التي يعمل عليها المستخدمون، أو مواقعهم الفعلية، أو تواريخ التوظيف، أو أي شيء آخر يتناسب مع احتياجات عملك. للمزيد من المعلومات، يُرجى الاطّلاع على حقول المستخدم المُخصَّصة.

تمثيل JSON
{
  "fieldName": string,
  "fieldId": string,
  "fieldType": string,
  "multiValued": boolean,
  "kind": string,
  "etag": string,
  "indexed": boolean,
  "displayName": string,
  "readAccessType": string,
  "numericIndexingSpec": {
    "minValue": number,
    "maxValue": number
  }
}
الحقول
fieldName

string

اسم الحقل.

fieldId

string

المعرّف الفريد للحقل (للقراءة فقط)

fieldType

string

نوع الحقل.

القيم المقبولة هي:

  • BOOL: القيم المنطقية
  • DATE: التواريخ بتنسيق ISO-8601
  • DOUBLE: قيم النقطة العائمة مزدوجة الدقة.
  • EMAIL: عناوين البريد الإلكتروني
  • INT64: قيم عدد صحيح 64 بت.
  • PHONE: أرقام الهواتف
  • STRING: قيَم السلسلة
multiValued

boolean

يشير ذلك المصطلح إلى قيمة منطقية تحدّد ما إذا كان هذا الحقل متعدد القيم أم لا. اللغة التلقائية: false.

kind

string

تمثّل هذه السمة نوع المورد. بالنسبة إلى حقول المخطّطات، تكون القيمة دائمًا admin#directory#schema#fieldspec.

etag

string

علامة ETag للحقل.

indexed

boolean

قيمة منطقية تحدد ما إذا كان الحقل مفهرسًا أم لا. اللغة التلقائية: true.

displayName

string

الاسم المعروض للحقل

readAccessType

string

يحدِّد هذا الإعداد المستخدمين الذين يمكنهم الاطّلاع على قيم هذا الحقل. يُرجى الاطِّلاع على استرداد المستخدمين بصفتهم غير مشرفين لمزيد من المعلومات.

ملاحظة: قد يستغرق ظهور التغييرات في هذا الحقل مدة تصل إلى 24 ساعة.

القيم المقبولة هي:

  • ADMINS_AND_SELF: لا يمكن الاطّلاع على القيم إلا للمشرفين والمستخدم المرتبط بها.
  • ALL_DOMAIN_USERS: يمكن لأي مستخدم في نطاقك الاطّلاع على القيم.
numericIndexingSpec

object

مواصفات الفهرسة لحقل رقمي. سيتم تلقائيًا دعم طلبات البحث ذات المطابقة التامة فقط للحقول الرقمية. يؤدي ضبط numericIndexingSpec إلى السماح باستخدام طلبات البحث للنطاق.

numericIndexingSpec.minValue

number

الحد الأدنى لقيمة هذا الحقل. من المفترض أن يكون هذا مؤشرًا بدلاً من فرضه. ستتم فهرسة القيم التي تتجاوز هذا النطاق، ولكن قد لا يكون أداء البحث هو نفسه.

numericIndexingSpec.maxValue

number

القيمة القصوى لهذا الحقل. من المفترض أن يكون هذا مؤشرًا بدلاً من فرضه. ستتم فهرسة القيم التي تتجاوز هذا النطاق، ولكن قد لا يكون أداء البحث هو نفسه.

الطُرق

delete

لحذف مخطط.

get

يسترد مخططًا.

insert

تنشئ مخططًا.

list

يسترد جميع المخططات لعميل.

patch

تصحيح في مخطط

update

تُحدّث مخططًا.