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

 تعديل مخطّط