REST Resource: labels

المورد: التصنيف

يحدّد التصنيف تصنيفًا يمكن تطبيقه على عناصر Drive لتنظيمها والبحث فيها. يمكن أن تكون التصنيفات سلاسل بسيطة، أو يمكن أن تحتوي على حقول تصف بيانات وصفية إضافية يمكن استخدامها لاحقًا لتنظيم عناصر Drive والبحث فيها.

تمثيل JSON 
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
الحقول
name

string

النتائج فقط. اسم المورد الخاص بالتصنيف سيكون بالتنسيق التالي: labels/{id} أو labels/{id}@{revisionId} حسب الطلب. يُرجى الاطّلاع على id وrevisionId أدناه.
id

string

النتائج فقط. معرّف فريد عالميًا لهذه التصنيفات. يشكّل المعرّف جزءًا من التصنيف name، ولكن على عكس name، يكون المعرّف متسقًا بين المراجعات. تتطابق مع التعبير العادي: ([a-zA-Z0-9])+.
revisionId

string

النتائج فقط. معرّف النسخة السابقة للتصنيف. قد يكون رقم تعريف المراجعة جزءًا من التصنيف name استنادًا إلى الطلب المقدَّم. يتم إنشاء مراجعة جديدة كلما تم تغيير الخصائص التي تمّت مراجعتها في تصنيف. تتطابق مع التعبير العادي: ([a-zA-Z0-9])+.
labelType

enum (LabelType)

مطلوب. تمثّل هذه السمة نوع التصنيف.
creator

object (UserInfo)

النتائج فقط. المستخدم الذي أنشأ هذا التصنيف
createTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء هذا التصنيف
revisionCreator

object (UserInfo)

النتائج فقط. المستخدم الذي أنشأ هذه النسخة المعدَّلة من التصنيف
revisionCreateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء مراجعة التصنيف هذه
publisher

object (UserInfo)

النتائج فقط. المستخدم الذي نشر هذا التصنيف ليس لهذه القيمة أي معنى عندما لا يكون التصنيف منشورًا.
publishTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه نشر هذا التصنيف ليس لهذه القيمة أي معنى عندما لا يكون التصنيف منشورًا.
disabler

object (UserInfo)

النتائج فقط. المستخدم الذي أوقف هذا التصنيف ليس لهذه القيمة أي معنى عندما لا يكون التصنيف غير مفعّل.
disableTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إيقاف هذا التصنيف ليس لهذه القيمة أي معنى عندما لا يكون التصنيف غير مفعّل.
customer

string

النتائج فقط. العميل الذي ينتمي إليه هذا التصنيف. على سبيل المثال: customers/123abc789.
properties

object (Properties)

مطلوب. الخصائص الأساسية للتصنيف
lifecycle

object (Lifecycle)

النتائج فقط. تمثّل هذه السمة حالة دورة حياة التصنيف، بما في ذلك ما إذا كان منشورًا أو متوقفًا نهائيًا أو يتضمّن تغييرات في المسودّة.
displayHints

object (DisplayHints)

النتائج فقط. تلميحات عرض واجهة المستخدم لعرض التصنيف
appliedCapabilities

object (AppliedCapabilities)

النتائج فقط. تشير هذه السمة إلى الإمكانات المرتبطة بهذا التصنيف في البيانات الوصفية المطبَّقة.
schemaCapabilities

object (SchemaCapabilities)

النتائج فقط. تشير هذه السمة إلى الإمكانات التي يتمتّع بها المستخدم في هذا التصنيف.
appliedLabelPolicy

object (AppliedLabelPolicy)

النتائج فقط. سلوك هذا التصنيف عند تطبيقه على عناصر Drive
fields[]

object (Field)

قائمة الحقول بترتيب تنازلي حسب الأولوية
learnMoreUri

string

عنوان URL مخصّص يتم عرضه للمستخدمين للسماح لهم بالاطّلاع على مزيد من المعلومات حول هذا التصنيف وكيفية استخدامه.
lockStatus

