Package google.chat.v1

شاخص

سرویس چت

به برنامه‌نویسان امکان می‌دهد تا برنامه‌ها و ادغام‌های Chat را در Google Chat Platform بسازند.

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند.

به احراز هویت کاربر و تفویض اختیار در سطح دامنه با محدوده مجوز نیاز دارد:

  • https://www.googleapis.com/auth/chat.import

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.import

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

CreateCustomEmoji

rpc CreateCustomEmoji( CreateCustomEmojiRequest ) returns ( CustomEmoji )

یک ایموجی سفارشی ایجاد می کند.

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

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

  • https://www.googleapis.com/auth/chat.customemojis
محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.customemojis

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

ایجاد عضویت

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

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

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

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

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

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

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

احراز هویت برنامه برای موارد استفاده زیر پشتیبانی نمی‌شود:

  • دعوت از کاربران خارجی به سازمان Workspace که صاحب فضا است.
  • افزودن یک گروه Google به یک فضا
  • افزودن یک برنامه چت به یک فضا.

برای مثال استفاده، نگاه کنید به:

محدوده مجوز

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

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

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

ایجاد پیام

rpc CreateMessage( CreateMessageRequest ) returns ( Message )

پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید.

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

  • احراز هویت برنامه با محدوده مجوز:
    • https://www.googleapis.com/auth/chat.bot
  • احراز هویت کاربر با یکی از حوزه های مجوز زیر:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (فقط فضاهای حالت واردات)

Chat بسته به نوع احراز هویتی که در درخواست خود استفاده می کنید، فرستنده پیام را متفاوت نسبت می دهد.

تصویر زیر نشان می دهد که چگونه Chat هنگام استفاده از احراز هویت برنامه، پیامی را نسبت می دهد. Chat برنامه چت را به عنوان فرستنده پیام نمایش می دهد. محتوای پیام می‌تواند شامل متن ( text )، کارت‌ها ( cardsV2 ) و ابزارک‌های جانبی (ویدجت‌های accessoryWidgets ) باشد.

پیام با احراز هویت برنامه ارسال شد

تصویر زیر نشان می‌دهد که چگونه Chat هنگام استفاده از احراز هویت کاربر، یک پیام را مشخص می‌کند. Chat کاربر را به عنوان فرستنده پیام نمایش می دهد و برنامه Chat را با نمایش نام پیام به آن نسبت می دهد. محتوای پیام فقط می تواند حاوی متن ( text ) باشد.

پیام با احراز هویت کاربر ارسال شد

حداکثر اندازه پیام، با احتساب محتوای پیام، 32000 بایت است.

برای درخواست های وب هوک ، پاسخ حاوی پیام کامل نیست. پاسخ فقط فیلدهای name و thread.name را علاوه بر اطلاعاتی که در درخواست بود پر می کند.

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

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

CreateReaction

rpc CreateReaction( CreateReactionRequest ) returns ( Reaction )

یک واکنش ایجاد می کند و آن را به یک پیام اضافه می کند. برای مثال، افزودن واکنش به پیام را ببینید.

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

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.import (فقط فضاهای حالت واردات)
محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

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

CreateSpace

rpc CreateSpace( CreateSpaceRequest ) returns ( Space )

فضا ایجاد می کند. می توان از آن برای ایجاد یک فضای نامگذاری شده یا یک چت گروهی در Import mode استفاده کرد. برای مثال، ایجاد فاصله را ببینید.

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

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

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

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

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (فقط فضاهای حالت واردات)

هنگام احراز هویت به عنوان یک برنامه، قسمت space.customer باید در درخواست تنظیم شود.

هنگام احراز هویت به عنوان یک برنامه، برنامه Chat به عنوان عضوی از فضا اضافه می شود. با این حال، برخلاف احراز هویت انسانی، برنامه Chat به عنوان مدیر فضا اضافه نشده است. به‌طور پیش‌فرض، برنامه Chat می‌تواند توسط همه اعضای فضا از فضا حذف شود. برای اینکه فقط مدیران فضا بتوانند برنامه را از یک فضا حذف کنند، space.permission_settings.manage_apps را روی managers_allowed تنظیم کنید.

عضویت در فضا هنگام ایجاد بستگی به این دارد که آیا فضا در Import mode ایجاد شده است یا خیر:

  • حالت واردات: هیچ عضوی ایجاد نمی شود.
  • همه حالت های دیگر: کاربر تماس گیرنده به عنوان عضو اضافه می شود. این است:
    • خود برنامه هنگام استفاده از احراز هویت برنامه.
    • کاربر انسانی هنگام استفاده از احراز هویت کاربر.

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

محدوده مجوز

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

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

برای اطلاعات بیشتر، به