نمای کلی API تنظیمات گروه ها
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
API تنظیمات گروه ها تنظیمات یک گروه Google موجود را به روز می کند و بازیابی می کند. از طریق API می توانید کارهای زیر را انجام دهید:
- تنظیمات گروه را برای دسترسی به گروه داخلی و خارجی تغییر دهید.
- اعلان های گروه را ویرایش کنید.
- بایگانی بحث و مدیریت پیام را پیکربندی کنید.
- گروه های کاربری حساب خود را سفارشی کنید.
برای روشهای بیشتر برای کار با Google Groups یا مدیریت انواع دیگر گروهها، به مستندات Cloud Identity مراجعه کنید.
تنظیمات گروهها مدل داده API
API تنظیمات گروه ها بر روی یک منبع Groups
عمل می کند که نشان دهنده نحوه ارتباط و همکاری کاربران در یک حساب با گروه هایی از افراد دیگر است. هر گروه با آدرس ایمیل گروه مشخص می شود.
مدل دادههای API بر اساس مجموعه Groups
گروههای حساب است. هر گروه دارای مجموعه ای منحصر به فرد از تنظیمات پیکربندی است.
تنظیمات گروه ها عملیات API
همانطور که در جدول زیر توضیح داده شده است، می توانید روش های تنظیمات گروه را در API تنظیمات گروه ها فراخوانی کنید:
عملیات | توضیحات | REST نگاشت HTTP |
---|
get | تنظیمات گروه را برای حساب مشتری دریافت می کند. همه عملیات دریافت باید توسط یک کاربر تایید شده مجاز باشد. | در یک URI گروهی GET . |
update | تنظیمات گروه را برای حساب مشتری به روز می کند. تمام عملیات به روز رسانی باید توسط یک کاربر تایید شده مجاز باشد. | URI گروهی را PUT . |
به طور پیش فرض، Groups Settings API داده ها را در قالب JSON برمی گرداند. نماد اتم یک قالب داده جایگزین است. هر دو فرمت داده JSON و Atom از قابلیت خواندن و نوشتن کامل پشتیبانی می کنند.
JSON یک فرمت اینترنتی رایج است که روشی برای نمایش ساختارهای داده دلخواه ارائه می کند. طبق json.org ، JSON یک قالب متنی است که کاملاً مستقل از زبان است، اما از قراردادهایی استفاده می کند که برای برنامه نویسان خانواده زبان های C، از جمله C، C++، C#، Java، JavaScript، Perl و Python آشنا هستند.
برای تغییر فرمت دادههای API، رشته جستجوی alt
را در URI درخواست خود وارد کنید—به عنوان مثال:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
اتم
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Groups Settings API overview\n\nThe Groups Settings API updates and retrieves settings for an existing\n[Google Group](https://support.google.com/a/topic/25838?&ref_topic=9197). Through\nthe API, you can do the following:\n\n- Modify a group's settings for internal and external group access.\n- Edit the group's notifications.\n- Configure discussion archiving and message moderation.\n- Customize your account's user groups.\n\nFor more ways to work with Google Groups, or manage other types of groups, see the\n[Cloud Identity documentation](https://cloud.google.com/identity/docs).\n\n### Groups Settings API data model\n\nThe Groups Settings API operates on a `Groups` resource which represents how users\nwithin an account communicate and collaborate with groups of other people. Each group is identified\nby the group's email address.\n\nThe API data model is based on the `Groups` collection of the account's groups. Each\ngroup has a unique set of configuration settings.\n\n### Groups Settings API operations\n\nYou can call group settings methods in the Groups Settings API, as described in the following\ntable:\n\n| Operation | Description | REST HTTP mappings |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|\n| `get` | Gets a group's settings for a customer's account. All get operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `GET` on a group URI. |\n| `update` | Updates a group's settings for a customer's account. All update operations must be authorized by an [authenticated](/workspace/guides/auth-overview) user. | `PUT` on a group URI. |\n\nJSON and Atom data formats\n--------------------------\n\nBy default, the Groups Settings API returns data in JSON format. The Atom notation is an alternate\ndata format. Both the JSON and Atom data formats support full read-write capabilities.\n\nJSON is a common\ninternet format that provides a method of representing arbitrary data structures. According to\n[json.org](http://www.json.org), JSON is a text format\nthat is completely language-independent but uses conventions that are familiar to programmers of\nthe C-family of languages, including C, C++, C#, Java, JavaScript, Perl, and Python.\n\n\u003cbr /\u003e\n\nTo change the API's data format, include the `alt` query string in your request's\nURI---for example:\n\n### JSON\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json\n```\n\n### Atom\n\n```\nGET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom\n```"]]