REST Resource: spaces.members

منبع: عضویت

نشان‌دهنده رابطه عضویت در Google Chat است، مثلاً اینکه آیا کاربر یا برنامه Chat به فضایی دعوت شده است، بخشی از آن است، یا در آن حضور ندارد.

نمایش JSON 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
فیلدها
name

string

شناسه. نام منبع عضویت، اختصاص‌داده‌شده توسط سرور.

قالب: spaces/{space}/members/{member}
state

enum (MembershipState)

فقط خروجی. وضعیت عضویت.
role

enum (MembershipRole)

اختیاری. نقش کاربر در فضای Chat که کنش‌های مجاز او را در فضا تعیین می‌کند.

این فیلد فقط می‌تواند به‌عنوان ورودی در members.patch استفاده شود.
createTime

string (Timestamp format)

اختیاری. تغییرناپذیر. زمان ایجاد عضویت، مثلاً زمانی که عضو به فضا پیوسته یا برای پیوستن به آن دعوت شده است. این فیلد فقط خروجی است، به‌جز زمانی که برای وارد کردن عضویت‌های قدیمی در فضاهای حالت وارد کردن استفاده می‌شود.
deleteTime

string (Timestamp format)

اختیاری. تغییرناپذیر. زمان حذف عضویت، مثلاً وقتی عضوی فضا را ترک کرده یا از آن برداشته شده است. این فیلد فقط خروجی است، به‌جز زمانی که برای وارد کردن عضویت‌های قدیمی در فضاهای حالت وارد کردن استفاده می‌شود.
affiliation

enum (Affiliation)

فقط خروجی. رابطه کاربر با سازمان Workspace که مالک فضا است. در فضاهایی که متعلق به حساب‌های مصرف‌کننده است، وابستگی همه اعضا EXTERNAL است.
عضو مرتبط با این عضویت. ممکن است در آینده از انواع دیگر اعضا پشتیبانی شود. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
member

object (User)

اختیاری. کاربر یا برنامه Google Chat که عضویت با آن مطابقت دارد. اگر برنامه Chat شما به‌عنوان کاربر اصالت‌سنجی کند، خروجی فقط فیلدهای کاربر name و type را برای کاربران داخلی و خارجی پر می‌کند، مگراینکه آن‌ها عضو فضا باشند یا ازقبل با کاربر تماس‌گیرنده ارتباطی داشته باشند، مثلاً مکالمه پیام مستقیم (DM).
groupMember

object (Group)

اختیاری. «گروه Google» که عضویت با آن مطابقت دارد.

خواندن یا تغییر عضویت‌ها برای «گروه‌های Google» به اصالت‌سنجی کاربر نیاز دارد.
پایان فیلدهای متقابلاً انحصاری.

MembershipState

رابطه عضو با فضا را مشخص می‌کند. ممکن است در آینده از وضعیت‌های عضویت دیگر پشتیبانی شود.

شمارشی‌ها
MEMBERSHIP_STATE_UNSPECIFIED مقدار پیش‌فرض. استفاده نشود.
JOINED کاربر به فضا اضافه می‌شود و می‌تواند در فضا مشارکت کند.
INVITED کاربر برای پیوستن به فضا دعوت شده است، اما به آن نپیوسته است.
NOT_A_MEMBER کاربر به فضا تعلق ندارد و دعوت معلقی برای پیوستن به فضا ندارد.

MembershipRole

کنش‌های مجاز کاربر را در فضای Chat نشان می‌دهد. ممکن است در آینده مقادیر enum بیشتری اضافه شود.

شمارشی‌ها
MEMBERSHIP_ROLE_UNSPECIFIED مقدار پیش‌فرض. برای users: او عضو فضا نیست، اما می‌توان او را دعوت کرد. برای Google Groups: همیشه این نقش به آن‌ها اختصاص داده می‌شود (ممکن است در آینده از مقادیر شمارشی دیگری استفاده شود).
ROLE_MEMBER

عضوی از فضا. در واسط کاربر Chat، این نقش «عضو» نامیده می‌شود.

