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 از سینتکس Transcoding در gRPC استفاده می‌کند.

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

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

string

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

قالب: spaces/{space}

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

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

پارامترها
updateMask

string ( FieldMask format)

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

می‌توانید فیلدهای زیر را برای یک فضا به‌روزرسانی کنید:

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

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 است، به‌روزرسانی می‌کند. اگر فضای موجود مخاطب هدف دارد، می‌توانید مخاطب را حذف کرده و با حذف مقداری برای این ماسک فیلد، دسترسی به فضا را محدود کنید. برای به‌روزرسانی تنظیمات دسترسی برای یک فضا، کاربر احراز هویت کننده باید مدیر فضا باشد و تمام ماسک‌های فیلد دیگر را در درخواست خود حذف کند. اگر فضا در حالت import باشد، نمی‌توانید این فیلد را به‌روزرسانی کنید. برای کسب اطلاعات بیشتر، به بخش «قابل کشف کردن یک فضا برای کاربران خاص» مراجعه کنید. 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 با امتیاز مدیریت گفتگوها و مکالمات در فضاها باشد.

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

برخی از مقادیر 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

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