REST Resource: groups

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

توفر "مجموعات 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

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

 لتعديل المواقع الإلكترونية لمجموعة