REST Resource: groups

المرجع: مجموعة

تتيح "مجموعات 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

string

للقراءة فقط. المعرّف الفريد لمجموعة. يمكن استخدام مجموعة id كمعرّف URI لطلب المجموعة groupKey.
email

string

عنوان البريد الإلكتروني للمجموعة. إذا كان حسابك يحتوي على نطاقات متعددة، اختَر النطاق المناسب لعنوان البريد الإلكتروني. يجب أن تكون قيمة السمة email فريدة. هذه السمة مطلوبة عند إنشاء مجموعة. تخضع عناوين البريد الإلكتروني للمجموعات لقواعد استخدام الأحرف نفسها كأسماء المستخدمين. لمزيد من التفاصيل، يُرجى الاطّلاع على مركز المساعدة.
name

string

الاسم المعروض للمجموعة.
description

string

وصف موسَّع لمساعدة المستخدمين في تحديد الغرض من المجموعة. على سبيل المثال، يمكنك تضمين معلومات حول المستخدمين الذين يستطيعون الانضمام إلى المجموعة أو أنواع الرسائل التي يتم إرسالها إلى المجموعة أو تضمين روابط إلى الأسئلة الشائعة حول المجموعة أو المجموعات ذات الصلة. الحد الأقصى للطول هو 4,096 حرف.
adminCreated

boolean

للقراءة فقط. تكون القيمة true إذا أنشأ هذه المجموعة مشرف وليس مستخدم.
directMembersCount

string (int64 format)

عدد المستخدمين الأعضاء المباشرين في المجموعة. إذا كانت إحدى المجموعات عضوًا (فرعيًا) في هذه المجموعة (المجموعة الرئيسية)، لا يتم احتساب أعضاء المجموعة الفرعية في السمة directMembersCount للمجموعة الرئيسية.
kind

string

نوع مورد واجهة برمجة التطبيقات. بالنسبة إلى موارد "مجموعات Google"، تكون القيمة هي admin#directory#group.
etag

string

علامة ETag للمورد.
aliases[]

string

للقراءة فقط. قائمة بعناوين البريد الإلكتروني البديلة لمجموعة. لإضافة الأسماء المستعارة لمجموعة أو تعديلها أو إزالتها، يمكنك استخدام طرق groups.aliases. في حال تعديله في طلب POST أو PUT لمجموعة، يتم تجاهل التعديل.
nonEditableAliases[]

string

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

الطُرق

delete

 حذف مجموعة

get

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

insert

 ينشئ مجموعة.

list

 استرداد جميع مجموعات نطاق أو لمستخدم بواسطة مفتاح userKey (مقسّم على صفحات).

patch

 تُحدّث خصائص المجموعة.

update

 تُحدّث خصائص المجموعة.