object (LockStatus)

النتائج فقط. تمثّل LockStatus هذا التصنيف.
enabledAppSettings

object (EnabledAppSettings)

اختياريّ. تمثّل هذه السمة EnabledAppSettings الخاص بهذا التصنيف.

LabelType

تمثّل هذه السمة نوع التصنيف.

عمليات التعداد
LABEL_TYPE_UNSPECIFIED نوع التصنيف غير معروف.
SHARED يمكن مشاركة التصنيفات مع المستخدمين لتطبيقها على عناصر Drive.
ADMIN تصنيف يملكه المشرف يمكن للمشرفين فقط إنشاء هذه المجموعات وتعديلها. يتيح بعض الميزات الإضافية المخصّصة للمشرفين فقط.
GOOGLE_APP تصنيف تملكه إحدى تطبيقات Google الداخلية وليس أحد العملاء. هذه التصنيفات للقراءة فقط.

UserInfo

معلومات عن مستخدم

تمثيل JSON 
{
  "person": string
}
الحقول
person

string

المعرّف الخاص بهذا المستخدم والذي يمكن استخدامه مع People API للحصول على مزيد من المعلومات مثلاً: people/12345678

الخصائص

الخصائص الأساسية للتصنيف

تمثيل JSON 
{
  "title": string,
  "description": string
}
الحقول
title

string

مطلوب. تمثّل هذه السمة عنوان التصنيف.
description

string

تمثّل هذه السمة وصف التصنيف.

مراحل النشاط

حالة مراحل النشاط لعنصر، مثل تصنيف أو حقل أو خيار لمزيد من المعلومات، يُرجى الاطّلاع على دورة حياة التصنيف.

تفرض دورة الحياة عمليات الانتقال التالية:

  • UNPUBLISHED_DRAFT (حالة البدء)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (تم الحذف)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (تم الحذف)

تتضمّن حالتا "منشور" و"غير مفعّل" بعض الخصائص المميّزة:

  • ‫Published: يمكن إجراء بعض أنواع التغييرات على عنصر في هذه الحالة، وفي هذه الحالة ستكون قيمة hasUnpublishedChanges صحيحة. بالإضافة إلى ذلك، لا يُسمح بإجراء بعض أنواع التغييرات. بشكل عام، يتم رفض أي تغيير يؤدي إلى إبطال أو فرض قيود جديدة على البيانات الوصفية الحالية المرتبطة بالتصنيف.
  • Disabled: عند إيقاف هذا الخيار، يتم تطبيق DisabledPolicy الذي تم ضبطه.
تمثيل JSON 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
الحقول
state

enum (State)

النتائج فقط. تمثّل هذه السمة حالة العنصر المرتبط بدورة الحياة هذه.
hasUnpublishedChanges

boolean

النتائج فقط. تُستخدَم لتحديد ما إذا كان العنصر المرتبط بدورة الحياة هذه يتضمّن تغييرات لم يتم نشرها.
disabledPolicy

object (DisabledPolicy)

السياسة التي تحدّد كيفية عرض تصنيف أو حقل أو خيار تحديد غير مفعّل

الحالة

تمثّل هذه السمة حالة العنصر المرتبط بدورة الحياة هذه.

عمليات التعداد
STATE_UNSPECIFIED حالة غير معروفة
UNPUBLISHED_DRAFT الحالة الأولية لعنصر وبعد نشر العنصر، لا يمكن أبدًا إرجاعه إلى هذه الحالة. بعد نشر عنصر، لن يُسمح بإجراء أنواع معيّنة من التغييرات.
PUBLISHED تم نشر العنصر. قد يحتوي العنصر على تغييرات غير منشورة في المسودة كما هو موضّح بالرمز hasUnpublishedChanges.
DISABLED تم نشر العنصر ثم إيقافه. قد يحتوي العنصر على تغييرات غير منشورة في المسودة كما هو موضّح بالرمز hasUnpublishedChanges.
DELETED تم حذف العنصر.

