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 كمعرّف الموارد المنتظم (URI) لطلب العضو memberKey.

الطُرق

delete

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

get

استرداد خصائص عضو مجموعة.

hasMember

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

insert

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

list

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

patch

لتعديل خصائص العضوية لمستخدم في المجموعة المحددة.

update

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