کاربر اجازه‌های پایه دارد، مثل ارسال پیام به فضا. مدیران و مالکان می‌توانند اجازه‌های بیشتری به اعضای فضا اعطا کنند، ازجمله:

  • عضو اضافه یا حذف کنید.
  • اصلاح جزئیات فضا.
  • روشن یا خاموش کردن سابقه.
  • با @all از همه افراد حاضر در فضا نام ببرید.
  • برنامه‌های Chat و وب‌قلاب‌های نصب‌شده در فضا را مدیریت کنید.

در پیام‌های مستقیم و مکالمه‌های گروهی بی‌نام، همه این نقش را دارند.
ROLE_MANAGER

مالک فضا باشید. در واسط کاربر Chat، این نقش «مالک» نامیده می‌شود.

کاربر مجموعه کاملی از اجازه‌های فضا را برای مدیریت فضا دارد، ازجمله:

  • نقش سایر اعضا را در فضا به عضو، مدیر، یا مالک تغییر دهید.
  • فضا را حذف کنید.

فقط در SpaceType.SPACE (فضاهای نام‌گذاری‌شده) پشتیبانی می‌شود.

برای کسب اطلاعات بیشتر، به درباره نقش خود به‌عنوان مالک یا مدیر فضا بیشتر بدانید مراجعه کنید.
ROLE_ASSISTANT_MANAGER

مدیر فضا باشید. در واسط کاربر Chat، این نقش «مدیر» نامیده می‌شود.

کاربر همه اجازه‌های اصلی ROLE_MEMBER را دارد و مالک می‌تواند زیرمجموعه‌ای از اجازه‌های مدیریتی را به او اعطا کند. به‌طور پیش‌فرض، مدیران همه اجازه‌های مالک را دارند به‌جز توانایی:

  • فضا را حذف کنید.
  • مالک کردن عضو دیگری از فضا.
  • نقش مالک را تغییر دهید.

به‌طور پیش‌فرض، اجازه‌های مدیران شامل موارد زیر می‌شود، اما به آن‌ها محدود نیست:

  • عضو دیگری را مدیر کنید.
  • پیام‌ها را در فضا حذف کنید.
  • اجازه‌های فضا را مدیریت کنید.
  • اگر مدیر در تنظیمات فضا اجازه «مدیریت اعضا» را داشته باشد، اعلان‌های درخواست پیوستن به فضا را دریافت می‌کند.
  • فضایی را یافتنی کنید.

فقط در SpaceType.SPACE (فضاهای نام‌گذاری‌شده) پشتیبانی می‌شود.

برای کسب اطلاعات بیشتر، به مدیریت تنظیمات فضا بروید.

گروه

«گروه Google» در Google Chat.

نمایش JSON 
{
  "name": string
}
فیلدها
name

string

نام منبع برای «گروه Google».

نشان‌دهنده گروه در Cloud Identity Groups API است.

قالب: groups/{group}

وابسته

نشان‌دهنده وابستگی کاربر به سازمان Google Workspace است که مالک فضا است. ممکن است در آینده مقادیر بیشتری به این شمارش اضافه شود.

شمارشی‌ها
AFFILIATION_UNSPECIFIED مقدار پیش‌فرض. از این مقدار استفاده نمی‌شود.
INTERNAL حسابی که توسط همان سازمان Google Workspace مالک فضا مدیریت می‌شود.
EXTERNAL حسابی خارج از سازمان Google Workspace که مالک فضا است (برای مثال، حساب مصرف‌کننده، یا حسابی که توسط سازمان Workspace دیگری مدیریت می‌شود).
MANAGED_EXTERNAL حسابی که توسط سازمان Workspace مالک فضا مدیریت می‌شود، اما برای کاربری که خارج از سازمان است (مثلاً کاربر مهمان) تدارک دیده شده است. برای کسب اطلاعات بیشتر درباره مهمانان، به https://support.google.com/chat/answer/16997417 مراجعه کنید.

روش‌ها

create

 عضویتی برای برنامه Chat تماس‌گیرنده، کاربر، یا «گروه Google» ایجاد می‌کند.

delete

 عضویت را حذف می‌کند.

get

 جزئیات مربوط به عضویت را برمی‌گرداند.

list

 عضویت‌ها را در فضا فهرست می‌کند.

patch

 عضویت را به‌روز می‌کند.