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

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

حذف سفارشی ایموجی

rpc DeleteCustomEmoji( DeleteCustomEmojiRequest ) returns ( Empty )

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

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

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

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

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

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

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

حذف عضویت

rpc DeleteMembership( DeleteMembershipRequest ) 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

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

  • حذف یک گروه Google از یک فضا.
  • حذف یک برنامه چت از یک فضا.

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

محدوده مجوز

به یکی از حوزه های 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

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

DeleteMessage

rpc DeleteMessage( DeleteMessageRequest ) returns ( Empty )

یک پیام را حذف می کند. برای مثال، حذف یک پیام را ببینید.

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

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

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

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

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

هنگام استفاده از احراز هویت برنامه، درخواست‌ها فقط می‌توانند پیام‌های ایجاد شده توسط برنامه چت را حذف کنند.

محدوده مجوز

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

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

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

DeleteReaction

rpc DeleteReaction( DeleteReactionRequest ) returns ( Empty )

واکنش به یک پیام را حذف می کند. برای مثال، حذف واکنش را ببینید.

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

  • 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

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

DeleteSpace

rpc DeleteSpace( DeleteSpaceRequest ) returns ( Empty )

فضای نامگذاری شده را حذف می کند. همیشه یک حذف آبشاری انجام می دهد، به این معنی که منابع فرزند فضا - مانند پیام های ارسال شده در فضا و عضویت در فضا - نیز حذف می شوند. برای مثال، حذف یک فاصله را ببینید.

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

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

    • https://www.googleapis.com/auth/chat.app.delete (فقط در فضاهایی که برنامه ایجاد کرده است)

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

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

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

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

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

FindDirectMessage

rpc FindDirectMessage( FindDirectMessageRequest ) returns ( Space )

پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. اگر فضای پیام مستقیم پیدا نشد، خطای 404 NOT_FOUND را برمی‌گرداند. برای مثال، به یافتن یک پیام مستقیم مراجعه کنید.

با احراز هویت برنامه ، فضای پیام مستقیم بین کاربر مشخص شده و برنامه چت در حال تماس را برمی‌گرداند.

با احراز هویت کاربر ، فضای پیام مستقیم بین کاربر مشخص شده و کاربر احراز هویت شده را برمی گرداند.

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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

GetAttachment

rpc GetAttachment( GetAttachmentRequest ) returns ( Attachment )

فراداده یک پیوست پیام را دریافت می کند. داده‌های پیوست با استفاده از API رسانه واکشی می‌شوند. برای مثال، به دریافت فراداده درباره پیوست پیام مراجعه کنید.

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

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

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

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

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

GetCustomEmoji

rpc GetCustomEmoji( GetCustomEmojiRequest ) returns ( CustomEmoji )

جزئیات یک ایموجی سفارشی را برمی گرداند.

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

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

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

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

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

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

GetMembership

rpc GetMembership( GetMembershipRequest ) returns ( Membership )

جزئیات عضویت را برمی‌گرداند. برای مثال، به دریافت جزئیات درباره عضویت کاربر یا برنامه چت Google مراجعه کنید.

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (نیاز به تایید سرپرست دارد)

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

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

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

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

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

GetMessage

rpc GetMessage( GetMessageRequest ) returns ( Message )

جزئیات یک پیام را برمی گرداند. برای مثال، به دریافت جزئیات درباره یک پیام مراجعه کنید.

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

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

    • https://www.googleapis.com/auth/chat.bot : هنگام استفاده از این محدوده مجوز، این روش جزئیات پیامی را که برنامه Chat به آن دسترسی دارد، مانند پیام‌های مستقیم و دستورات اسلش که برنامه Chat را فراخوانی می‌کنند، برمی‌گرداند.
    • https://www.googleapis.com/auth/chat.app.messages.readonly با تأیید سرپرست (موجود در پیش‌نمایش برنامه‌نویس ). هنگام استفاده از این محدوده احراز هویت، این روش جزئیات یک پیام عمومی را در یک فضا برمی گرداند.

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

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages

توجه: ممکن است پیامی از یک عضو یا فضای مسدود شده بازگرداند.

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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

GetSpace

rpc GetSpace( GetSpaceRequest ) returns ( Space )

جزئیات یک فضا را برمی‌گرداند. برای مثال، به دریافت جزئیات در مورد یک فضا مراجعه کنید.

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces با تأیید سرپرست

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

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

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

  • space.access_settings فقط هنگام استفاده از محدوده chat.app.spaces پر می شود.
  • space.predefind_permission_settings و space.permission_settings فقط هنگام استفاده از محدوده chat.app.spaces پر می شوند و فقط برای فضاهایی که برنامه ایجاد کرده است.
