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)

النتائج فقط. حالة قفل هذا التصنيف.
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 -> (محذوف)

تختلف حالة "تم نشر التطبيق" عن حالة "تم إيقاف التطبيق" في بعض الخصائص:

  • تم نشره: قد يتم إجراء بعض أنواع التغييرات على عنصر في هذه الحالة، وفي هذه الحالة سيكون hasUnpublishedChanges صحيحًا. ولا يُسمح أيضًا ببعض أنواع التغييرات. بشكل عام، يتم رفض أي تغيير قد يؤدي إلى إبطال البيانات الوصفية الحالية ذات الصلة بالتصنيف أو فرض قيود جديدة عليها.
  • غير مفعَّل: عند إيقاف هذه القيمة، يتم تطبيق القيمة 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)

النتائج فقط. حالة قفل هذا الحقل.
حقل الربط 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

النتائج فقط. تنسيق التاريخ في وحدة العناية المركزة
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 من خلال القليل من العمل.

لا تحتوي صفحة المرجع هذه على معلومات عن مساحة الألوان المطلقة التي يجب استخدامها لتفسير قيمة RGB، مثل 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

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

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

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

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

object (EnabledApp)

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

EnabledApp

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

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

enum (App)

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

تطبيق

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

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

الطُرق

create

 لإنشاء تصنيف جديد

delete

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

delta

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

disable

 أوقِف تصنيفًا منشورًا.

enable

 فعِّل تصنيفًا غير مفعَّل وأعِدّه إلى حالته المنشورة.

get

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

list

 إدراج التصنيفات

publish

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

updateLabelCopyMode

 تعديل CopyMode للتصنيف

updateLabelEnabledAppSettings

 تعديل EabledAppSettings لتصنيف معيّن

updatePermissions

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