المرجع: مجموعة
توفّر "مجموعات Google" للمستخدمين إمكانية إرسال رسائل إلى مجموعات من الأشخاص باستخدام عنوان البريد الإلكتروني للمجموعة. لمزيد من المعلومات عن المهام الشائعة، يمكنك الاطّلاع على دليل المطوّر.
للحصول على معلومات عن الأنواع الأخرى من المجموعات، يُرجى الاطّلاع على مستندات Cloud Identity Groups API.
ملاحظة: يجب أن يكون لدى المستخدم الذي يستدعي واجهة برمجة التطبيقات (أو الذي ينتحل هويته حساب خدمة) دور مخصّص له يتضمّن أذونات مجموعات Admin API، مثل "المشرف المتميّز" أو "مشرف المجموعات".
تمثيل JSON |
---|
{ "id": string, "email": string, "name": string, "description": string, "adminCreated": boolean, "directMembersCount": string, "kind": string, "etag": string, "aliases": [ string ], "nonEditableAliases": [ string ] } |
الحقول | |
---|---|
id |
للقراءة فقط. المعرّف الفريد لمجموعة. يمكن استخدام |
email |
عنوان البريد الإلكتروني للمجموعة إذا كان حسابك يتضمّن نطاقات متعددة، اختَر النطاق المناسب لعنوان البريد الإلكتروني. يجب أن يكون |
name |
الاسم المعروض للمجموعة. |
description |
وصف مفصّل لمساعدة المستخدمين في تحديد الغرض من المجموعة على سبيل المثال، يمكنك تضمين معلومات عن المستخدمين الذين عليهم الانضمام إلى المجموعة وأنواع الرسائل التي عليك إرسالها إلى المجموعة وإضافة روابط إلى الأسئلة الشائعة حول المجموعة أو المجموعات ذات الصلة. الحد الأقصى للطول هو |
adminCreated |
للقراءة فقط. تكون القيمة |
directMembersCount |
عدد المستخدمين الأعضاء المباشرين في المجموعة إذا كانت المجموعة عضوًا (فرعيًا) في هذه المجموعة (الرئيسية)، لا يتم احتساب أعضاء المجموعة الفرعية في سمة |
kind |
نوع مورد واجهة برمجة التطبيقات بالنسبة إلى موارد "مجموعات Google"، تكون القيمة |
etag |
علامة ETag للمورد |
aliases[] |
للقراءة فقط. قائمة عناوين البريد الإلكتروني البديلة للمجموعة لإضافة عناوين بريد إلكتروني بديلة للمجموعة أو تعديلها أو إزالتها، استخدِم طرق |
nonEditableAliases[] |
للقراءة فقط. قائمة عناوين البريد الإلكتروني البديلة غير القابلة للتعديل للمجموعة والتي تكون خارج النطاق الأساسي أو النطاقات الفرعية للحساب. هذه هي عناوين البريد الإلكتروني الصالحة التي تستخدمها المجموعة. هذه سمة للقراءة فقط يتم عرضها في استجابة واجهة برمجة التطبيقات لمجموعة معيّنة. في حال تعديلها في طلب POST أو PUT للمجموعة، يتم تجاهل التعديل. |