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

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

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

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

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

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

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

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

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

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

قالب‌های داده JSON و Atom

به طور پیش‌فرض، API تنظیمات گروه‌ها داده‌ها را با فرمت JSON برمی‌گرداند. نمادگذاری Atom یک فرمت داده جایگزین است. هر دو فرمت داده JSON و Atom از قابلیت‌های خواندن و نوشتن کامل پشتیبانی می‌کنند.

JSON یک فرمت رایج اینترنتی است که روشی برای نمایش ساختارهای داده دلخواه ارائه می‌دهد. طبق json.org ، JSON یک فرمت متنی است که کاملاً مستقل از زبان است اما از قراردادهایی استفاده می‌کند که برای برنامه‌نویسان زبان‌های خانواده C، از جمله C، C++، C#، Java، JavaScript، Perl و Python آشنا هستند.

شما می‌توانید قالب داده‌های API را با قرار دادن رشته کوئری alt در URI درخواست خود تغییر دهید. برای مثال:

جی‌سون 

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