REST Resource: groups

منبع: گروه

Google Groups به کاربران شما امکان ارسال پیام به گروه‌هایی از افراد با استفاده از آدرس ایمیل گروه را می‌دهد. برای اطلاعات بیشتر در مورد وظایف رایج، به راهنمای برنامه نویس مراجعه کنید.

برای اطلاعات در مورد انواع دیگر گروه‌ها، به مستندات Cloud Identity Groups API مراجعه کنید.

توجه: کاربری که با API تماس می‌گیرد (یا توسط یک حساب سرویس جعل هویت می‌شود) باید نقشی اختصاص داده شده داشته باشد که شامل مجوزهای Admin API Groups، مانند Super Admin یا Groups Admin باشد.

نمایندگی 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

نوع منبع API. برای منابع Groups، مقدار admin#directory#group است.

etag

string

ETag منبع

aliases[]

string

فقط خواندنی فهرست آدرس‌های ایمیل نام مستعار یک گروه. برای افزودن، به‌روزرسانی یا حذف نام‌های مستعار یک گروه، از روش‌های groups.aliases استفاده کنید. اگر در درخواست POST یا PUT یک گروه ویرایش شود، ویرایش نادیده گرفته می شود.

nonEditableAliases[]

string

فقط خواندنی فهرستی از آدرس‌های ایمیل نام مستعار غیرقابل ویرایش گروه که خارج از دامنه یا زیر دامنه‌های اصلی حساب هستند. اینها آدرس‌های ایمیل فعالی هستند که توسط گروه استفاده می‌شوند. این یک ویژگی فقط خواندنی است که در پاسخ API برای یک گروه بازگردانده شده است. اگر در درخواست POST یا PUT یک گروه ویرایش شود، ویرایش نادیده گرفته می شود.

روش ها

delete

 یک گروه را حذف می کند.

get

 ویژگی های یک گروه را بازیابی می کند.

insert

 یک گروه ایجاد می کند.

list

 همه گروه های یک دامنه یا کاربری که یک userKey داده شده (صفحه بندی شده) را بازیابی می کند.

patch

 ویژگی های یک گروه را به روز می کند.

update

 ویژگی های یک گروه را به روز می کند.