با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
منبع: گروه
Google Groups به کاربران شما امکان ارسال پیام به گروه‌هایی از افراد با استفاده از آدرس ایمیل گروه را می‌دهد. برای اطلاعات بیشتر در مورد وظایف رایج، به راهنمای برنامه نویس مراجعه کنید.
توجه: کاربری که با API تماس می‌گیرد (یا توسط یک حساب سرویس جعل هویت می‌شود) باید نقشی اختصاص داده شده داشته باشد که شامل مجوزهای Admin API Groups، مانند Super Admin یا Groups Admin باشد.
فقط خواندنی شناسه منحصر به فرد یک گروه. id گروه را می توان به عنوان groupKey URI درخواست گروه استفاده کرد.
email
string
آدرس ایمیل گروه اگر حساب شما دارای چندین دامنه است، دامنه مناسب را برای آدرس ایمیل انتخاب کنید. email باید منحصر به فرد باشد. این ویژگی هنگام ایجاد یک گروه مورد نیاز است. آدرس‌های ایمیل گروهی مشمول قوانین استفاده از نویسه‌ها مانند نام‌های کاربری هستند، برای جزئیات به مرکز راهنمایی مراجعه کنید.
name
string
نام نمایشی گروه
description
string
یک توضیح گسترده برای کمک به کاربران برای تعیین هدف یک گروه. به عنوان مثال، می‌توانید اطلاعاتی درباره افرادی که باید به گروه بپیوندند، انواع پیام‌هایی که باید به گروه ارسال شود، پیوندهایی به سؤالات متداول درباره گروه یا گروه‌های مرتبط اضافه کنید. حداکثر طول 4,096 کاراکتر است.
adminCreated
boolean
فقط خواندنی اگر این گروه توسط مدیر به جای کاربر ایجاد شده باشد، مقدار true است.
تعداد کاربرانی که اعضای مستقیم گروه هستند. اگر گروهی عضو (فرزند) این گروه (والد) باشد، اعضای گروه فرزند در ویژگی directMembersCount گروه والد شمارش نمی شوند.
kind
string
نوع منبع API. برای منابع Groups، مقدار admin#directory#group است.
etag
string
ETag منبع
aliases[]
string
فقط خواندنی فهرست آدرس‌های ایمیل نام مستعار یک گروه. برای افزودن، به‌روزرسانی یا حذف نام‌های مستعار یک گروه، از روش‌های groups.aliases استفاده کنید. اگر در درخواست POST یا PUT یک گروه ویرایش شود، ویرایش نادیده گرفته می شود.
nonEditableAliases[]
string
فقط خواندنی فهرستی از آدرس‌های ایمیل نام مستعار غیرقابل ویرایش گروه که خارج از دامنه یا زیر دامنه‌های اصلی حساب هستند. اینها آدرس‌های ایمیل فعالی هستند که توسط گروه استفاده می‌شوند. این یک ویژگی فقط خواندنی است که در پاسخ API برای یک گروه بازگردانده شده است. اگر در درخواست POST یا PUT یک گروه ویرایش شود، ویرایش نادیده گرفته می شود.
تاریخ آخرین به‌روزرسانی 2025-07-28 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین به‌روزرسانی 2025-07-28 بهوقت ساعت هماهنگ جهانی."],[],[],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. |"]]