محدوده مجوز

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

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

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

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

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

توجه: فیلد permissionSettings در شی Space داده های رویداد Space برای این درخواست بازگردانده نمی شود.

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

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

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

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

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

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

برای مثال، به دریافت جزئیات یک رویداد از فضای گپ Google مراجعه کنید.

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting( GetSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

تنظیمات اعلان فضایی را دریافت می کند. برای مثال، تنظیمات اعلان فضای تماس گیرنده را دریافت کنید .

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

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

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

GetSpaceReadState

rpc GetSpaceReadState( GetSpaceReadStateRequest ) returns ( SpaceReadState )

جزئیات مربوط به وضعیت خوانده شده کاربر را در یک فضا باز می گرداند که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود. برای مثال، به دریافت جزئیات در مورد وضعیت خواندن فضای کاربر مراجعه کنید.

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

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

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

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

GetThreadReadState

rpc GetThreadReadState( GetThreadReadStateRequest ) returns ( ThreadReadState )

جزئیات مربوط به وضعیت خواندن کاربر در یک رشته را که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود، برمی گرداند. برای مثال، به دریافت جزئیات در مورد وضعیت خواندن رشته کاربر مراجعه کنید.

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

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

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

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

ListCustomEmojis

rpc ListCustomEmojis( ListCustomEmojisRequest ) returns ( ListCustomEmojisResponse )

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

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

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

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

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

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

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

لیست اعضا

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse )

عضویت ها را در یک فضا فهرست می کند. برای مثال، فهرست کاربران و برنامه‌های چت Google را در یک فضا ببینید. فهرست کردن عضویت‌ها با احراز هویت برنامه، عضویت‌ها را در فضاهایی فهرست می‌کند که برنامه Chat به آنها دسترسی دارد، اما عضویت‌های برنامه Chat، از جمله عضویت خود را استثنا نمی‌کند. فهرست کردن عضویت‌ها با احراز هویت کاربر، عضویت‌ها را در فضاهایی فهرست می‌کند که کاربر احراز هویت شده به آنها دسترسی دارد.

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (نیاز به تایید سرپرست دارد)

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

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

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

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

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

ListMessages

rpc ListMessages( ListMessagesRequest ) returns ( ListMessagesResponse )

پیام‌ها را در فضایی فهرست می‌کند که تماس‌گیرنده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها. پیام‌های سیستم، مانند پیام‌هایی که اعضای جدید فضایی را اعلام می‌کنند، شامل نمی‌شوند. اگر پیام‌هایی را از یک فضای بدون پیام فهرست کنید، پاسخ یک شی خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {} است. برای مثال، فهرست پیام‌ها را ببینید.

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

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

    • https://www.googleapis.com/auth/chat.app.messages.readonly . هنگام استفاده از این محدوده احراز هویت، این روش فقط پیام های عمومی را در یک فاصله برمی گرداند. شامل پیام خصوصی نمی شود.

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

    • https://www.googleapis.com/auth/chat.messages.readonly
    • 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.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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

ListReactions

rpc ListReactions( ListReactionsRequest ) returns ( ListReactionsResponse )

واکنش ها به یک پیام را فهرست می کند. برای مثال، فهرست واکنش‌ها را برای یک پیام ببینید.

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

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

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

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

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

ListSpaceEvents

rpc ListSpaceEvents( ListSpaceEventsRequest ) returns ( ListSpaceEventsResponse )

رویدادها را از فضای چت Google فهرست می کند. برای هر رویداد، محموله حاوی جدیدترین نسخه منبع چت است. برای مثال، اگر رویدادهای مربوط به اعضای جدید فضایی را فهرست کنید، سرور منابع Membership را که حاوی آخرین جزئیات عضویت است، برمی‌گرداند. اگر اعضای جدید در طول دوره درخواستی حذف شوند، بار رویداد حاوی یک منبع Membership خالی است.

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

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

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

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

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

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

برای مثال، فهرست رویدادها را از فضای گپ Google ببینید.

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

ListSpaces

rpc ListSpaces( ListSpacesRequest ) returns ( ListSpacesResponse )

فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. تا زمانی که اولین پیام ارسال نشود، چت‌های گروهی و پیام‌های پیامکی فهرست نمی‌شوند. برای مثال، لیست فاصله ها را ببینید.

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

برای فهرست کردن همه فضاهای نامگذاری شده توسط سازمان Google Workspace، به جای آن از روش spaces.search() با استفاده از امتیازات سرپرست Workspace استفاده کنید.

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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

فضاهای جستجو

