REST Resource: users.labels

المرجع: التصنيف

تُستخدَم التصنيفات لتصنيف الرسائل وسلاسل المحادثات داخل صندوق البريد الإلكتروني للمستخدم. الحد الأقصى لعدد التصنيفات المسموح بها لصندوق البريد الإلكتروني للمستخدم هو 10,000.

تمثيل JSON 
{
  "id": string,
  "name": string,
  "messageListVisibility": enum (MessageListVisibility),
  "labelListVisibility": enum (LabelListVisibility),
  "type": enum (Type),
  "messagesTotal": integer,
  "messagesUnread": integer,
  "threadsTotal": integer,
  "threadsUnread": integer,
  "color": {
    object (Color)
  }
}
الحقول
id

string

رقم تعريف التصنيف غير القابل للتغيير.
name

string

الاسم المعروض للتصنيف.
messageListVisibility

enum (MessageListVisibility)

مستوى رؤية الرسائل التي تحمل هذا التصنيف في قائمة الرسائل في واجهة ويب Gmail.
labelListVisibility

enum (LabelListVisibility)

إذن الوصول إلى التصنيف في قائمة التصنيفات في واجهة Gmail على الويب
type

enum (Type)

نوع مالك التصنيف. يُنشئ المستخدم تصنيفات المستخدم، ويمكن للمستخدم تعديلها وحذفها، ويمكن تطبيقها على أي رسالة أو سلسلة محادثات. يتم إنشاء تصنيفات النظام داخليًا ولا يمكن إضافتها أو تعديلها أو حذفها. في بعض الحالات، يمكن تطبيق تصنيفات النظام على الرسائل وسلاسل المحادثات أو إزالتها منها، ولكن ذلك ليس مضمونًا. على سبيل المثال، يمكن للمستخدمين تطبيق التصنيفات INBOX وUNREAD وإزالتها من الرسائل وسلاسل المحادثات، ولكن لا يمكنهم تطبيق تصنيفَي DRAFTS أو SENT أو إزالتهما من الرسائل أو سلاسل المحادثات.
messagesTotal

integer

إجمالي عدد الرسائل ذات التصنيف.
messagesUnread

integer

عدد الرسائل غير المقروءة ذات التصنيف.
threadsTotal

integer

إجمالي عدد سلاسل المحادثات ذات التصنيف.
threadsUnread

integer

عدد سلاسل المحادثات غير المقروءة ذات التصنيف.
color

object (Color)

اللون الذي تريد تخصيصه للتصنيف. لا يتوفّر اللون فقط للتصنيفات التي تم ضبط type فيها على user.

MessageListVisibility

عمليات التعداد
show إظهار التصنيف في قائمة الرسائل.
hide عدم إظهار التصنيف في قائمة الرسائل.

LabelListVisibility

عمليات التعداد
labelShow إظهار التصنيف في قائمة التصنيفات.
labelShowIfUnread إظهار التصنيف إذا كانت هناك أي رسائل غير مقروءة بهذا التصنيف.
labelHide عدم إظهار التصنيف في قائمة التصنيفات.

النوع

عمليات التعداد
system التصنيفات التي تم إنشاؤها بواسطة Gmail.
user التصنيفات المخصّصة التي أنشأها المستخدم أو التطبيق

اللون

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

string

لون نص التصنيف، ويتم تمثيله كسلسلة سداسية عشرية. هذا الحقل مطلوب لضبط لون التصنيف. ولا يُسمح فقط إلا بمجموعة قيم الألوان المحددة مسبقًا التالية:
#00000000, #43433443, #66666666, #99999999, #86666666, #9999999, #89. سمة مجموعة قيم اللون فقط التالية فقط:
#00000000, #43433443, #066666666, #9999999, #86666666, #9999999, #898.
backgroundColor

string

لون الخلفية يتم تمثيله كسلسلة سداسية عشرية #RRGGBB (على سبيل المثال #000000). هذا الحقل مطلوب لضبط لون التصنيف. ولا يُسمح فقط إلا بمجموعة قيم الألوان المحددة مسبقًا التالية:
#00000000, #43433443, #66666666, #99999999, #86666666, #9999999, #89. سمة مجموعة قيم اللون فقط التالية فقط:
#00000000, #43433443, #066666666, #9999999, #86666666, #9999999, #898.

الطُرق

create

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

delete

 الحذف النهائي والنهائي على الفور للتصنيف المحدّد وإزالته من أي رسائل وسلاسل محادثات تم تطبيقه عليها

get

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

list

 يسرد جميع التصنيفات في صندوق بريد المستخدم.

patch

 تصحيح التصنيف المحدّد.

update

 لتعديل التصنيف المحدّد.