DisabledPolicy

السياسة التي تحدّد كيفية التعامل مع تصنيف أو حقل أو خيار محدّد تم إيقافه في سياقات مختلفة

تمثيل JSON 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
الحقول
showInApply

boolean

تحديد ما إذا كان سيتم عرض هذا العنصر غير المفعّل في قائمة التطبيق على عناصر Drive

  • عندما تكون قيمة true هي "خطأ"، يظهر العنصر عادةً في واجهة المستخدم على أنّه غير مفعَّل ولا يمكن اختياره.
  • عندما تكون القيمة false، يكون العنصر مخفيًا بشكل عام في واجهة المستخدم.

DisplayHints

تلميحات عرض واجهة المستخدم لعرض التصنيف

تمثيل JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
الحقول
disabled

boolean

تحديد ما إذا كان يجب عرض التصنيف في واجهة المستخدم على أنّه غير مفعّل
shownInApply

boolean

يجب أن يظهر هذا التصنيف في قائمة التطبيق عند تطبيق القيم على عنصر في Drive.
priority

string (int64 format)

ترتيب عرض التصنيفات في قائمة

AppliedCapabilities

تشير إلى الإمكانات التي يملكها المستخدم في ما يتعلق بالبيانات الوصفية المطبَّقة لهذا التصنيف.

تمثيل JSON 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
الحقول
canRead

boolean

تحدّد هذه السمة ما إذا كان بإمكان المستخدم قراءة البيانات الوصفية المطبَّقة المرتبطة بهذا التصنيف.
canApply

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم تطبيق هذا التصنيف على العناصر.
canRemove

boolean

تحديد ما إذا كان بإمكان المستخدم إزالة هذا التصنيف من العناصر

SchemaCapabilities

تمثّل هذه السمة الإمكانات المرتبطة بهذا التصنيف عند تعديله.

تمثيل JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
الحقول
canUpdate

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم تغيير هذا التصنيف.
canDelete

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم حذف هذا التصنيف. يجب أن يكون لدى المستخدم إذن ويجب إيقاف التصنيف.
canDisable

boolean

تحدّد هذه السمة ما إذا كان بإمكان المستخدم إيقاف هذا التصنيف. يجب أن يكون لدى المستخدم إذن ويجب ألا يكون هذا التصنيف غير مفعّل.
canEnable

boolean

تحديد ما إذا كان بإمكان المستخدم تفعيل هذا التصنيف يجب أن يكون لدى المستخدم إذن ويجب إيقاف هذا التصنيف.

AppliedLabelPolicy

سلوك هذا التصنيف عند تطبيقه على عناصر Drive

تمثيل JSON 
{
  "copyMode": enum (CopyMode)
}
الحقول
copyMode

enum (CopyMode)

تشير هذه السمة إلى كيفية نسخ التصنيف والقيم المطبَّقة عند نسخ ملف في Drive.

CopyMode

تشير هذه السمة إلى كيفية نسخ التصنيف والقيم المطبَّقة عند نسخ ملف في Drive.

عمليات التعداد
COPY_MODE_UNSPECIFIED لم يتم تحديد وضع النسخ.
DO_NOT_COPY لا يتم تلقائيًا نسخ التصنيف والقيم المطبَّقة عند نسخ عنصر Drive الذي تم تطبيقها عليه.
ALWAYS_COPY يتم دائمًا نسخ التصنيف والقيم المطبَّقة عند نسخ عنصر Drive الذي تم تطبيقهما عليه. يمكن للمشرفين فقط استخدام هذا الوضع.
COPY_APPLIABLE يتم نسخ التصنيف وقيم الحقول المُطبّقة إذا كان المستخدم الذي يجري عملية النسخ يملك الإذن بتطبيق التصنيف.

الحقل

تحدّد هذه السمة حقلاً يتضمّن اسمًا معروضًا ونوع بيانات وخيارات إعداد أخرى. يحدّد هذا الحقل نوع بيانات التعريف التي يمكن ضبطها على عنصر في Drive.

