REST Resource: members

المرجع: عضو

يمكن أن يكون عضو "مجموعات Google" مستخدمًا أو مجموعة أخرى. يمكن أن يكون هذا العضو داخل نطاق حسابك أو خارجه. لمزيد من المعلومات عن مهام أعضاء المجموعة الشائعة، يُرجى الاطّلاع على دليل المطوّر.

تمثيل JSON
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
الحقول
kind

string

نوع مورد واجهة برمجة التطبيقات بالنسبة إلى موارد "الأعضاء"، تكون القيمة admin#directory#member.

email

string

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

role

string

دور العضو في مجموعة. تعرِض واجهة برمجة التطبيقات خطأ في الدورات في عضويات المجموعات. على سبيل المثال، إذا كان group1 عضوًا في group2، لا يمكن أن يكون group2 عضوًا في group1. لمزيد من المعلومات عن دور أحد الأعضاء، يُرجى الاطّلاع على منح أدوار المجموعة للأعضاء.

القيم المقبولة هي:

  • MANAGER: لا يتوفّر هذا الدور إلا إذا تم تفعيل "مجموعات Google للأعمال" باستخدام "وحدة تحكّم المشرف". راجِع مقالة تفعيل خدمة "مجموعات Google للشركات" أو إيقافها. يمكن لدور MANAGER تنفيذ كل ما يمكن أن يفعله دور OWNER باستثناء تحويل عضو إلى OWNER أو حذف المجموعة. يمكن أن تتضمّن المجموعة عدة MANAGER أعضاء.
  • MEMBER: يمكن لهذا الدور الاشتراك في مجموعة وعرض أرشيفات المناقشات وعرض قائمة الاشتراكات في المجموعة. لمزيد من المعلومات عن أدوار الأعضاء، يُرجى الاطّلاع على مقالة تحديد أدوار للأعضاء في المجموعة.
  • OWNER: يمكن لهذا الدور إرسال رسائل إلى المجموعة وإضافة أعضاء أو إزالتهم وتغيير أدوار الأعضاء وتغيير إعدادات المجموعة وحذفها. يجب أن يكون OWNER عضوًا في المجموعة. يمكن أن تحتوي المجموعة على أكثر من OWNER واحد.
etag

string

علامة ETag للمورد

type

string

نوع عضو المجموعة.

القيم المقبولة هي:

  • CUSTOMER: يمثّل العضو جميع المستخدمين في نطاق. لا يتم عرض عنوان بريد إلكتروني، ويكون رقم التعريف المعروض هو رقم تعريف العميل.
  • EXTERNAL: العضو هو مستخدم أو مجموعة من خارج النطاق. (لا يتم استخدامها حاليًا)
  • GROUP: العضو هو مجموعة أخرى.
  • USER: العضو هو مستخدم.
status

string

حالة العضو (غير قابلة للتغيير)

delivery_settings

string

لتحديد الإعدادات المفضّلة لتسليم البريد للعضو لا يتوفّر هذا الحقل إلا بطرائق insert وupdate وget.

القيم المقبولة هي:

  • ALL_MAIL: جميع الرسائل، يتم تسليمها فور وصولها.
  • DAILY: لا يُسمح بإرسال أكثر من رسالة واحدة في اليوم.
  • DIGEST: ما يصل إلى 25 رسالة مجمّعة في رسالة واحدة
  • DISABLED: إزالة الاشتراك
  • NONE: ما مِن رسائل.
id

string

المعرّف الفريد لعضو المجموعة. يمكن استخدام id كmemberKey لعنوان URI لطلب الاشتراك.

الطُرق

delete

تزيل عضوًا من مجموعة.

get

تستردّ سمات أحد أعضاء المجموعة.

hasMember

للتحقّق مما إذا كان المستخدم المحدّد عضوًا في المجموعة.

insert

تُضيف مستخدمًا إلى المجموعة المحدّدة.

list

يسترجع قائمة مفصّلة بجميع الأعضاء في مجموعة.

patch

تعديل سمات العضوية لمستخدم في المجموعة المحدّدة

update

تعديل عضوية مستخدم في المجموعة المحدّدة