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

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