Method: projects.chatAppConfig.get

پیکربندی برنامه Chat پروژه را دریافت می‌کند. فقط از برنامه‌های Chat که به‌عنوان برافزاهای Google Workspace ساخته شده‌اند پشتیبانی می‌شود. هر پروژه Google Cloud دقیقاً یک پیکربندی برنامه Chat دارد.

به اصالت‌سنجی و صدور مجوز با اعتبارنامه کاربر و اجازه‌های IAM gsuiteaddons.chatAppConfigs.get و chat.bots.get در پروژه نیاز دارد.

درخواست HTTP

GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/chatAppConfig}

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

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

پارامترها
name

string

الزامی. نام منبع پیکربندی برنامه Chat.

قالب: projects/{project}/chatAppConfig، که {project} شماره پروژه Google Cloud است.

مجوزدهی به اجازه IAM زیر در منبع name مشخص‌شده نیاز دارد:

  • gsuiteaddons.chatAppConfigs.get
  • chat.bots.get

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

پارامترها
view

enum (ChatAppConfigView)

اختیاری. نمای ChatAppConfig برای برگرداندن. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی BASIC تنظیم می‌شود.

متن درخواست

بدنه درخواست باید خالی باشد.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از ChatAppConfig است.

دامنه‌های مجوز

به یکی از دامنه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

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

ChatAppConfigView

نمایی که مشخص می‌کند کدام فیلدها باید در منبع ChatAppConfig تکمیل شوند.

شمارشی‌ها
CHAT_APP_CONFIG_VIEW_UNSPECIFIED مقدار پیش‌فرض یا تنظیم‌نشده. پیش‌فرض‌ها به BASIC.
BASIC فقط فراداده‌های پایه مربوط به پیکربندی برنامه را بدون پیکربندی ویژگی تعاملی پر می‌کند. این مقدار پیش‌فرض است.
FULL همه فیلدها ازجمله پیکربندی‌های ویژگی تعاملی را پر می‌کند.