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

 يعدِّل مخططًا.