REST Resource: members

منبع: عضو

یکی از اعضای Google Groups می تواند کاربر یا گروه دیگری باشد. این عضو می تواند در داخل یا خارج از دامنه های حساب شما باشد. برای اطلاعات بیشتر در مورد وظایف مشترک اعضای گروه، به راهنمای برنامه نویس مراجعه کنید.

نمایندگی JSON
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
زمینه های
kind

string

نوع منبع API. برای منابع اعضا، مقدار admin#directory#member است.

email

string

آدرس ایمیل عضو یک عضو می تواند کاربر یا گروه دیگری باشد. این ویژگی هنگام اضافه کردن یک عضو به یک گروه ضروری است. email باید منحصر به فرد باشد و نمی تواند نام مستعار گروه دیگری باشد. اگر آدرس ایمیل تغییر کند، API به طور خودکار تغییرات آدرس ایمیل را منعکس می کند.

role

string

نقش اعضا در یک گروه API یک خطا را برای چرخه های عضویت گروه برمی گرداند. برای مثال، اگر group1 عضوی از group2 باشد، group2 نمی تواند عضوی از group1 باشد. برای اطلاعات بیشتر در مورد نقش یک عضو، به اختصاص نقش های گروه به اعضا مراجعه کنید.

مقادیر قابل قبول عبارتند از:

  • MANAGER : این نقش تنها در صورتی در دسترس است که Google Groups for Business با استفاده از Admin Console فعال باشد. به روشن یا خاموش کردن Groups for Business مراجعه کنید. یک نقش MANAGER می‌تواند همه کارهایی را که توسط یک نقش OWNER انجام می‌شود انجام دهد، به جز اینکه عضوی را به عنوان OWNER یا گروه را حذف کند. یک گروه می تواند چندین عضو MANAGER داشته باشد.
  • MEMBER : این نقش می تواند در یک گروه مشترک شود، آرشیوهای بحث را مشاهده کند، و لیست عضویت گروه را مشاهده کند. برای اطلاعات بیشتر درباره نقش‌های اعضا، به اختصاص نقش‌های گروه به اعضا مراجعه کنید.
  • OWNER : این نقش می تواند به گروه پیام ارسال کند، اعضا را اضافه یا حذف کند، نقش اعضا را تغییر دهد، تنظیمات گروه را تغییر دهد و گروه را حذف کند. یک OWNER باید عضو گروه باشد. یک گروه می تواند بیش از یک OWNER داشته باشد.
etag

string

ETag منبع

type

string

نوع عضو گروه

مقادیر قابل قبول عبارتند از:

  • CUSTOMER : عضو نماینده همه کاربران در یک دامنه است. آدرس ایمیل برگردانده نمی شود و شناسه برگشتی شناسه مشتری است.
  • EXTERNAL : عضو یک کاربر یا گروه خارج از دامنه است. (در حال حاضر استفاده نمی شود)
  • GROUP : عضو یک گروه دیگر است.
  • USER : عضو یک کاربر است.
status

string

وضعیت عضو (غیرقابل تغییر)

delivery_settings

string

تنظیمات برگزیده ارسال نامه اعضا را تعریف می کند. این فیلد فقط توسط متدهای insert ، update و get پشتیبانی می شود.

مقادیر قابل قبول عبارتند از:

  • ALL_MAIL : همه پیام‌ها به محض رسیدن تحویل داده می‌شوند.
  • DAILY : بیش از یک پیام در روز نیست.
  • DIGEST : حداکثر 25 پیام در یک پیام واحد.
  • DISABLED : حذف اشتراک.
  • NONE : پیامی وجود ندارد.
id

string

شناسه منحصر به فرد عضو گروه. id عضو را می توان به عنوان memberKey از URI درخواست عضو استفاده کرد.

مواد و روش ها

delete

عضوی را از گروه حذف می کند.

get

ویژگی های یکی از اعضای گروه را بازیابی می کند.

hasMember

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

insert

کاربر را به گروه مشخص شده اضافه می کند.

list

یک لیست صفحه بندی شده از همه اعضای یک گروه را بازیابی می کند.

patch

ویژگی های عضویت یک کاربر در گروه مشخص شده را به روز می کند.

update

عضویت یک کاربر در گروه مشخص شده را به روز می کند.