REST Resource: users.labels

المورد: التصنيف

تستخدم التصنيفات لتصنيف الرسائل وسلاسل المحادثات في صندوق بريد المستخدم. الحد الأقصى لعدد التصنيفات المتوافقة مع صندوق بريد المستخدم هو 10000 تصنيف.

تمثيل 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.

إمكانية رؤية قائمة الرسائل

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

إمكانية رؤية قائمة التصنيفات

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

النوع

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

اللون

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

string

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

backgroundColor

string

لون الخلفية ممثل كسلسلة سداسية عشرية #RRGGBB (مثال #000000). هذا الحقل مطلوب لتعيين لون أحد التصنيفات. على سبيل المثال

الطُرق

create

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

delete

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

get

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

list

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

patch

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

update

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