rpc SearchSpaces( SearchSpacesRequest ) returns ( SearchSpacesResponse )

فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمی‌گرداند. در درخواست، use_admin_access روی true تنظیم کنید. برای مثال، به جستجو و مدیریت فضاها مراجعه کنید.

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

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

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

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

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

SetUpSpace

rpc SetUpSpace( SetUpSpaceRequest ) returns ( Space )

فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. کاربر تماس گیرنده به طور خودکار به فضا اضافه می شود و نباید به عنوان عضویت در درخواست مشخص شود. برای مثال، به تنظیم فضایی با اعضای اولیه مراجعه کنید.

برای تعیین اعضای انسانی برای افزودن، عضویت هایی را با membership.member.name مناسب اضافه کنید. برای افزودن یک کاربر انسانی، users/{user} استفاده کنید، جایی که {user} می‌تواند آدرس ایمیل کاربر باشد. برای کاربران در همان سازمان Workspace {user} همچنین می‌تواند id شخص از People API یا id کاربر در Directory API باشد. برای مثال، اگر شناسه نمایه افراد API People برای [email protected] 123456789 باشد، می‌توانید با تنظیم membership.member.name به users/[email protected] یا users/123456789 کاربر را به فضا اضافه کنید.

برای تعیین گروه‌های Google برای افزودن، عضویت‌ها را با membership.group_member.name مناسب اضافه کنید. برای افزودن یا دعوت یک گروه Google، groups/{group} استفاده کنید، جایی که {group} id گروه از Cloud Identity Groups API است. برای مثال، می‌توانید از API جستجوی Cloud Identity Groups برای بازیابی شناسه 123456789 برای ایمیل گروهی [email protected] استفاده کنید، سپس می‌توانید با تنظیم membership.group_member.name group_member.name به groups/123456789 گروه را به فضا اضافه کنید. ایمیل گروهی پشتیبانی نمی‌شود و گروه‌های Google را فقط می‌توان به‌عنوان عضو در فضاهای نام‌گذاری شده اضافه کرد.

برای یک فضای نامگذاری شده یا چت گروهی، اگر تماس گیرنده مسدود شود، یا توسط برخی از اعضا مسدود شده باشد، یا اجازه اضافه کردن برخی از اعضا را نداشته باشد، آن اعضا به فضای ایجاد شده اضافه نمی شوند.

برای ایجاد یک پیام مستقیم (DM) بین کاربر تماس گیرنده و کاربر انسانی دیگر، دقیقاً یک عضویت را برای نشان دادن کاربر انسانی مشخص کنید. اگر یکی از کاربران دیگری را مسدود کند، درخواست با شکست مواجه می شود و DM ایجاد نمی شود.

برای ایجاد DM بین کاربر تماس گیرنده و برنامه تماس گیرنده، Space.singleUserBotDm را روی true تنظیم کنید و هیچ عضویتی را مشخص نکنید. شما فقط می توانید از این روش برای تنظیم DM با برنامه تماس استفاده کنید. برای افزودن برنامه تماس به عنوان عضوی از یک فضا یا یک DM موجود بین دو کاربر انسانی، به دعوت کردن یا افزودن یک کاربر یا برنامه به یک فضا مراجعه کنید.

اگر یک DM از قبل بین دو کاربر وجود داشته باشد، حتی زمانی که یک کاربر در زمان درخواست، دیگری را مسدود کند، DM موجود برگردانده می شود.

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

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

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

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

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

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

به روز رسانی عضویت

rpc UpdateMembership( UpdateMembershipRequest ) returns ( Membership )

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

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

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

    • https://www.googleapis.com/auth/chat.app.memberships (فقط در فضاهایی که برنامه ایجاد کرده است)

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

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

به یکی از حوزه های 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

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

UpdateMessage

rpc UpdateMessage( UpdateMessageRequest ) returns ( Message )

یک پیام را به روز می کند. بین روش های patch و update تفاوت وجود دارد. متد patch از یک درخواست patch استفاده می کند در حالی که روش update از یک درخواست put استفاده می کند. توصیه می کنیم از روش patch استفاده کنید. برای مثال، به‌روزرسانی یک پیام را ببینید.

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

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

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

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

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

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

محدوده مجوز

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

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

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

UpdateSpace

rpc UpdateSpace( UpdateSpaceRequest ) returns ( Space )

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

اگر فیلد 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 (فقط فضاهای حالت واردات)
    • احراز هویت کاربر هنگامی که یک حساب سرپرست احراز هویت می‌شود، use_admin_access true است و از حوزه‌های مجوز زیر استفاده می‌شود، امتیازات سرپرست اعطا می‌شود:
      • https://www.googleapis.com/auth/chat.admin.spaces

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

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

