REST Resource: spaces.members

منبع: عضویت

نشان‌دهنده‌ی یک رابطه‌ی عضویت در گوگل چت است، مانند اینکه آیا یک کاربر یا برنامه‌ی چت به یک فضا دعوت شده، بخشی از آن است یا در آن غایب است.

نمایش 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 )

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

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

createTime

string ( Timestamp format)

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

deleteTime

string ( Timestamp format)

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

affiliation

enum ( Affiliation )

فقط خروجی. رابطه کاربر با سازمان فضای کاری که مالک فضا است. در فضاهایی که متعلق به حساب‌های کاربری مصرف‌کننده است، وابستگی همه اعضا EXTERNAL است.

فیلد union memberType . عضوی که با این عضویت مرتبط است. انواع دیگر عضو ممکن است در آینده پشتیبانی شوند. memberType فقط می‌تواند یکی از موارد زیر باشد:
member

object ( User )

اختیاری. کاربر یا برنامه Google Chat که عضویت مربوط به آن است. اگر برنامه Chat شما به عنوان یک کاربر احراز هویت شود ، خروجی name و type کاربر را پر می‌کند.

groupMember

object ( Group )

اختیاری. گروه گوگلی که عضویت به آن مربوط می‌شود.

خواندن یا تغییر عضویت‌ها برای گروه‌های گوگل نیازمند احراز هویت کاربر است.

عضویتدولت

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

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

نقش عضویت

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

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

عضوی از فضا. در رابط کاربری چت، این نقش، عضو (Member) نامیده می‌شود.

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

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

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

ROLE_MANAGER

مالک فضا. در رابط کاربری چت، این نقش، مالک (Owner) نامیده می‌شود.

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

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

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

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

ROLE_ASSISTANT_MANAGER

یک مدیر فضا. در رابط کاربری چت، این نقش مدیر نامیده می‌شود.

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

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

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

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

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

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

گروه

یک گروه گوگل در گوگل چت.

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

string

نام منبع برای یک گروه گوگل.

نشان‌دهنده‌ی یک گروه در API گروه‌های هویت ابری است.

قالب: groups/{group}

وابستگی

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

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

روش‌ها

create

 برای برنامه چت تماس گیرنده، یک کاربر یا یک گروه گوگل، عضویت ایجاد می‌کند.

delete

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

get

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

list

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

patch

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