نمای کلی API تنظیمات گروه ها

API تنظیمات گروه ها تنظیمات یک گروه Google موجود را به روز می کند و بازیابی می کند. از طریق API می توانید کارهای زیر را انجام دهید:

  • تنظیمات گروه را برای دسترسی به گروه داخلی و خارجی تغییر دهید.
  • اعلان های گروه را ویرایش کنید.
  • بایگانی بحث و مدیریت پیام را پیکربندی کنید.
  • گروه های کاربری حساب خود را سفارشی کنید.

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

تنظیمات گروه‌ها مدل داده API

API تنظیمات گروه ها بر روی یک منبع Groups عمل می کند که نشان دهنده نحوه ارتباط و همکاری کاربران در یک حساب با گروه هایی از افراد دیگر است. هر گروه با آدرس ایمیل گروه مشخص می شود.

مدل داده‌های API بر اساس مجموعه Groups گروه‌های حساب است. هر گروه دارای مجموعه ای منحصر به فرد از تنظیمات پیکربندی است.

تنظیمات گروه ها عملیات API

همانطور که در جدول زیر توضیح داده شده است، می توانید روش های تنظیمات گروه را در API تنظیمات گروه ها فراخوانی کنید:

عملیات توضیحات REST نگاشت HTTP
get تنظیمات گروه را برای حساب مشتری دریافت می کند. همه عملیات دریافت باید توسط یک کاربر تایید شده مجاز باشد. در یک URI گروهی GET .
update تنظیمات گروه را برای حساب مشتری به روز می کند. تمام عملیات به روز رسانی باید توسط یک کاربر تایید شده مجاز باشد. URI گروهی را PUT .

فرمت های داده JSON و Atom

به طور پیش فرض، 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