به یکی از حوزه های 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

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

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting( UpdateSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

تنظیمات اعلان فضایی را به روز می کند. برای مثال، به‌روزرسانی تنظیمات اعلان فضای تماس‌گیرنده را ببینید.

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

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

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

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

وضعیت خواندن کاربر را در یک فضا به روز می کند، که برای شناسایی پیام های خوانده شده و خوانده نشده استفاده می شود. برای مثال، به‌روزرسانی وضعیت خواندن فضای کاربر را ببینید.

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

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

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

  • https://www.googleapis.com/auth/chat.users.readstate

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

ابزارک لوازم جانبی

یک یا چند ویجت تعاملی که در پایین یک پیام ظاهر می شود. برای جزئیات، به افزودن ویجت‌های تعاملی در پایین پیام رجوع کنید.

فیلدها
action میدانی اتحادیه نوع عمل. action فقط می تواند یکی از موارد زیر باشد:
button_list

ButtonList

لیستی از دکمه ها

ActionResponse

پارامترهایی که یک برنامه چت می تواند برای پیکربندی نحوه ارسال پاسخ خود استفاده کند.

فیلدها
type

ResponseType

فقط ورودی نوع پاسخ برنامه چت.

url

string

فقط ورودی URL برای احراز هویت یا پیکربندی کاربران. (فقط برای انواع پاسخ REQUEST_CONFIG .)

dialog_action

DialogAction

فقط ورودی پاسخی به یک رویداد تعاملی مربوط به یک گفتگو . باید با ResponseType.Dialog همراه باشد.

updated_widget

UpdatedWidget

فقط ورودی پاسخ ویجت به روز شده.

نوع پاسخ

نوع پاسخ برنامه چت.

Enums
TYPE_UNSPECIFIED نوع پیش‌فرض که به‌عنوان NEW_MESSAGE استفاده می‌شود.
NEW_MESSAGE به عنوان یک پیام جدید در تاپیک ارسال کنید.
UPDATE_MESSAGE پیام برنامه چت را به روز کنید. این فقط در رویداد CARD_CLICKED که نوع فرستنده پیام BOT است مجاز است.
UPDATE_USER_MESSAGE_CARDS کارت ها را در پیام کاربر به روز کنید. این فقط به عنوان پاسخی به یک رویداد MESSAGE با نشانی اینترنتی منطبق، یا یک رویداد CARD_CLICKED که نوع فرستنده پیام HUMAN است مجاز است. متن نادیده گرفته می شود.
REQUEST_CONFIG به طور خصوصی از کاربر برای احراز هویت یا پیکربندی اضافی بخواهید.
DIALOG دیالوگی ارائه می دهد.
UPDATE_WIDGET پرس و جو گزینه های تکمیل خودکار متن ویجت.

انتخاب آیتم ها

فهرست نتایج تکمیل خودکار ویجت.

فیلدها
items[]

SelectionItem

آرایه ای از اشیاء SelectionItem.

ویجت به روز شده

برای ویجت‌های selectionInput ، پیشنهادات تکمیل خودکار را برای یک منوی چند انتخابی برمی‌گرداند.

فیلدها
widget

string

شناسه ویجت به روز شده. شناسه باید با شناسه ویجتی که درخواست به‌روزرسانی را راه‌اندازی کرده، مطابقت داشته باشد.

فیلد اتحادیه updated_widget . ویجت در پاسخ به اقدام کاربر به روز شد. updated_widget فقط می تواند یکی از موارد زیر باشد:
suggestions

SelectionItems

فهرست نتایج تکمیل خودکار ویجت

ActionStatus

وضعیت درخواست برای فراخوانی یا ارسال گفتگو را نشان می دهد.

فیلدها
status_code

Code

کد وضعیت.

user_facing_message

string

پیامی برای ارسال به کاربران در مورد وضعیت درخواست آنها. اگر تنظیم نشود، یک پیام عمومی بر اساس status_code ارسال می شود.

حاشیه نویسی

فقط خروجی حاشیه‌نویسی‌ها را می‌توان با متن ساده پیام یا تراشه‌هایی مرتبط کرد که به منابع Google Workspace مانند Google Docs یا Sheets با start_index و length 0 پیوند دارند. برای افزودن قالب‌بندی اولیه به پیام نوشتاری، به قالب‌بندی پیام‌های متنی مراجعه کنید.

مثال متن پیام ساده:

Hello @FooBot how are you!"

فراداده حاشیه نویسی مربوطه:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
فیلدها
type

AnnotationType

نوع این حاشیه نویسی

length

int32

طول رشته فرعی در متن پیام متنی ساده با این حاشیه نویسی مطابقت دارد. اگر وجود نداشته باشد، طول 0 را نشان می دهد.

start_index

int32

نمایه شروع (بر اساس 0، شامل) در متن پیام متنی ساده که این حاشیه نویسی با آن مطابقت دارد.

metadata میدان اتحادیه فراداده اضافی در مورد حاشیه نویسی. metadata تنها می تواند یکی از موارد زیر باشد:
user_mention

UserMentionMetadata

فراداده ذکر کاربر.

slash_command

SlashCommandMetadata

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

custom_emoji_metadata

CustomEmojiMetadata

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

AnnotationType

نوع حاشیه نویسی

Enums
ANNOTATION_TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
USER_MENTION یک کاربر ذکر شده است.
SLASH_COMMAND یک دستور اسلش فراخوانی می شود.
CUSTOM_EMOJI حاشیه نویسی ایموجی سفارشی.

AppCommandMetadata

فراداده درباره دستور برنامه Chat .

فیلدها
app_command_id

int32

شناسه فرمان مشخص شده در پیکربندی Chat API.

app_command_type

AppCommandType

نوع دستور برنامه چت.

AppCommandType

نوع دستور برنامه چت. برای جزئیات، به انواع دستورات برنامه چت مراجعه کنید.

Enums
APP_COMMAND_TYPE_UNSPECIFIED مقدار پیش فرض نامشخص
SLASH_COMMAND یک دستور اسلش کاربر دستور را در یک پیام چت ارسال می کند.
QUICK_COMMAND یک دستور سریع کاربر دستور را از منوی چت در ناحیه پاسخ پیام انتخاب می کند.

گیف پیوست شده

یک تصویر GIF که توسط یک URL مشخص شده است.

فیلدها
uri

string

فقط خروجی URL که میزبان تصویر GIF است.

پیوست

یک پیوست در Google Chat.

فیلدها
name

string

اختیاری. نام منبع پیوست، به شکل spaces/{space}/messages/{message}/attachments/{attachment} .

content_name

string

فقط خروجی نام فایل اصلی برای محتوا، نه مسیر کامل.

content_type

string

فقط خروجی نوع محتوا (نوع MIME) فایل.

thumbnail_uri

string

فقط خروجی نشانی اینترنتی تصویر کوچکی که باید برای پیش نمایش پیوست یک کاربر انسانی استفاده شود. برنامه‌های گپ نباید از این نشانی اینترنتی برای دانلود محتوای پیوست استفاده کنند.

download_uri

string

فقط خروجی URL دانلودی که باید از آن استفاده شود تا کاربر انسانی بتواند پیوست را دانلود کند. برنامه‌های گپ نباید از این نشانی اینترنتی برای دانلود محتوای پیوست استفاده کنند.

source

Source

فقط خروجی منبع پیوست

فیلد اتحادیه data_ref . ارجاع داده به پیوست data_ref تنها می تواند یکی از موارد زیر باشد:
attachment_data_ref

AttachmentDataRef

اختیاری. ارجاع به داده های پیوست این فیلد برای ایجاد یا به‌روزرسانی پیام‌ها با پیوست‌ها یا با API رسانه برای دانلود داده‌های پیوست استفاده می‌شود.

drive_data_ref

DriveDataRef

فقط خروجی ارجاع به پیوست Google Drive. این فیلد با Google Drive API استفاده می شود.

منبع

منبع پیوست

Enums
SOURCE_UNSPECIFIED رزرو شده است.
DRIVE_FILE فایل یک فایل گوگل درایو است.
UPLOADED_CONTENT فایل در چت آپلود می شود.

AttachmentDataRef

ارجاع به داده های پیوست

فیلدها
resource_name

string

اختیاری. نام منبع داده های پیوست. این فیلد با API رسانه برای دانلود داده های پیوست استفاده می شود.

attachment_upload_token

string

اختیاری. نشانه مات حاوی ارجاع به پیوست آپلود شده. توسط کلاینت‌ها به‌عنوان یک رشته غیرشفاف تلقی می‌شود و برای ایجاد یا به‌روزرسانی پیام‌های چت با پیوست‌ها استفاده می‌شود.

CalendarEventLinkData

داده برای پیوندهای رویداد تقویم.

فیلدها
calendar_id

string

شناسه تقویم تقویم پیوند شده.

event_id

string

The Event identifier of the linked Calendar event.

CardWithId

A card in a Google Chat message.

Only Chat apps can create cards. If your Chat app authenticates as a user , the message can't contain cards.

Design and preview cards with the Card Builder.