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 عدم عرض التصنيف في قائمة التصنيفات

Type

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

اللون

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

string

لون نص التصنيف، ويتم تمثيله كسلسلة سداسية عشرية. هذا الحقل مطلوب لضبط لون التصنيف. #b4c,#b9c,#9b,#9b,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#92,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#92,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#999,#929,#f3f3f3,#f3f3f3,#f3f3c2,#
backgroundColor

string

لون الخلفية ممثلة كسلسلة سداسية عشرية #RRGGBB (مثال #000000). هذا الحقل مطلوب لضبط لون التصنيف. #b4c,#b9c,#9b,#9b,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#92,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#92,#99,#99,#99,#99,#99,#99,#99,#99,#99,#99,#999,#929,#f3f3f3,#f3f3f3,#f3f3c2,#

الطُرق

create

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

delete

 يؤدي هذا الإجراء إلى حذف التصنيف المحدَّد نهائيًا وبشكل فوري وإزالته من أي رسائل وسلاسل محادثات تم تطبيقه عليها.

get

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

list

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

patch

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

update

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