تمثيل JSON 
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
الحقول
id

string

النتائج فقط. مفتاح أحد الحقول، ويكون فريدًا داخل التصنيف أو المكتبة.

يتم إنشاء هذه القيمة تلقائيًا. تتطابق مع التعبير العادي: ([a-zA-Z0-9])+.
queryKey

string

النتائج فقط. المفتاح الذي سيتم استخدامه عند إنشاء طلبات بحث في Drive للعثور على الملفات استنادًا إلى القيم المحدّدة لهذا الحقل في الملفات. على سبيل المثال، "{queryKey} > 2001-01-01".
properties

object (Properties)

الخصائص الأساسية للحقل
lifecycle

object (Lifecycle)

النتائج فقط. دورة حياة هذا الحقل
displayHints

object (DisplayHints)

النتائج فقط. تلميحات عرض واجهة المستخدم لعرض حقل
schemaCapabilities

object (SchemaCapabilities)

النتائج فقط. تشير هذه السمة إلى الإمكانات التي يتمتّع بها المستخدم عند تعديل هذا الحقل.
appliedCapabilities

object (AppliedCapabilities)

النتائج فقط. تشير هذه السمة إلى الإمكانات التي يتمتّع بها المستخدم في هذا الحقل وقيمته عند تطبيق التصنيف على عناصر Drive.
creator

object (UserInfo)

النتائج فقط. المستخدم الذي أنشأ هذا الحقل.
createTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء هذا الحقل
updater

object (UserInfo)

النتائج فقط. المستخدم الذي عدّل هذا الحقل
updateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه تعديل هذا الحقل
publisher

object (UserInfo)

النتائج فقط. المستخدم الذي نشر هذا الحقل. ليس لهذه القيمة أي معنى عندما لا يكون الحقل منشورًا.
disabler

object (UserInfo)

النتائج فقط. المستخدم الذي أوقف هذا الحقل. ليس لهذه القيمة أي معنى عندما لا يكون الحقل غير مفعّل.
disableTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إيقاف هذا الحقل ليس لهذه القيمة أي معنى عندما لا يكون الحقل غير مفعّل.
lockStatus

object (LockStatus)

النتائج فقط. LockStatus هذا الحقل.
حقل الدمج type نوع البيانات وخيارات هذا الحقل بعد النشر، لا يمكن تغيير نوع البيانات. يمكن أن تكون type إحدى القيم التالية فقط:
textOptions

object (TextOptions)

خيارات حقل النص
integerOptions

object (IntegerOptions)

خيارات حقل الأعداد الصحيحة
dateOptions

object (DateOptions)

خيارات حقل التاريخ
selectionOptions

object (SelectionOptions)

خيارات حقل الاختيار
userOptions

object (UserOptions)

خيارات حقل المستخدم

TextOptions

خيارات لنوع الحقل النصي

تمثيل JSON 
{
  "minLength": integer,
  "maxLength": integer
}
الحقول
minLength

integer

النتائج فقط. الحد الأدنى لطول القيم الصالحة لحقل النص
maxLength

integer

النتائج فقط. الحد الأقصى لطول القيم الصالحة لحقل النص.

IntegerOptions

خيارات لنوع الحقل "عدد صحيح"

تمثيل JSON 
{
  "minValue": string,
  "maxValue": string
}
الحقول
minValue

string (int64 format)

النتائج فقط. الحد الأدنى للقيمة الصالحة لحقل العدد الصحيح
maxValue

string (int64 format)

النتائج فقط. الحد الأقصى للقيمة الصالحة لحقل العدد الصحيح

DateOptions

خيارات لنوع حقل التاريخ

تمثيل JSON 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
الحقول
dateFormatType

enum (DateFormat)

خيار تنسيق التاريخ المعدَّل بما يناسب السوق المحلية يتم عرض قيم الحقول بهذا التنسيق وفقًا للغة المنطقة.
dateFormat

