Method: spaces.patch

یک فضا را به روز می کند. برای مثال، به‌روزرسانی یک فاصله را ببینید.

اگر فیلد displayName به‌روزرسانی می‌کنید و پیام خطای ALREADY_EXISTS را دریافت می‌کنید، نام نمایشی دیگری را امتحان کنید. ممکن است فضای موجود در سازمان Google Workspace قبلاً از این نام نمایشی استفاده کند.

از انواع احراز هویت زیر پشتیبانی می کند:

  • احراز هویت برنامه با تأیید سرپرست و یکی از حوزه‌های مجوز زیر:

    • https://www.googleapis.com/auth/chat.app.spaces

  • احراز هویت کاربر با یکی از حوزه های مجوز زیر:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (فقط فضاهای حالت واردات)
    • احراز هویت کاربر هنگامی که یک حساب سرپرست احراز هویت می‌شود، useAdminAccess true است و از حوزه‌های مجوز زیر استفاده می‌شود، امتیازات سرپرست اعطا می‌شود:
      • https://www.googleapis.com/auth/chat.admin.spaces

احراز هویت برنامه دارای محدودیت های زیر است:

  • برای به‌روزرسانی space.predefined_permission_settings یا space.permission_settings ، برنامه باید سازنده فضا باشد.
  • به روز رسانی space.access_settings.audience برای احراز هویت برنامه پشتیبانی نمی شود.

درخواست HTTP

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
space.name

string

شناسه. نام منبع فضا

قالب: spaces/{space}

جایی که {space} شناسه اختصاص داده شده توسط سیستم برای فضا را نشان می دهد. شما می توانید ID space را با فراخوانی متد spaces.list() یا از URL space بدست آورید. به عنوان مثال، اگر URL فاصله https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA باشد، شناسه فاصله AAAAAAAAA است.

پارامترهای پرس و جو

پارامترها
updateMask

string ( FieldMask format)

مورد نیاز. مسیرهای فیلد به روز شده، در صورت وجود چندین با کاما از هم جدا می شوند.

می توانید فیلدهای زیر را برای یک فاصله به روز کنید:

spaceDetails : توضیحات فضا را به روز می کند. پشتیبانی از 150 کاراکتر

displayName : فقط از به روز رسانی نام نمایشی برای فضاهایی که قسمت spaceType SPACE است پشتیبانی می کند. اگر پیام خطای ALREADY_EXISTS را دریافت کردید، مقدار دیگری را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند.

spaceType : فقط از تغییر نوع فضای GROUP_CHAT به SPACE پشتیبانی می کند. displayName همراه با spaceType در ماسک به‌روزرسانی قرار دهید و اطمینان حاصل کنید که فضای مشخص شده دارای یک نام نمایشی غیرخالی و نوع فضای SPACE باشد. اگر فضای موجود از قبل دارای نوع SPACE باشد، قرار دادن ماسک spaceType و نوع SPACE در فضای مشخص شده هنگام به‌روزرسانی نام نمایشی اختیاری است. تلاش برای به روز رسانی نوع فاصله به روش های دیگر منجر به خطای آرگومان نامعتبر می شود. spaceType با useAdminAccess پشتیبانی نمی شود.

spaceHistoryState : تنظیمات تاریخچه فضا را با روشن یا خاموش کردن تاریخچه برای فضا به روز می کند. فقط در صورتی پشتیبانی می‌شود که تنظیمات سابقه برای سازمان Google Workspace فعال باشد. برای به‌روزرسانی وضعیت تاریخچه فضا، باید سایر ماسک‌های فیلد را در درخواست خود حذف کنید. spaceHistoryState با useAdminAccess پشتیبانی نمی شود.

accessSettings.audience : تنظیمات دسترسی افرادی را که می توانند فضا را کشف کنند، به فضا ملحق شوند و پیام ها را در فضای نامگذاری شده پیش نمایش کنند، به روز می کند، جایی که قسمت spaceType SPACE است. اگر فضای موجود مخاطب هدف دارد، می‌توانید با حذف مقداری برای این فیلد ماسک، مخاطب را حذف کرده و دسترسی به فضا را محدود کنید. برای به‌روزرسانی تنظیمات دسترسی برای یک فضا، کاربر احراز هویت باید یک مدیر فضا باشد و همه ماسک‌های فیلد دیگر را در درخواست شما حذف کند. اگر فضا در حالت واردات باشد، نمی‌توانید این فیلد را به‌روزرسانی کنید. برای کسب اطلاعات بیشتر، به ایجاد فضای قابل کشف برای کاربران خاص مراجعه کنید. accessSettings.audience با useAdminAccess پشتیبانی نمی شود.

permissionSettings : از تغییر تنظیمات مجوز یک فضا پشتیبانی می کند. هنگام به‌روزرسانی تنظیمات مجوز، فقط می‌توانید ماسک‌های فیلد permissionSettings مشخص کنید. شما نمی توانید ماسک های فیلد دیگر را همزمان به روز کنید. permissionSettings با useAdminAccess پشتیبانی نمی شود. ماسک های زمینه پشتیبانی شده عبارتند از:

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود.

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

به محدوده chat.admin.spaces OAuth 2.0 نیاز دارد.

برخی از مقادیر FieldMask با استفاده از دسترسی مدیر پشتیبانی نمی شوند. برای جزئیات، به توضیحات updateMask مراجعه کنید.

درخواست بدن

بدنه درخواست حاوی نمونه ای از Space است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Space است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.