REST Resource: labels

{
  "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)
  }
}

string

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

string

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

string

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

enum (LabelType)

مطلوبة. نوع التصنيف.

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

النتائج فقط. وقت إنشاء هذه النسخة السابقة للتصنيف.

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

string

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

object (Properties)

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

object (Lifecycle)

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

object (DisplayHints)

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

object (AppliedCapabilities)

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

object (SchemaCapabilities)

النتائج فقط. الصلاحيات التي يمتلكها المستخدم في هذا التصنيف.

object (AppliedLabelPolicy)

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

object (Field)

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

string

عنوان URL مخصّص يتم تقديمه للمستخدمين ليتمكّنوا من الاطّلاع على مزيد من المعلومات عن هذا التصنيف وكيفية استخدامه.

object (LockStatus)

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

{
  "person": string
}

string

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

{
  "title": string,
  "description": string
}

string

مطلوبة. عنوان التصنيف.

string

وصف التصنيف.

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

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

boolean

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

object (DisabledPolicy)

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

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

يمكنك اختيار ما إذا كان سيتم إخفاء هذا العنصر غير المفعَّل في قائمة البحث عن عناصر Drive.

• عند استخدام false، يظهر العنصر بشكل عام في واجهة المستخدم على أنّه غير مفعّل، ولكنه يظهر في نتائج البحث عند البحث عن عناصر Drive.
• عند true، يتم إخفاء الكائن بشكل عام في واجهة المستخدم عند البحث عن عناصر Drive.

boolean

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

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

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

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

boolean

يجب إخفاء هذا التصنيف في قائمة البحث عند البحث عن عناصر Drive.

boolean

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

string (int64 format)

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

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

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

boolean

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

boolean

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

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

{
  "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.
}

string

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

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

string

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

object (Properties)

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

object (Lifecycle)

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

object (DisplayHints)

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

object (SchemaCapabilities)

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

object (AppliedCapabilities)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

object (UserInfo)

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

string (Timestamp format)

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

object (LockStatus)

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

object (TextOptions)

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

object (IntegerOptions)

خيارات حقل العدد الصحيح

object (DateOptions)

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

object (SelectionOptions)

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

object (UserOptions)

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

{
  "minLength": integer,
  "maxLength": integer
}

integer

النتائج فقط. تمثّل هذه السمة الحد الأدنى لطول القيم الصالح في حقل النص.

integer

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

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

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

string (int64 format)

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

{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}

enum (DateFormat)

خيار تنسيق التاريخ المترجَم. يتم عرض قيم الحقول بهذا التنسيق حسب لغتها.

string

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

object (Date)

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

object (Date)

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

{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}

object (ListOptions)

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

object (Choice)

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

{
  "maxEntries": integer
}

integer

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

{
  "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)
  }
}

string

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

object (Properties)

الخصائص الأساسية من اختيارك.

object (Lifecycle)

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

object (DisplayHints)

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

object (SchemaCapabilities)

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

object (AppliedCapabilities)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

النتائج فقط. المستخدِم الذي نشر هذا الاختيار. ليس لهذه القيمة أي معنى إذا لم يتم نشر الاختيار.

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (LockStatus)

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

{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}

string

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

string

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

object (BadgeConfig)

إعدادات الشارة لهذا الخيار وعند ضبط هذا الخيار، يتم تصنيف التصنيف الذي يملك هذا الخيار على أنّه "تصنيف ذو شارة".

string

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

{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}

object (Color)

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

string (int64 format)

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

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}

boolean

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

boolean

من المفترض أن يكون هذا الخيار مخفيًا في قائمة البحث عند البحث عن عناصر في Drive.

boolean

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

object (BadgeColors)

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

object (BadgeColors)

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

string (int64 format)

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

{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}

object (Color)

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

object (Color)

النتائج فقط. شارة المقدمة التي يتم إقرانها بالخلفية

object (Color)

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

يوضّح ما إذا كان بإمكان المستخدم إيقاف هذا الخيار.

boolean

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

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

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

boolean

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

boolean

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

{
  "locked": boolean
}

boolean

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

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

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

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

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

boolean

ما إذا كان يجب وضع علامة على الحقل كمطلوب.

string

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

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

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

boolean

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

boolean

من المفترض أن يكون هذا الحقل مخفيًا في قائمة البحث عند البحث عن عناصر في Drive.

boolean

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

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

boolean

يشير ذلك إلى ما إذا كان يمكن للمستخدم البحث عن عناصر Drive التي تشير إلى هذا الحقل.

boolean

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