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)
  }
}
الحقول
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)

النتائج فقط. حالة القفل لهذه التصنيف.

LabelType

نوع هذا التصنيف.

عمليات التعداد
LABEL_TYPE_UNSPECIFIED نوع تصنيف غير معروف.
SHARED قد تتم مشاركة التصنيفات المشتركة مع المستخدمين لتطبيقها على عناصر Drive.
ADMIN تصنيف يملكه المشرف يمكن للمشرفين فقط الإبداع والتعديل. يدعم بعض الميزات الإضافية للمشرف فقط.

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

النتائج فقط. تنسيق تاريخ وحدة العناية المركّزة (ICU)
minValue

object (Date)

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

object (Date)

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

DateFormat

خيارات تنسيق التاريخ المترجَمة

عمليات التعداد
DATE_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق التاريخ.
LONG_DATE يشمل اسم الشهر بالكامل. على سبيل المثال، 12 يناير 1999 (d MMMM، 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)

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

أماكن إقامة

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

تمثيل 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؛ ومن خلال القليل من العمل، يمكن تنسيقه بسهولة إلى سلسلة CSS rgba() في 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 بناءً على properties.badge_config.color الذي تم اختياره.
darkBadgeColors

object (BadgeColors)

لون الوضع الداكن الذي تريد استخدامه للشارة تم التغيير إلى ألوان مواد Google بناءً على 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

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

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

الطُرق

create

 ينشئ تصنيفًا جديدًا.

delete

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

delta

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

disable

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

enable

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

get

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

list

 تصنيفات القوائم.

publish

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

updateLabelCopyMode

 يعدِّل CopyMode للتصنيف.

updatePermissions

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