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 المجموعة كgroupKey لعنوان URI لطلب المجموعة.
|
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 للمجموعة، يتم تجاهل التعديل.
|
الطُرق |
|
|
حذف مجموعة |
|
|
لاسترداد خصائص مجموعة |
|
|
لإنشاء مجموعة |
|
|
يسترجع جميع مجموعات نطاق أو مستخدم معيّن باستخدام مفتاح مستخدم (مقسّمة إلى صفحات). |
|
|
تعديل خصائص المجموعة |
|
|
تعديل خصائص المجموعة |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-24 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-24 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# REST Resource: groups\n\nResource: Group\n---------------\n\nGoogle Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups).\n\nFor information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups).\n\nNote: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"email\": string, \"name\": string, \"description\": string, \"adminCreated\": boolean, \"directMembersCount\": string, \"kind\": string, \"etag\": string, \"aliases\": [ string ], \"nonEditableAliases\": [ string ] } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. |\n| `email` | `string` The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. |\n| `name` | `string` The group's display name. |\n| `description` | `string` An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. |\n| `adminCreated` | `boolean` Read-only. Value is `true` if this group was created by an administrator rather than a user. |\n| `directMembersCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. |\n| `kind` | `string` The type of the API resource. For Groups resources, the value is `admin#directory#group`. |\n| `etag` | `string` ETag of the resource. |\n| `aliases[]` | `string` Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored. |\n| `nonEditableAliases[]` | `string` Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| ### [delete](/workspace/admin/directory/reference/rest/v1/groups/delete) | Deletes a group. |\n| ### [get](/workspace/admin/directory/reference/rest/v1/groups/get) | Retrieves a group's properties. |\n| ### [insert](/workspace/admin/directory/reference/rest/v1/groups/insert) | Creates a group. |\n| ### [list](/workspace/admin/directory/reference/rest/v1/groups/list) | Retrieves all groups of a domain or of a user given a userKey (paginated). |\n| ### [patch](/workspace/admin/directory/reference/rest/v1/groups/patch) | Updates a group's properties. |\n| ### [update](/workspace/admin/directory/reference/rest/v1/groups/update) | Updates a group's properties. |"]]