string

النتائج فقط. تنسيق التاريخ في ICU
minValue

object (Date)

النتائج فقط. الحد الأدنى للقيمة الصالحة (السنة والشهر واليوم)
maxValue

object (Date)

النتائج فقط. الحدّ الأقصى للقيمة الصالحة (السنة والشهر واليوم).

DateFormat

خيارات تنسيق التاريخ المعدَّل بما يناسب السوق المحلية

عمليات التعداد
DATE_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق التاريخ.
LONG_DATE يتضمّن اسم الشهر الكامل. على سبيل المثال، 12 يناير 1999 (MMMM d, y)
SHORT_DATE تمثيل رقمي قصير مثلاً: 13/12/99 (ش/ي/س)

التاريخ

تمثّل هذه السمة تاريخ تقويم كاملاً أو جزئيًا، مثل تاريخ الميلاد. يتم تحديد الوقت من اليوم والمنطقة الزمنية في مكان آخر أو لا أهمية لهما. التاريخ نسبي بالنسبة إلى التقويم الغريغوري. يمكن أن يمثّل ذلك أحد ما يلي:

  • تاريخ كامل، مع قيم غير صفرية للسنة والشهر واليوم
  • الشهر واليوم، مع سنة صفر (على سبيل المثال، ذكرى سنوية)
  • سنة بمفردها، مع شهر ويوم بقيمة صفر
  • سنة وشهر، مع يوم صفر (على سبيل المثال، تاريخ انتهاء صلاحية بطاقة ائتمان).

الأنواع ذات الصلة:

تمثيل JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
الحقول
year

integer

سنة التاريخ يجب أن يكون الرقم بين 1 و9999، أو 0 لتحديد تاريخ بدون سنة.
month

integer

الشهر من السنة يجب أن يكون الرقم بين 1 و12، أو 0 لتحديد سنة بدون شهر ويوم.
day

integer

اليوم من الشهر يجب أن يكون الرقم بين 1 و31 وصالحًا للسنة والشهر، أو 0 لتحديد سنة بمفردها أو سنة وشهر لا يكون فيه اليوم مهمًا.

SelectionOptions

خيارات لنوع حقل الاختيار

تمثيل JSON 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
الحقول
listOptions

object (ListOptions)

عند تحديدها، تشير إلى أنّ هذا الحقل يتيح استخدام قائمة بالقيم. بعد نشر الحقل، لا يمكن تغيير هذا الإعداد.
choices[]

object (Choice)

الخيارات المتاحة لحقل الاختيار هذا ترتيب القائمة ثابت، ويتم تعديله باستخدام insertBeforeChoice.

ListOptions

خيارات لمتغير متعدد القيم لنوع حقل مرتبط

تمثيل JSON 
{
  "maxEntries": integer
}
الحقول
maxEntries

integer

الحدّ الأقصى لعدد الإدخالات المسموح به

الاختيار

اختيار حقل الاختيار

تمثيل JSON 
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
الحقول
id

string

القيمة الفريدة للخيار. يتم إنشاء هذا المعرّف تلقائيًا. تتطابق مع التعبير العادي: ([a-zA-Z0-9_])+.
properties

object (Properties)

الخصائص الأساسية للاختيار
lifecycle

object (Lifecycle)

النتائج فقط. مراحل نشاط الخيار
displayHints

object (DisplayHints)

النتائج فقط. تلميحات عرض واجهة المستخدم لتقديم خيار
schemaCapabilities

object (SchemaCapabilities)

النتائج فقط. الإمكانات المرتبطة بهذا الخيار عند تعديله
appliedCapabilities

object (AppliedCapabilities)

النتائج فقط. الإمكانات المرتبطة بهذا الخيار في البيانات الوصفية المطبَّقة
creator

object (UserInfo)

النتائج فقط. المستخدم الذي أنشأ هذا الخيار
createTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء هذا الخيار
updater

object (UserInfo)

