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

لون نص التصنيف، ويتم تمثيله كسلسلة سداسية عشرية. هذا الحقل مطلوب لضبط لون تصنيف. يُسمح فقط بمجموعة قيم الألوان المحدّدة مسبقًا التالية:
#000000 و#434343 و#666666 و#999999 و#cccccc و#efefef و#f3f3f3 و#ffffff و#fb4c2f و#ffad47 و#fad165 و#16a766 و#43d692 و#4a86e8 و#a479e2 و#f691b3 و#f6c5be و#ffe6c7 و#fef1d1 و#b9e4d0 و#c6f3de و#c9daf8 و#e4d7f5 و#fcdee8 و#efa093 و#ffd6a2 و#fce8b3 و#89d3b2 و#a0eac9 و#a4c2f4 و#d0bcf1 و#fbc8d9 و#e66550 و#ffbc6b و#fcda83 و#44b984 و#68dfa9 و#6d9eeb و#b694e8 و#f7a7c0 و#cc3a21 و#eaa041 و#f2c960 و#149e60 و#3dc789 و#3c78d8 و#8e63ce و#e07798 و#ac2b16 و#cf8933 و#d5ae49 و#0b804b و#2a9c68 و#285bac و#653e9b و#b65775 و#822111 و#a46a21 و#aa8831 و#076239 و#1a764d و#1c4587 و#41236d و#83334c و#464646 و#e7e7e7 و#0d3472 و#b6cff5 و#0d3b44 و#98d7e4 و#3d188e و#e3d7ff و#711a36 و#fbd3e0 و#8a1c0a و#f2b2a8 و#7a2e0b و#ffc8af و#7a4706 و#ffdeb5 و#594c05 و#fbe983 و#684e07 و#fdedc1 و#0b4f30 و#b3efd3 و#04502e و#a2dcc1 و#c2c2c2 و#4986e7 و#2da2bb و#b99aff و#994a64 و#f691b2 و#ff7537 و#ffad46 و#662e37 و#ebdbde و#cca6ac و#094228 و#42d692 و#16a765
backgroundColor

string

لون الخلفية ممثَّلاً كسلسلة سداسية عشرية ‎ #RRGGBB (مثلاً ‎ #000000) هذا الحقل مطلوب لضبط لون تصنيف. يُسمح فقط بمجموعة قيم الألوان المحدّدة مسبقًا التالية:
#000000 و#434343 و#666666 و#999999 و#cccccc و#efefef و#f3f3f3 و#ffffff و#fb4c2f و#ffad47 و#fad165 و#16a766 و#43d692 و#4a86e8 و#a479e2 و#f691b3 و#f6c5be و#ffe6c7 و#fef1d1 و#b9e4d0 و#c6f3de و#c9daf8 و#e4d7f5 و#fcdee8 و#efa093 و#ffd6a2 و#fce8b3 و#89d3b2 و#a0eac9 و#a4c2f4 و#d0bcf1 و#fbc8d9 و#e66550 و#ffbc6b و#fcda83 و#44b984 و#68dfa9 و#6d9eeb و#b694e8 و#f7a7c0 و#cc3a21 و#eaa041 و#f2c960 و#149e60 و#3dc789 و#3c78d8 و#8e63ce و#e07798 و#ac2b16 و#cf8933 و#d5ae49 و#0b804b و#2a9c68 و#285bac و#653e9b و#b65775 و#822111 و#a46a21 و#aa8831 و#076239 و#1a764d و#1c4587 و#41236d و#83334c و#464646 و#e7e7e7 و#0d3472 و#b6cff5 و#0d3b44 و#98d7e4 و#3d188e و#e3d7ff و#711a36 و#fbd3e0 و#8a1c0a و#f2b2a8 و#7a2e0b و#ffc8af و#7a4706 و#ffdeb5 و#594c05 و#fbe983 و#684e07 و#fdedc1 و#0b4f30 و#b3efd3 و#04502e و#a2dcc1 و#c2c2c2 و#4986e7 و#2da2bb و#b99aff و#994a64 و#f691b2 و#ff7537 و#ffad46 و#662e37 و#ebdbde و#cca6ac و#094228 و#42d692 و#16a765

الطُرق

create

 تُستخدَم لإنشاء تصنيف جديد.

delete

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

get

 تعرض هذه الطريقة التصنيف المحدّد.

list

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

patch

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

update

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