المرجع: مجموعة
تتيح "مجموعات Google" للمستخدمين إمكانية إرسال رسائل إلى مجموعات من الأشخاص باستخدام عنوان البريد الإلكتروني للمجموعة. لمزيد من المعلومات عن المهام الشائعة، يُرجى الاطّلاع على دليل المطوِّر.
للحصول على معلومات عن الأنواع الأخرى من المجموعات، يُرجى الاطّلاع على مستندات واجهة برمجة تطبيقات مجموعات Cloud Identity.
ملاحظة: يجب أن يكون للمستخدم الذي يتصل بواجهة برمجة التطبيقات (أو ينتحل هويته باستخدام حساب خدمة) دور معيّن يتضمن أذونات المجموعات في واجهة برمجة تطبيقات المشرف، مثل "المشرف المتميّز" أو "مشرف المجموعات".
تمثيل 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 لمجموعة، يتم تجاهل التعديل. |
الطُرق |
|
---|---|
|
حذف مجموعة |
|
استرداد خصائص مجموعة. |
|
ينشئ مجموعة. |
|
استرداد جميع مجموعات نطاق أو لمستخدم بواسطة مفتاح userKey (مقسّم على صفحات). |
|
تُحدّث خصائص المجموعة. |
|
تُحدّث خصائص المجموعة. |