النتائج فقط. المستخدم الذي عدّل هذا الخيار آخر مرة.
updateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه تعديل هذا الخيار آخر مرة.
publisher

object (UserInfo)

النتائج فقط. المستخدم الذي نشر هذا الخيار. ليس لهذه القيمة أي معنى عندما لا يكون الخيار منشورًا.
publishTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه نشر هذا الخيار ليس لهذه القيمة أي معنى عندما لا يكون الخيار منشورًا.
disabler

object (UserInfo)

النتائج فقط. المستخدم الذي أوقف هذا الخيار. ليس لهذه القيمة أي معنى عندما لا يكون الخيار غير مفعّل.
disableTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إيقاف هذا الخيار ليس لهذه القيمة أي معنى عندما لا يكون الخيار غير مفعّل.
lockStatus

object (LockStatus)

النتائج فقط. تمثّل هذه السمة LockStatus لهذا الخيار.

الخصائص

الخصائص الأساسية للاختيار

تمثيل JSON 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
الحقول
displayName

string

مطلوب. نص العرض المطلوب إظهاره في واجهة المستخدم لتحديد هذا الحقل.
description

string

تمثّل هذه السمة وصف التصنيف.
badgeConfig

object (BadgeConfig)

إعدادات الشارة لهذا الخيار عند ضبط هذا الخيار، يُعتبر التصنيف الذي يتضمّن هذا الخيار "تصنيفًا مزوّدًا بشارة".
insertBeforeChoice

string

الإدخال فقط إدراج هذا الخيار أو نقله قبل الخيار المحدّد إذا كانت فارغة، يتم وضع الخيار في نهاية القائمة.

BadgeConfig

حالة شارة التصنيف

تمثيل JSON 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
الحقول
color

object (Color)

لون الشارة في حال عدم تحديدها، لن يتم عرض أي شارة. يتم تغيير ألوان الخلفية والمقدمة والوضع الفردي (الوضع الفاتح والداكن) المحدّدة هنا في واجهة مستخدم Drive إلى أقرب لون مقترَح متوافق.
priorityOverride

string (int64 format)

تجاوز الأولوية العامة التلقائية لهذه الشارة عند ضبط القيمة على 0، يتم استخدام قاعدة تحديد الأولوية التلقائية.

اللون

تمثّل هذه السمة لونًا في مساحة الألوان RGBA. تم تصميم هذا التمثيل ليكون بسيطًا عند التحويل من وإلى تمثيلات الألوان بلغات مختلفة، مع التركيز على البساطة أكثر من التركيز على الحجم الصغير. على سبيل المثال، يمكن توفير حقول هذا التمثيل بشكل بسيط للدالة الإنشائية java.awt.Color في Java، ويمكن أيضًا توفيرها بشكل بسيط لطريقة +colorWithRed:green:blue:alpha في UIColor في نظام التشغيل iOS، ويمكن تنسيقها بسهولة في سلسلة rgba() CSS في JavaScript.

لا تحتوي صفحة المرجع هذه على معلومات حول مساحة الألوان المطلقة التي يجب استخدامها لتفسير قيمة الأحمر والأخضر والأزرق، مثل sRGB وAdobe RGB وDCI-P3 وBT.2020. يجب أن تفترض التطبيقات تلقائيًا مساحة الألوان sRGB.

عند الحاجة إلى تحديد تساوي الألوان، تتعامل عمليات التنفيذ مع لونين على أنّهما متساويان إذا كان كل من قيم الأحمر والأخضر والأزرق وقيمة ألفا يختلف بمقدار 1e-5 على الأكثر، ما لم يتم توثيق خلاف ذلك.

مثال (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

مثال (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

مثال (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
تمثيل JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
الحقول
red

number

تمثّل هذه السمة مقدار اللون الأحمر في اللون كقيمة في الفاصل الزمني [0, 1].
green

number

مقدار اللون الأخضر في اللون كقيمة في الفترة [0, 1]
blue

number

تمثّل هذه السمة مقدار اللون الأزرق في اللون كقيمة في الفاصل الزمني [0, 1].
alpha

number

تمثّل هذه السمة جزء اللون الذي يجب تطبيقه على البكسل. أي أنّ لون البكسل النهائي يتم تحديده من خلال المعادلة التالية:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

هذا يعني أنّ القيمة 1.0 تتوافق مع لون ثابت، بينما تتوافق القيمة 0.0 مع لون شفاف تمامًا. يستخدم هذا النوع رسالة غلاف بدلاً من عدد عشري بسيط، وذلك حتى يمكن التمييز بين القيمة التلقائية والقيمة التي لم يتم ضبطها. في حال حذفها، يتم عرض عنصر اللون هذا كلون ثابت (كما لو تم منح قيمة ألفا صراحةً القيمة 1.0).

DisplayHints

تلميحات عرض واجهة المستخدم لتقديم خيار

تمثيل JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
الحقول
disabled

boolean

تُستخدَم لتحديد ما إذا كان يجب عرض الخيار في واجهة المستخدم على أنّه غير مفعّل.
shownInApply

boolean

يجب أن يظهر هذا الخيار في قائمة "تطبيق" عند تطبيق القيم على عنصر في Drive.
badgeColors

object (BadgeColors)

الألوان التي سيتم استخدامها للشارة تم التغيير إلى ألوان Google Material استنادًا إلى properties.badge_config.color الذي تم اختياره.
darkBadgeColors

object (BadgeColors)

لون الشارة في الوضع الداكن تم التغيير إلى ألوان Google Material استنادًا إلى properties.badge_config.color الذي تم اختياره.
badgePriority

string (int64 format)

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

BadgeColors

اللون المستمد من BadgeConfig والذي تم تغييره إلى أقرب لون مقترَح متوافق

تمثيل JSON 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
الحقول
backgroundColor

object (Color)

النتائج فقط. خلفية الشارة التي تتوافق مع المقدّمة
foregroundColor

object (Color)

النتائج فقط. مقدمة الشارة التي تتوافق مع الخلفية
soloColor

object (Color)

النتائج فقط. لون يمكن استخدامه للنص بدون خلفية

SchemaCapabilities

الإمكانات المرتبطة بهذا الخيار عند تعديله

تمثيل JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
الحقول
canUpdate

boolean

تحديد ما إذا كان بإمكان المستخدم تعديل هذا الخيار
canDelete

boolean

تحديد ما إذا كان بإمكان المستخدم حذف هذا الخيار
canDisable

boolean

تحديد ما إذا كان بإمكان المستخدم إيقاف هذا الخيار
canEnable

boolean

تحديد ما إذا كان بإمكان المستخدم تفعيل هذا الخيار

AppliedCapabilities

الإمكانات المرتبطة بهذا الخيار في البيانات الوصفية المطبَّقة

تمثيل JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
الحقول
canRead

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم قراءة البيانات الوصفية ذات الصلة والمطبَّقة على العناصر.
canSelect

boolean

تحديد ما إذا كان بإمكان المستخدم اختيار هذا الخيار في أحد العناصر

LockStatus

يحتوي على معلومات عمّا إذا كان يجب اعتبار أحد عناصر التصنيف مغلقًا.

تمثيل JSON 
{
  "locked": boolean
}
الحقول
locked

boolean

النتائج فقط. تشير هذه السمة إلى ما إذا كان عنصر التصنيف هذا هو الهدف (المباشر) لقفل التصنيف. يمكن قفل أحد عناصر التصنيف ضمنيًا حتى إذا لم يكن الهدف المباشر من قفل التصنيف، وفي هذه الحالة يتم ضبط هذا الحقل على "خطأ".

UserOptions

خيارات لنوع حقل المستخدم

تمثيل JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
الحقول
listOptions

object (ListOptions)

عند تحديدها، تشير إلى أنّ هذا الحقل يتيح إدخال قائمة من القيم. بعد نشر الحقل، لا يمكن تغيير هذا الإعداد.

الخصائص

الخصائص الأساسية للحقل

تمثيل JSON 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
الحقول
displayName

string

مطلوب. نص العرض المطلوب إظهاره في واجهة المستخدم لتحديد هذا الحقل.
required

boolean

لتحديد ما إذا كان يجب وضع علامة على الحقل على أنّه مطلوب.
insertBeforeField

string

الإدخال فقط إدراج هذا الحقل أو نقله قبل الحقل المحدّد إذا كان الحقل فارغًا، يتم وضعه في نهاية القائمة.

DisplayHints

تلميحات عرض واجهة المستخدم لعرض حقل

تمثيل JSON 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
الحقول
required

boolean

تحديد ما إذا كان يجب عرض الحقل على أنّه مطلوب في واجهة المستخدم
disabled

boolean

تحديد ما إذا كان يجب عرض الحقل في واجهة المستخدم على أنّه غير مفعّل
shownInApply

boolean

يجب عرض هذا الحقل في قائمة التطبيق عند تطبيق القيم على عنصر في Drive.

SchemaCapabilities

الإمكانات المرتبطة بهذا الحقل عند تعديله

تمثيل JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
الحقول
canUpdate

boolean

تحدّد ما إذا كان بإمكان المستخدم تغيير هذا الحقل.
canDelete

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم حذف هذا الحقل. يجب أن يكون لدى المستخدم إذن ويجب إيقاف الحقل نهائيًا.
canDisable

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم إيقاف هذا الحقل. يجب أن يكون لدى المستخدم إذن ويجب ألا يكون هذا الحقل غير مفعّل.
canEnable

boolean

تحديد ما إذا كان بإمكان المستخدم تفعيل هذا الحقل. يجب أن يكون لدى المستخدم إذن ويجب إيقاف هذا الحقل.

AppliedCapabilities

الإمكانات المرتبطة بهذا الحقل في البيانات الوصفية المطبَّقة

تمثيل JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
الحقول
canRead

boolean

تُستخدَم لتحديد ما إذا كان بإمكان المستخدم قراءة البيانات الوصفية ذات الصلة والمطبَّقة على العناصر.
canWrite

boolean

تحديد ما إذا كان بإمكان المستخدم ضبط هذا الحقل على ملفات Drive.

EnabledAppSettings

توضّح هذه السمة تطبيقات Google Workspace التي يمكن استخدام التصنيف فيها.

تمثيل JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
الحقول
enabledApps[]

object (EnabledApp)

اختياريّ. قائمة التطبيقات التي يمكن استخدام التصنيف فيها

EnabledApp

تطبيق يمكن استخدام التصنيف فيه

تمثيل JSON 
{
  "app": enum (App)
}
الحقول
app

enum (App)

اختياريّ. اسم التطبيق

تطبيق

مجموعة تطبيقات Google Workspace المحتملة التي يمكن استخدام التصنيفات فيها

عمليات التعداد
APP_UNSPECIFIED غير محدّد
DRIVE Drive
GMAIL Gmail

الطُرق

create

 تنشئ هذه الطريقة تصنيفًا.

delete

 يحذف هذا الإجراء تصنيفًا والبيانات الوصفية ذات الصلة نهائيًا من عناصر Drive.

delta

 تعدّل هذه الطريقة تصنيفًا واحدًا من خلال تطبيق مجموعة من طلبات التعديل التي تؤدي إلى إنشاء مسودة جديدة.

disable

 إيقاف تصنيف منشور

enable

 تفعيل تصنيف تم إيقافه وإعادته إلى حالة النشر

get

 الحصول على تصنيف حسب اسم المورد

list

 تصنيفات القائمة

publish

 انشر جميع التغييرات في المسودة على التصنيف.

updateLabelCopyMode

 تعديل CopyMode تصنيف

updateLabelEnabledAppSettings

 تعديل EnabledAppSettings تصنيف

updatePermissions

 تعديل أذونات تصنيف