Package google.chat.v1

شاخص

سرویس چت

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

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

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

محدوده مجوز

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

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

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

ایجاد عضویت

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

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

برای تعیین عضوی که باید اضافه شود، membership.member.name را برای عضو انسانی یا برنامه تنظیم کنید، یا membership.group_member.name را برای عضو گروه تنظیم کنید.

  • برای افزودن برنامه تماس به یک فاصله یا پیام مستقیم بین دو کاربر انسانی، از users/app استفاده کنید. نمی‌توان برنامه‌های دیگر را به فضا اضافه کرد.

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

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

محدوده مجوز

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

  • 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 ایجاد می کند. حداکثر اندازه پیام، شامل متن و کارت، 32000 بایت است. برای مثال، به ارسال پیام مراجعه کنید.

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

  • برای پیام های متنی، احراز هویت کاربر یا تأیید اعتبار برنامه پشتیبانی می شود.
  • برای پیام های کارت، فقط احراز هویت برنامه پشتیبانی می شود. (فقط برنامه‌های چت می‌توانند پیام‌های کارت ایجاد کنند.)
محدوده مجوز

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

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

محدوده مجوز

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

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

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

حذف عضویت

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

  • 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 )

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

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

محدوده مجوز

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

واکنش به یک پیام را حذف می کند. فقط ایموجی های یونیکد پشتیبانی می شوند. برای مثال، حذف واکنش را ببینید. نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

محدوده مجوز

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

  • 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 رسانه واکشی می‌شوند. برای مثال، به دریافت فراداده درباره پیوست پیام مراجعه کنید. به احراز هویت برنامه نیاز دارد.

محدوده مجوز

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

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

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

GetMembership

rpc GetMembership( GetMembershipRequest ) returns ( Membership )

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

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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 )

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

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

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

محدوده مجوز

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

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

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

GetSpace

rpc GetSpace( GetSpaceRequest ) returns ( Space )

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

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

محدوده مجوز

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

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

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

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

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

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

محدوده مجوز

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

  • 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

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

GetSpaceReadState

rpc GetSpaceReadState( GetSpaceReadStateRequest ) returns ( SpaceReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

GetThreadReadState

rpc GetThreadReadState( GetThreadReadStateRequest ) returns ( ThreadReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

لیست اعضا

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse )

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

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

محدوده مجوز

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

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

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

ListMessages

rpc ListMessages( ListMessagesRequest ) returns ( ListMessagesResponse )

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

محدوده مجوز

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

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

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

ListReactions

rpc ListReactions( ListReactionsRequest ) returns ( ListReactionsResponse )

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

محدوده مجوز

به یکی از حوزه های 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 خالی است.

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

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

محدوده مجوز

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

  • 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 تنظیم کنید.

محدوده مجوز

به یکی از حوزه های 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 برای user@example.com 123456789 باشد، می‌توانید با تنظیم membership.member.name به users/user@example.com یا users/123456789 کاربر را به فضا اضافه کنید.

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

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

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

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

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

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

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

rpc UpdateMembership( UpdateMembershipRequest ) returns ( Membership )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

  • 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 استفاده کنید. برای مثال، به‌روزرسانی یک پیام را ببینید.

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

محدوده مجوز

به یکی از حوزه های 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 قبلاً از این نام نمایشی استفاده کند.

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

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

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

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

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

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

نیاز به احراز هویت کاربر دارد.

محدوده مجوز

به محدوده 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.

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

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

فیلدها
widget

string

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

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

SelectionItems

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

ActionStatus

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

فیلدها
status_code

Code

کد وضعیت.

user_facing_message

string

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

حاشیه نویسی

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

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

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

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

start_index

int32

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

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

UserMentionMetadata

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

slash_command

SlashCommandMetadata

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

AnnotationType

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

Enums
ANNOTATION_TYPE_UNSPECIFIED مقدار پیش فرض برای enum. استفاده نکنید.
USER_MENTION یک کاربر ذکر شده است.
SLASH_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

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

CardWithId

کارتی در پیام چت Google.

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

طراحی و پیش نمایش کارت ها با Card Builder.

کارت ساز را باز کنید

فیلدها
card_id

string

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

card

Card

یک کارت حداکثر حجم 32 کیلوبایت است.

ChatSpaceLinkData

داده برای پیوندهای فضای چت.

فیلدها
space

string

فضای منبع فضای چت پیوند شده.

قالب: spaces/{space}

thread

string

رشته منبع فضای چت پیوند شده.

قالب: spaces/{space}/threads/{thread}

message

string

پیام منبع فضای چت پیوند شده.

قالب: spaces/{space}/messages/{message}

CompleteImportSpaceRequest

درخواست پیام برای تکمیل فرآیند واردات برای یک فضا.

فیلدها
name

string

مورد نیاز. نام منبع فضای حالت واردات.

قالب: spaces/{space}

CompleteImportSpaceResponse

پیام پاسخ برای تکمیل فرآیند واردات برای یک فضا.

فیلدها
space

Space

فضای حالت واردات.

ContextualAddOnMarkup

این نوع هیچ فیلدی ندارد.

نشانه گذاری برای توسعه دهندگان برای تعیین محتوای یک AddOn متنی.

کارت

کارت یک عنصر رابط کاربری است که می تواند حاوی ویجت های رابط کاربری مانند متن و تصویر باشد.

فیلدها
header

CardHeader

هدر کارت. یک هدر معمولاً حاوی یک عنوان و یک تصویر است.

sections[]

Section

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

card_actions[]

CardAction

اقدامات این کارت.

name

string

نام کارت.

CardAction

اکشن کارت، عمل مرتبط با کارت است. برای یک کارت فاکتور، یک اقدام معمولی این است: حذف فاکتور، فاکتور ایمیل یا باز کردن فاکتور در مرورگر.

توسط برنامه‌های چت Google پشتیبانی نمی‌شود.

فیلدها
action_label

string

برچسب قبلاً در آیتم منوی عمل نمایش داده می شد.

on_click

OnClick

عمل onclick برای این مورد اقدام.

سربرگ کارت

فیلدها
title

string

عنوان باید مشخص شود. هدر دارای ارتفاع ثابتی است: اگر عنوان و عنوان فرعی هر دو مشخص شده باشد، هر کدام یک خط را اشغال می کنند. اگر فقط عنوان مشخص شده باشد، هر دو خط را می گیرد.

subtitle

string

زیرنویس هدر کارت.

image_style

ImageStyle

نوع تصویر (به عنوان مثال، حاشیه مربع یا حاشیه دایره ای).

image_url

string

URL تصویر در هدر کارت.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE حاشیه مربع.
AVATAR حاشیه دایره ای

بخش

یک بخش شامل مجموعه ای از ویجت ها است که به ترتیبی که مشخص شده اند (به صورت عمودی) ارائه می شوند. در همه پلتفرم‌ها، کارت‌ها دارای عرض ثابت باریکی هستند، بنابراین در حال حاضر نیازی به ویژگی‌های طرح‌بندی (مثلاً شناور) نیست.

فیلدها
header

string

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

widgets[]

WidgetMarkup

یک بخش باید حداقل دارای یک ویجت باشد.

ایجاد درخواست عضویت

درخواست پیام برای ایجاد عضویت.

فیلدها
parent

string

مورد نیاز. نام منبع فضایی که برای آن عضویت ایجاد می شود.

قالب: spaces/{space}

membership

Membership

مورد نیاز. رابطه عضویت برای ایجاد. فیلد memberType باید دارای کاربری با فیلدهای user.name و user.type باشد. سرور یک نام منبع اختصاص می دهد و هر چیزی را که مشخص شده است، بازنویسی می کند. وقتی یک برنامه Chat یک رابطه عضویت برای یک کاربر انسانی ایجاد می‌کند، باید از محدوده chat.memberships استفاده کند، user.type را روی HUMAN تنظیم کند و user.name با قالب users/{user} تنظیم کند، جایی که {user} می‌تواند ایمیل باشد. آدرس برای کاربر برای کاربران در همان سازمان Workspace {user} همچنین می‌تواند id شخص از People API یا id کاربر در Directory API باشد. برای مثال، اگر شناسه نمایه افراد API People برای user@example.com 123456789 باشد، می‌توانید با تنظیم membership.member.name به users/user@example.com یا users/123456789 کاربر را به فضا اضافه کنید. وقتی یک برنامه Chat برای خود یک رابطه عضویت ایجاد می‌کند، باید از محدوده chat.memberships.app استفاده کند، user.type را روی BOT تنظیم کند و user.name روی users/app تنظیم کند.

use_admin_access

bool

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

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

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

ایجاد عضویت در برنامه یا ایجاد عضویت برای کاربران خارج از سازمان Google Workspace سرپرست با استفاده از دسترسی سرپرست پشتیبانی نمی‌شود.

CreateMessageRequest

پیامی ایجاد می کند.

فیلدها
parent

string

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

قالب: spaces/{space}

message

Message

مورد نیاز. بدنه پیام

thread_key
(deprecated)

string

اختیاری. منسوخ شده: به جای آن از thread.thread_key استفاده کنید. شناسه تاپیک پشتیبانی از حداکثر 4000 کاراکتر برای شروع یا اضافه کردن به یک رشته، یک پیام ایجاد کنید و یک threadKey یا thread.name را مشخص کنید. برای مثال استفاده، شروع یا پاسخ دادن به رشته پیام را ببینید.

request_id

string

اختیاری. یک شناسه درخواست منحصر به فرد برای این پیام. تعیین شناسه درخواست موجود، پیام ایجاد شده با آن شناسه را به جای ایجاد یک پیام جدید برمی گرداند.

message_reply_option

MessageReplyOption

اختیاری. مشخص می کند که آیا یک پیام یک رشته را شروع می کند یا به یکی پاسخ می دهد. فقط در فضاهای نامگذاری شده پشتیبانی می شود.

message_id

string

اختیاری. یک شناسه سفارشی برای یک پیام. به برنامه‌های گپ اجازه می‌دهد بدون نیاز به ذخیره شناسه اختصاص داده شده به سیستم در نام منبع پیام (که در قسمت name پیام نشان داده شده است) پیامی را دریافت، به‌روزرسانی یا حذف کنند.

مقدار این فیلد باید شرایط زیر را داشته باشد:

  • با client- شروع می شود- . برای مثال، client-custom-name یک شناسه سفارشی معتبر است، اما custom-name نیست.
  • دارای حداکثر 63 کاراکتر و فقط حروف کوچک، اعداد و خط فاصله است.
  • در یک فضا منحصر به فرد است. برنامه چت نمی‌تواند از یک شناسه سفارشی برای پیام‌های مختلف استفاده کند.

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

MessageReplyOption

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

Enums
MESSAGE_REPLY_OPTION_UNSPECIFIED پیش فرض یک تاپیک جدید راه اندازی می کند. با استفاده از این گزینه، thread ID یا thread_key موجود در آن نادیده گرفته می‌شود.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD پیام را به عنوان پاسخی به رشته ای که توسط thread ID یا thread_key مشخص شده است ایجاد می کند. اگر شکست بخورد، پیام به جای آن یک رشته جدید شروع می کند.
REPLY_MESSAGE_OR_FAIL پیام را به عنوان پاسخی به رشته ای که توسط thread ID یا thread_key مشخص شده است ایجاد می کند. اگر یک thread_key جدید استفاده شود، یک رشته جدید ایجاد می شود. اگر ایجاد پیام ناموفق باشد، به جای آن یک خطای NOT_FOUND برگردانده می شود.

CreateReactionRequest

واکنشی به پیام ایجاد می کند.

فیلدها
parent

string

مورد نیاز. پیامی که در آن واکنش ایجاد می شود.

قالب: spaces/{space}/messages/{message}

reaction

Reaction

مورد نیاز. واکنش به ایجاد.

CreateSpaceRequest

درخواستی برای ایجاد فضایی با نام.

فیلدها
space

Space

مورد نیاز. فیلدهای displayName و spaceType باید پر شوند. فقط SpaceType.SPACE پشتیبانی می شود.

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

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

request_id

string

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

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

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

فیلدها
uid

string

فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی.

DeleteMembership Request

درخواست حذف عضویت در یک فضا.

فیلدها
name

string

مورد نیاز. نام منبع عضویت برای حذف. برنامه های چت می توانند عضویت کاربران انسانی یا خود آنها را حذف کنند. برنامه‌های چت نمی‌توانند عضویت برنامه‌های دیگر را حذف کنند.

هنگام حذف عضویت انسانی، به قالب chat.memberships و spaces/{space}/members/{member} نیاز است. می توانید از ایمیل به عنوان نام مستعار برای {member} استفاده کنید. برای مثال، spaces/{space}/members/example@gmail.com که در آن example@gmail.com ایمیل کاربر گپ Google است.

هنگام حذف عضویت برنامه، به محدوده و spaces/{space}/members/app chat.memberships.app و قالب‌های/{space}/members/app نیاز است.

قالب: spaces/{space}/members/{member} یا spaces/{space}/members/app .

use_admin_access

bool

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

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

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

حذف عضویت برنامه در یک فضا با استفاده از دسترسی سرپرست پشتیبانی نمی‌شود.

DeleteMessageRequest

درخواست حذف پیام

فیلدها
name

string

مورد نیاز. نام منبع پیام

قالب: spaces/{space}/messages/{message}

اگر یک شناسه سفارشی برای پیام خود تنظیم کرده‌اید، می‌توانید از مقدار فیلد clientAssignedMessageId برای {message} استفاده کنید. برای جزئیات، به نام پیام مراجعه کنید.

force

bool

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

فقط هنگام احراز هویت به عنوان کاربر اعمال می شود. هنگام احراز هویت به عنوان یک برنامه چت تأثیری ندارد.

DeleteReactionRequest

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

فیلدها
name

string

مورد نیاز. نام واکنش برای حذف.

قالب: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpaceRequest

درخواست حذف فاصله

فیلدها
name

string

مورد نیاز. نام منبع فضایی که باید حذف شود.

قالب: spaces/{space}

use_admin_access

bool

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

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به دامنه chat.admin.delete oauth 2.0 نیاز دارد.

حذف metadata

اطلاعات مربوط به یک پیام حذف شده. هنگام تنظیم delete_time یک پیام حذف می شود.

فیلدها
deletion_type

DeletionType

نشان می دهد چه کسی پیام را حذف کرده است.

حذف

چه کسی پیام را حذف کرد و چگونه حذف شد.

نماد
DELETION_TYPE_UNSPECIFIED این مقدار بلااستفاده است.
CREATOR کاربر پیام خود را حذف کرد.
SPACE_OWNER صاحب فضا پیام را حذف کرد.
ADMIN یک مدیر فضای کاری Google پیام را حذف کرد.
APP_MESSAGE_EXPIRY یک برنامه گپ هنگام انقضا ، پیام خود را حذف کرد.
CREATOR_VIA_APP یک برنامه چت پیام را از طرف کاربر حذف کرد.
SPACE_OWNER_VIA_APP یک برنامه چت پیام را به نمایندگی از صاحب فضا حذف کرد.

گفتگو

بسته بندی اطراف بدنه دیالوگ.

فیلدها
body

Card

فقط ورودی بدنه گفتگو ، که در یک معین ارائه می شود. برنامه های گپ Google از موجودات کارت زیر پشتیبانی نمی کنند: DateTimePicker ، OnChangeAction .

گفتگو

حاوی یک گفتگوی و کد وضعیت درخواست است.

فیلدها
action_status

ActionStatus

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

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

Dialog

فقط ورودی گفتگو برای درخواست.

Driendataref

اشاره به داده های پیوست درایو.

فیلدها
drive_file_id

string

شناسه پرونده درایو. با API درایو استفاده کنید.

دیلینکستاتا

داده ها برای پیوندهای Google Drive.

فیلدها
drive_data_ref

DriveDataRef

یک Driredataref که به یک پرونده Google Drive اشاره می کند.

mime_type

string

نوع MIME منبع Google Drive Linked.

ایموجی

ایموجی که به عنوان واکنشی به یک پیام استفاده می شود.

فیلدها
content میدان اتحادیه. محتوای ایموجی ها. content می تواند تنها یکی از موارد زیر باشد:
unicode

string

یک ایموجی اساسی که توسط یک رشته یونیکد نشان داده شده است.

custom_emoji

CustomEmoji

فقط خروجی یک ایموجی سفارشی.

emojirectionsummary

تعداد افرادی که با یک ایموجی خاص به پیام واکنش نشان دادند.

فیلدها
emoji

Emoji

ایموجی های مرتبط با واکنش.

reaction_count

int32

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

FindDirectMessageRequest

درخواستی برای دریافت فضای پیام مستقیم بر اساس منبع کاربر.

فیلدها
name

string

مورد نیاز. نام منبع کاربر برای یافتن پیام مستقیم با.

قالب: users/{user} ، که در آن {user} یا id شخص از افراد API افراد است ، یا id کاربر در API دایرکتوری. به عنوان مثال ، اگر شناسه پروفایل API People 123456789 باشد ، می توانید با استفاده از users/123456789 به عنوان name ، یک پیام مستقیم با آن شخص پیدا کنید. هنگامی که به عنوان کاربر تأیید می شود ، می توانید از ایمیل به عنوان نام مستعار برای {user} استفاده کنید. به عنوان مثال ، users/example@gmail.com که در آن example@gmail.com ایمیل کاربر Google Chat است.

GetAttachmentRequest

درخواست دریافت پیوست.

فیلدها
name

string

مورد نیاز. نام منبع ضمیمه ، در spaces/{space}/messages/{message}/attachments/{attachment} .

GetMembershipRequest

درخواست عضویت در یک فضا.

فیلدها
name

string

مورد نیاز. نام منابع عضویت برای بازیابی.

برای به دست آوردن عضویت خود برنامه با استفاده از تأیید اعتبار کاربر ، می توانید به صورت اختیاری از spaces/{space}/members/app استفاده کنید.

قالب: spaces/{space}/members/{member} یا spaces/{space}/members/app

هنگامی که به عنوان کاربر تأیید می شود ، می توانید از ایمیل کاربر به عنوان نام مستعار برای {member} استفاده کنید. به عنوان مثال ، spaces/{space}/members/example@gmail.com که در آن example@gmail.com ایمیل کاربر گپ Google است.

use_admin_access

bool

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

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

نیاز به chat.admin.memberships یا chat.admin.memberships.readonly oauth 2.0 Scopes دارد.

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

GetMessageRequest

درخواست دریافت پیام

فیلدها
name

string

مورد نیاز. نام منبع پیام.

قالب: spaces/{space}/messages/{message}

اگر یک شناسه سفارشی را برای پیام خود تنظیم کرده اید ، می توانید از قسمت clientAssignedMessageId برای {message} استفاده کنید. برای جزئیات بیشتر ، به یک پیام مراجعه کنید.

getSpaceEventRequest

برای دریافت یک رویداد فضایی پیام را درخواست کنید.

فیلدها
name

string

مورد نیاز. نام منابع رویداد فضایی.

قالب: spaces/{space}/spaceEvents/{spaceEvent}

getSpacereadStaterequest

درخواست پیام برای API GetSpacereadState.

فیلدها
name

string

مورد نیاز. نام منابع از حالت خوانده شده برای بازیابی.

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

برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:

  • me نام مستعار به عنوان مثال ، users/me/spaces/{space}/spaceReadState .

  • آدرس ایمیل فضای کاری آنها. به عنوان مثال ، users/user@example.com/spaces/{space}/spaceReadState }/spacereadstate.

  • شناسه کاربر آنها به عنوان مثال ، users/123456789/spaces/{space}/spaceReadState .

قالب: کاربران/{کاربر}/فضاها/{فضا}/SpacereadState

GetSpaceRequest

درخواست بازگشت یک فضای واحد.

فیلدها
name

string

مورد نیاز. نام منبع فضا ، در spaces/{space} .

قالب: spaces/{space}

use_admin_access

bool

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

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به Scopes chat.admin.spaces یا chat.admin.spaces.readonly oauth 2.0 نیاز دارد.

GetThreadReadStateRequest

پیام درخواست GetThreadReadStateRequest API.

فیلدها
name

string

مورد نیاز. نام منبع موضوع موضوع را برای بازیابی.

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

برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید:

  • me نام مستعار به عنوان مثال ، users/me/spaces/{space}/threads/{thread}/threadReadState .

  • آدرس ایمیل فضای کاری آنها. به عنوان مثال ، users/user@example.com/spaces/{space}/threads/{thread}/threadReadState }/ThreadReadState.

  • شناسه کاربر آنها به عنوان مثال ، users/123456789/spaces/{space}/threads/{thread}/threadReadState .

فرمت: کاربران/{کاربر}/فضاها/{فضا}/موضوع/{موضوع}/ThreadReadState

گروه

یک گروه Google در Google Chat.

فیلدها
name

string

نام منابع برای یک گروه Google.

گروهی در گروه های هویت ابری API را نشان می دهد.

قالب: گروه ها/{گروه}

تاریخچه

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

نماد
HISTORY_STATE_UNSPECIFIED مقدار پیش فرض استفاده نکنید.
HISTORY_OFF تاریخ خاموش. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند .
HISTORY_ON تاریخ در. قوانین حفظ طاق سازمان مشخص می کند که چه مدت پیام ها و موضوعات نگه داشته می شوند.

ListMembershipsRequest

درخواست پیام برای لیست عضویت.

فیلدها
parent

string

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

قالب: فضاها/{فضا}

page_size

int32

اختیاری. حداکثر تعداد عضویت برای بازگشت. این سرویس ممکن است کمتر از این مقدار برگردد.

در صورت نامشخص ، حداکثر 100 عضویت بازگردانده می شوند.

حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

page_token

string

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

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو.

شما می توانید عضویت در نقش ( role ) و نوع ( member.type ) عضویت را فیلتر کنید.

برای فیلتر کردن بر اساس نقش ، role در ROLE_MEMBER یا ROLE_MANAGER تنظیم کنید.

برای فیلتر کردن بر اساس نوع ، member.type را به HUMAN یا BOT تنظیم کنید. پیش نمایش توسعه دهنده: شما همچنین می توانید با استفاده از اپراتور != member.type فیلتر کنید.

برای فیلتر کردن توسط هر دو نقش و نوع ، از اپراتور AND اپراتور استفاده کنید. برای فیلتر کردن توسط هر دو نقش یا نوع ، از اپراتور OR استفاده کنید.

هر دو member.type = "HUMAN" یا member.type != "BOT" لازم است وقتی use_admin_access روی درست تنظیم شود. سایر فیلترهای نوع عضو رد می شوند.

به عنوان مثال ، نمایش داده های زیر معتبر است:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

نمایش داده های زیر نامعتبر است:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

show_groups

bool

اختیاری. در صورت true ، علاوه بر سایر انواع عضویت ، عضویت های مرتبط با یک Google Group را نیز برمی گرداند. اگر filter تنظیم شود ، عضویت Google Group که با معیارهای فیلتر مطابقت ندارند ، بازگردانده نمی شوند.

show_invited

bool

اختیاری. هنگامی که true ، علاوه بر سایر انواع عضویت ، عضویت در ارتباط با اعضای invited را نیز برمی گرداند. اگر فیلتر تنظیم شود ، عضویت های invited که با معیارهای فیلتر مطابقت ندارند ، بازگردانده نمی شوند.

در حال حاضر به تأیید اعتبار کاربر نیاز دارد.

use_admin_access

bool

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

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

به chat.admin.memberships.readonly یا chat.admin.memberships oauth 2.0 نیاز دارد.

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

listmembershipsresponse

پاسخ به لیست عضویت در فضا.

فیلدها
memberships[]

Membership

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

next_page_token

string

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

ListMessagesRequest

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

فیلدها
parent

string

مورد نیاز. نام منبع فضا برای لیست پیام ها از.

قالب: spaces/{space}

page_size

int32

حداکثر تعداد پیام های برگشت یافته. این سرویس ممکن است پیام های کمتری از این مقدار بازگرداند.

در صورت نامشخص ، حداکثر 25 نفر بازگردانده می شوند.

حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

page_token

string

اختیاری ، در صورت از سرگیری از یک پرس و جو قبلی.

یک صفحه صفحه دریافت شده از تماس پیام های لیست قبلی. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.

filter

string

یک فیلتر پرس و جو.

می توانید پیام ها را بر اساس تاریخ ( create_time ) و Thread ( thread.name ) فیلتر کنید.

برای فیلتر کردن پیام ها در تاریخ ایجاد شده ، create_time با یک Timestamp در قالب RFC-3339 و علائم دو برابر مشخص کنید. به عنوان مثال ، "2023-04-21T11:30:00-04:00" . برای لیست پیام هایی که پس از یک زمان بندی ایجاد شده اند یا کمتر از اپراتور < برای لیست پیام هایی که قبل از یک زمان بندی ایجاد شده اند ، می توانید از اپراتور > بیشتر از اپراتور استفاده کنید. برای فیلتر کردن پیام ها در یک بازه زمانی ، از AND اپراتور بین دو جدول زمانی استفاده کنید.

برای فیلتر کردن بر روی نخ ، thread.name را مشخص کنید ، به عنوان spaces/{space}/threads/{thread} . فقط می توانید یک thread.name در هر پرس و جو مشخص کنید.

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

به عنوان مثال ، نمایش داده های زیر معتبر است:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

order_by

string

اختیاری ، در صورت از سرگیری از یک پرس و جو قبلی.

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

  • ASC برای صعود.

  • DESC برای نزول

سفارش پیش فرض create_time ASC است.

show_deleted

bool

آیا پیام های حذف شده را شامل می شود. پیام های حذف شده شامل زمان حذف شده و ابرداده در مورد حذف آنها هستند ، اما محتوای پیام در دسترس نیست.

ListMessagesResponse

پیام پاسخ برای لیست پیام ها.

فیلدها
messages[]

Message

لیست پیام ها

next_page_token

string

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

ListReactionsRequest

واکنش های یک پیام را لیست می کند.

فیلدها
parent

string

مورد نیاز. کاربران پیام به آنها واکنش نشان دادند.

قالب: spaces/{space}/messages/{message}

page_size

int32

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

page_token

string

اختیاری. (در صورت از سرگیری از یک پرس و جو قبلی.)

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

هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو.

می توانید واکنش های emoji ( emoji.unicode یا emoji.custom_emoji.uid ) و کاربر ( user.name ) را فیلتر کنید.

برای فیلتر کردن واکنش برای چندین ایموجی یا کاربران ، به قسمتهای مشابه با اپراتور OR بپیوندید ، مانند emoji.unicode = "🙂" OR emoji.unicode = "👍" و user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" .

برای فیلتر کردن واکنش توسط ایموجی و کاربر ، از اپراتور AND اپراتور مانند emoji.unicode = "🙂" AND user.name = "users/AAAAAA" استفاده کنید.

اگر پرس و جو شما از هر AND و OR گروه بندی آنها را با پرانتز استفاده می کند.

به عنوان مثال ، نمایش داده های زیر معتبر است:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

نمایش داده های زیر نامعتبر است:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

ListReactionsResponse

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

فیلدها
reactions[]

Reaction

لیست واکنش ها در صفحه درخواست شده (یا اول).

next_page_token

string

نشانه ادامه برای بازیابی صفحه بعدی نتایج. برای آخرین صفحه نتایج خالی است.

ListSpaceEventsRequest

درخواست پیام برای لیست رویدادهای فضایی.

فیلدها
parent

string

مورد نیاز. نام منبع فضای چت Google که در آن وقایع رخ داده است.

قالب: spaces/{space} .

page_size

int32

اختیاری. حداکثر تعداد وقایع فضایی برگشت. این سرویس ممکن است کمتر از این مقدار برگردد.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

page_token

string

یک صفحه صفحه ، که از لیست قبلی رویدادهای فضایی دریافت شده است. این کار را برای بازیابی صفحه بعدی ارائه دهید.

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده برای لیست رویدادهای فضایی باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.

filter

string

مورد نیاز. یک فیلتر پرس و جو.

شما باید حداقل یک نوع رویداد ( event_type ) را با استفاده از : اپراتور مشخص کنید. برای فیلتر کردن توسط انواع مختلف رویداد ، از اپراتور OR استفاده کنید. انواع رویداد دسته ای را در فیلتر خود حذف کنید. درخواست به طور خودکار هر رویداد دسته ای مربوطه را برمی گرداند. به عنوان مثال ، اگر با واکنش های جدید فیلتر کنید ( google.workspace.chat.reaction.v1.created ) ، سرور همچنین رویدادهای واکنش های جدید را برمی گرداند ( google.workspace.chat.reaction.v1.batchCreated ). برای لیستی از انواع رویداد پشتیبانی شده ، به مستندات مرجع SpaceEvents مراجعه کنید.

به صورت اختیاری ، می توانید با زمان شروع ( start_time ) و زمان پایان ( end_time ) فیلتر کنید:

  • start_time : جدول زمانی منحصر به فرد برای شروع لیست رویدادهای فضایی. می توانید رویدادهایی را که تا 28 روز پیش رخ داده است لیست کنید. اگر نامشخص باشد ، رویدادهای فضایی را از 28 روز گذشته لیست می کند.
  • end_time : Timestamp فراگیر تا زمانی که رویدادهای فضایی ذکر شده اند. اگر نامشخص باشد ، رویدادها را تا زمان درخواست لیست می کند.

برای مشخص کردن زمان شروع یا پایان ، از Equals = Operator و Format در RFC-3339 استفاده کنید. برای فیلتر کردن توسط start_time و end_time ، از اپراتور AND اپراتور استفاده کنید.

به عنوان مثال ، نمایش داده های زیر معتبر است:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

نمایش داده های زیر نامعتبر است:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

ListSpaceEventsResponse

پیام پاسخ برای لیست رویدادهای فضایی.

فیلدها
space_events[]

SpaceEvent

نتایج به ترتیب زمانی بازگردانده می شوند (قدیمی ترین رویداد اول).

next_page_token

string

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

ListSpacesRequest

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

فیلدها
page_size

int32

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

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

حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی گرداند.

page_token

string

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

هنگام پیگیری ، مقدار فیلتر باید با تماس ارائه شده با صفحه مطابقت داشته باشد. عبور از یک مقدار متفاوت ممکن است منجر به نتایج غیر منتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو.

می توانید فضاها را بر اساس نوع فضایی ( space_type ) فیلتر کنید.

برای فیلتر کردن بر اساس نوع فضایی ، باید مقدار معتبر Enum مانند SPACE یا GROUP_CHAT را مشخص کنید ( space_type نمی تواند SPACE_TYPE_UNSPECIFIED باشد). برای پرس و جو برای انواع مختلف فضایی ، از اپراتور OR استفاده کنید.

به عنوان مثال ، نمایش داده های زیر معتبر است:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

نمایش داده شدگان نامعتبر توسط سرور با یک خطای INVALID_ARGUMENT رد می شوند.

لیست

پاسخ درخواست فضاهای لیست.

فیلدها
spaces[]

Space

لیست فضاهای موجود در صفحه درخواست شده (یا اول).

next_page_token

string

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

کابوس

یک URL همسان در یک پیام گپ. برنامه های چت می توانند URL های همسان را پیش نمایش کنند. برای اطلاعات بیشتر ، به پیوندهای پیش نمایش مراجعه کنید.

فیلدها
url

string

فقط خروجی URL که مطابقت داشت.

عضویت

یک رابطه عضویت در Google Chat را نشان می دهد ، مانند اینکه کاربر یا برنامه چت به بخشی از آن دعوت شده است ، یا از یک فضا غایب است.

فیلدها
name

string

نام منابع عضویت ، اختصاص داده شده توسط سرور.

قالب: spaces/{space}/members/{member}

state

MembershipState

فقط خروجی وضعیت عضویت.

role

MembershipRole

اختیاری. نقش کاربر در یک فضای گپ ، که اقدامات مجاز آنها را در فضا تعیین می کند.

این قسمت فقط می تواند به عنوان ورودی در UpdateMembership استفاده شود.

create_time

Timestamp

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

delete_time

Timestamp

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

عضو اتحادیه memberType . عضو مرتبط با این عضویت. انواع دیگر اعضا ممکن است در آینده پشتیبانی شوند. memberType می تواند تنها یکی از موارد زیر باشد:
member

User

کاربر یا برنامه Google CHAT که عضویت دارد با آن مطابقت دارد. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی name و type کاربر را جمع می کند.

group_member

Group

گروه Google عضویت با آن مطابقت دارد.

عضو

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

نماد
MEMBERSHIP_ROLE_UNSPECIFIED مقدار پیش فرض برای users : آنها عضو فضا نیستند ، اما می توان از آنها دعوت شد. برای Google Groups : آنها همیشه این نقش را اختصاص داده اند (مقادیر دیگر در آینده ممکن است در آینده استفاده شود).
ROLE_MEMBER عضو فضا کاربر مجوزهای اساسی دارد ، مانند ارسال پیام به فضا. در مکالمات گروهی 1: 1 و نامشخص ، همه این نقش را دارند.
ROLE_MANAGER یک مدیر فضایی کاربر دارای تمام مجوزهای اساسی به علاوه مجوزهای اداری است که به آنها اجازه می دهد فضا را مانند اضافه کردن یا حذف اعضا مدیریت کنند. فقط در SpaceType.SPACE پشتیبانی می شود.

عضو کشور

رابطه عضو با یک فضا را مشخص می کند. سایر کشورهای عضویت ممکن است در آینده پشتیبانی شوند.

نماد
MEMBERSHIP_STATE_UNSPECIFIED مقدار پیش فرض استفاده نکنید.
JOINED کاربر به فضا اضافه می شود و می تواند در فضا شرکت کند.
INVITED از کاربر دعوت شده است تا به فضا بپیوندد ، اما به آن پیوسته است.
NOT_A_MEMBER کاربر متعلق به فضا نیست و دعوت در انتظار برای پیوستن به فضا ندارد.

عضویت batchcreatedeventdata

بارگذاری رویداد برای چندین عضویت جدید.

نوع رویداد: google.workspace.chat.membership.v1.batchCreated

فیلدها
memberships[]

MembershipCreatedEventData

لیستی از عضویت های جدید.

عضویت batchdeletedeventdata

بارگذاری رویداد برای چندین عضویت حذف شده.

نوع رویداد: google.workspace.chat.membership.v1.batchDeleted

فیلدها
memberships[]

MembershipDeletedEventData

لیستی از عضویت های حذف شده.

عضویت batchupdatedeventdata

بارگذاری رویداد برای چندین عضویت به روز شده.

نوع رویداد: google.workspace.chat.membership.v1.batchUpdated

فیلدها
memberships[]

MembershipUpdatedEventData

لیستی از عضویت به روز شده.

عضویت

بارگیری رویداد برای عضویت جدید.

نوع رویداد: google.workspace.chat.membership.v1.created .

فیلدها
membership

Membership

عضویت جدید

عضویت deletedeventdata

بارگذاری رویداد برای عضویت حذف شده.

نوع رویداد: google.workspace.chat.membership.v1.deleted

فیلدها
membership

Membership

عضویت حذف شده. فقط name و زمینه های state جمع شده اند.

عضویت

بارگیری رویداد برای عضویت به روز شده.

نوع رویداد: google.workspace.chat.membership.v1.updated

فیلدها
membership

Membership

عضویت به روز شده

پیام

پیامی در فضای گپ گوگل.

فیلدها
name

string

نام منبع پیام.

قالب: spaces/{space}/messages/{message}

جایی که {space} شناسه فضایی است که پیام در آن ارسال شده است و {message} یک شناسه تعیین شده توسط سیستم برای پیام است. به عنوان مثال ، spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB .

اگر هنگام ایجاد پیام ، شناسه سفارشی را تنظیم کنید ، می توانید با جایگزینی {message} با مقدار از قسمت clientAssignedMessageId ، از این شناسه استفاده کنید. به عنوان مثال ، spaces/AAAAAAAAAAA/messages/client-custom-name . برای جزئیات بیشتر ، به یک پیام مراجعه کنید.

sender

User

فقط خروجی کاربر که پیام را ایجاد کرده است. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی name و type کاربر را جمع می کند.

create_time

Timestamp

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

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

last_update_time

Timestamp

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

delete_time

Timestamp

فقط خروجی زمان حذف پیام در Google Chat. اگر پیام هرگز حذف نشود ، این قسمت خالی است.

text

string

متن ساده پیام از پیام. اولین لینک به یک تصویر ، فیلم یا صفحه وب تراشه پیش نمایش را ایجاد می کند. همچنین می توانید Mention یک کاربر Google Chat یا همه افراد موجود در فضا.

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

formatted_text

string

فقط خروجی حاوی text پیام با نشانه گذاری های اضافه شده به قالب بندی ارتباط است. این زمینه ممکن است تمام قالب بندی های قابل مشاهده در UI را ضبط نکند ، اما موارد زیر را شامل می شود:

  • علامت گذاری به عنوان Syntax برای جسورانه ، ایتالیایی ، Strikethrough ، Monospace ، Monospace Block و لیست گلوله.

  • کاربر با استفاده از قالب <users/{user}> ذکر می کند.

  • لینک های سفارشی با استفاده از فرمت <{url}|{rendered_text}> که در آن رشته اول URL است و دوم متن ارائه شده - برای مثال ، <http://example.com|custom text> .

  • emoji سفارشی با استفاده از قالب :{emoji_name}: برای مثال ، :smile: این در مورد ایموجی های یونیکد ، مانند U+1F600 برای ایموجی صورت پوزخند صدق نمی کند.

برای اطلاعات بیشتر ، به مشاهده قالب بندی متن ارسال شده در یک پیام مراجعه کنید

cards[]
(deprecated)

Card

deprecated: به جای آن از cards_v2 استفاده کنید.

کارتهای غنی ، فرمت شده و تعاملی که می توانید برای نمایش عناصر UI مانند: متون فرمت ، دکمه ها و تصاویر قابل کلیک استفاده کنید. کارتها به طور معمول در زیر بدنه متن ساده پیام نمایش داده می شوند. cards و cards_v2 می توانند حداکثر اندازه 32 کیلوبایت داشته باشند.

cards_v2[]

CardWithId

مجموعه ای از کارت ها .

فقط برنامه های چت می توانند کارت ایجاد کنند. اگر برنامه چت شما به عنوان کاربر تأیید می شود ، پیام ها نمی توانند حاوی کارت باشند.

برای کسب اطلاعات در مورد کارت ها و نحوه ایجاد آنها ، به پیام های ارسال کارت مراجعه کنید.

کارت های طراحی و پیش نمایش با سازنده کارت.

سازنده کارت را باز کنید

annotations[]

Annotation

فقط خروجی حاشیه نویسی های مرتبط با text در این پیام.

thread

Thread

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

space

Space

اگر برنامه چت شما به عنوان کاربر تأیید می شود ، خروجی name فضایی را جمع می کند.

fallback_text

string

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

action_response

ActionResponse

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

argument_text

string

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

slash_command

SlashCommand

فقط خروجی در صورت وجود اطلاعات فرمان Slash.

attachment[]

Attachment

ضمیمه کاربر بارگیری شده.

matched_url

MatchedUrl

فقط خروجی URL در spaces.messages.text که با یک الگوی پیش نمایش پیوند مطابقت دارد. برای اطلاعات بیشتر ، به پیوندهای پیش نمایش مراجعه کنید.

thread_reply

bool

فقط خروجی هنگامی که true ، پیام در یک موضوع پاسخ پاسخی است. هنگامی که false ، پیام در مکالمه سطح بالای فضا به عنوان اولین پیام یک موضوع یا پیام بدون پاسخ موضوعی قابل مشاهده است.

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

client_assigned_message_id

string

اختیاری. شناسه سفارشی برای پیام. می توانید از فیلد برای شناسایی یک پیام استفاده کنید ، یا برای دریافت ، حذف یا به روزرسانی پیام استفاده کنید. برای تنظیم شناسه سفارشی ، هنگام ایجاد پیام ، قسمت messageId را مشخص کنید. برای جزئیات بیشتر ، به یک پیام مراجعه کنید.

emoji_reaction_summaries[]

EmojiReactionSummary

فقط خروجی لیست خلاصه واکنش ایموجی در پیام.

private_message_viewer

User

تغییر ناپذیر ورودی برای ایجاد پیام ، در غیر این صورت فقط خروجی. کاربر که می تواند پیام را مشاهده کند. هنگام تنظیم ، پیام خصوصی است و فقط برای کاربر مشخص شده و برنامه چت قابل مشاهده است. پیش نمایش ها و پیوست های پیوند برای پیام های خصوصی پشتیبانی نمی شوند.

فقط برنامه های چت می توانند پیام های خصوصی ارسال کنند. اگر برنامه چت شما به عنوان کاربر برای ارسال پیام تأیید می شود ، پیام نمی تواند خصوصی باشد و باید این قسمت را حذف کند.

برای جزئیات بیشتر ، به ارسال پیام های خصوصی به کاربران Google Chat مراجعه کنید.

deletion_metadata

DeletionMetadata

فقط خروجی اطلاعات مربوط به یک پیام حذف شده. هنگام تنظیم delete_time یک پیام حذف می شود.

quoted_message_metadata

QuotedMessageMetadata

فقط خروجی اطلاعات مربوط به پیامی که توسط یک کاربر Google Chat در یک فضا نقل شده است. کاربران Google CHAT می توانند برای پاسخ به آن پیامی را نقل کنند.

attached_gifs[]

AttachedGif

فقط خروجی تصاویر GIF که به پیام پیوست شده اند.

accessory_widgets[]

AccessoryWidget

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

ایجاد پیام با ابزارک های لوازم جانبی نیاز به تأیید اعتبار برنامه دارد.

پیام batchcreatedeventdata

بارگذاری رویداد برای چندین پیام جدید.

نوع رویداد: google.workspace.chat.message.v1.batchCreated

فیلدها
messages[]

MessageCreatedEventData

لیستی از پیام های جدید

پیام batchdeletedeventdata

بار رویداد برای چندین پیام حذف شده.

نوع رویداد: google.workspace.chat.message.v1.batchDeleted

فیلدها
messages[]

MessageDeletedEventData

لیستی از پیام های حذف شده.

پیام batchupdatedeventdata

بارگذاری رویداد برای چندین پیام به روز شده.

نوع رویداد: google.workspace.chat.message.v1.batchUpdated

فیلدها
messages[]

MessageUpdatedEventData

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

adgecreatedeventdata

بارگیری رویداد برای یک پیام جدید.

نوع رویداد: google.workspace.chat.message.v1.created

فیلدها
message

Message

پیام جدید

sessagedeletedeventdata

بارگیری رویداد برای یک پیام حذف شده.

نوع رویداد: google.workspace.chat.message.v1.deleted

فیلدها
message

Message

پیام حذف شده فقط زمینه های name ، createTime ، deleteTime و deletionMetadata جمع شده اند.

messageupdatedeventdata

بارگیری رویداد برای یک پیام به روز شده.

نوع رویداد: google.workspace.chat.message.v1.updated

فیلدها
message

Message

پیام به روز شده

به نقل از messagemetadata

اطلاعات مربوط به یک پیام نقل شده.

فیلدها
name

string

فقط خروجی نام منبع پیام نقل شده.

قالب: spaces/{space}/messages/{message}

last_update_time

Timestamp

فقط خروجی زمانی که پیام نقل شده ایجاد شد یا آخرین پیام نقل شده به روز شد.

واکنش

واکنشی به یک پیام.

فیلدها
name

string

نام منبع واکنش.

قالب: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

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

emoji

Emoji

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

واکنش

بار رویداد برای چندین واکنش جدید.

نوع رویداد: google.workspace.chat.reaction.v1.batchCreated

فیلدها
reactions[]

ReactionCreatedEventData

لیستی از واکنشهای جدید.

واکنش

بار رویداد برای چندین واکنش حذف شده.

نوع رویداد: google.workspace.chat.reaction.v1.batchDeleted

فیلدها
reactions[]

ReactionDeletedEventData

لیستی از واکنشهای حذف شده.

واکنش نشان داد

بارگذاری رویداد برای یک واکنش جدید.

نوع رویداد: google.workspace.chat.reaction.v1.created

فیلدها
reaction

Reaction

واکنش جدید

واکنشدهم

بارگذاری رویداد برای یک واکنش حذف شده.

نوع: google.workspace.chat.reaction.v1.deleted

فیلدها
reaction

Reaction

واکنش حذف شده

ریچلینکمتاداتا

پیوند غنی به یک منبع.

فیلدها
uri

string

URI این لینک.

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

نوع غنی

نوع لینک غنی. انواع بیشتری ممکن است در آینده اضافه شود.

نماد
DRIVE_FILE یک نوع پیوند غنی از Google Drive.
CHAT_SPACE یک نوع پیوند غنی از فضای چت. به عنوان مثال ، یک تراشه هوشمند فضایی.

SearchSpacesRequest

درخواست برای جستجوی لیستی از فضاها بر اساس یک پرس و جو کنید.

فیلدها
use_admin_access

bool

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

کاربر فراخوانی باید یک مدیر فضای کاری Google با امتیازات مدیریت چت و فضاها باشد.

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

این روش در حال حاضر فقط از دسترسی سرپرست پشتیبانی می کند ، بنابراین true برای این زمینه پذیرفته می شود.

page_size

int32

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

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

حداکثر مقدار 1000 است. اگر از مقدار بیش از 1000 استفاده می کنید ، به طور خودکار به 1000 تغییر می یابد.

page_token

string

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

هنگام پیگیری ، تمام پارامترهای دیگر ارائه شده باید با تماس ارائه شده با صفحه نمایش مطابقت داشته باشند. انتقال مقادیر مختلف به پارامترهای دیگر ممکن است منجر به نتایج غیر منتظره شود.

query

string

مورد نیاز. یک پرس و جو جستجو

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

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time و last_active_time یک جدول زمانی را در قالب RFC-3339 قبول کنید و اپراتورهای مقایسه پشتیبانی شده عبارتند از: = ، < ، > ، <= ، >= .

customer مورد نیاز است و برای نشان دادن مشتری برای واکشی از فضاها استفاده می شود. customers/my_customer تنها ارزش پشتیبانی شده است.

display_name فقط اپراتور HAS ( : را می پذیرد. متن برای مطابقت برای اولین بار در نشانه ها نشانه گذاری می شود و هر نشانه به طور نامحدود و مستقل به عنوان یک بستر در هر نقطه از display_name فضا مطابقت دارد. به عنوان مثال ، Fun Eve با Fun event مطابقت دارد یا The evening was fun ، اما نه notFun event یا even .

external_user_allowed یا true یا false را می پذیرد.

space_history_state فقط مقادیر را از قسمت historyState یک منبع space می پذیرد.

space_type مورد نیاز است و تنها مقدار معتبر SPACE است.

در زمینه های مختلف ، فقط AND اپراتورها پشتیبانی می شوند. یک مثال معتبر space_type = "SPACE" AND display_name:"Hello" و یک مثال نامعتبر space_type = "SPACE" OR display_name:"Hello" .

در میان همان زمینه ، space_type AND OR پشتیبانی نمی کند. display_name ، "Space_History_State" و "External_User_owlayed" فقط پشتیبانی OR اپراتورها. last_active_time و create_time از هر دو AND و OR اپراتورها پشتیبانی می کنند. AND فقط می تواند برای نشان دادن فاصله ای مانند last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" استفاده شود.

نمایشگاه های مثال زیر معتبر هستند:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

اختیاری. نحوه سفارش لیست فضاها.

ویژگی های پشتیبانی شده برای سفارش توسط:

  • membership_count.joined_direct_human_user_count - تعداد کاربران انسانی را که مستقیماً به یک فضا پیوسته اند ، نشان می دهد.
  • last_active_time - زمان اضافه شدن آخرین مورد واجد شرایط به هر موضوع این فضا را نشان می دهد.
  • create_time - زمان ایجاد فضا را نشان می دهد.

مقادیر عملیاتی سفارش معتبر عبارتند از:

  • ASC برای صعود. مقدار پیش فرض

  • DESC برای نزول

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

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

پاسخ با لیستی از فضاهای مربوط به درخواست فضاهای جستجو.

فیلدها
spaces[]

Space

صفحه ای از فضاهای درخواست شده.

next_page_token

string

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

total_size

int32

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

SetUpSpaceRequest

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

فیلدها
space

Space

مورد نیاز. قسمت Space.spaceType مورد نیاز است.

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

برای ایجاد یک گپ گروهی ، Space.spaceType را به GROUP_CHAT تنظیم کنید. Space.displayName را تنظیم نکنید.

برای ایجاد یک مکالمه 1: 1 بین انسان ، Space.spaceType را به DIRECT_MESSAGE تنظیم کنید و Space.singleUserBotDm تنظیم کنید. SingleUserBotDM به false . Space.displayName یا Space.spaceDetails را تنظیم نکنید.

برای ایجاد یک مکالمه 1: 1 بین یک برنامه چت انسان و فراخوان ، Space.spaceType true به DIRECT_MESSAGE و Space.singleUserBotDm تنظیم کنید. Space.displayName یا Space.spaceDetails را تنظیم نکنید.

If a DIRECT_MESSAGE space already exists, that space is returned instead of creating a new space.

request_id

string

اختیاری. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

memberships[]

Membership

اختیاری. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically.

The set currently allows up to 20 memberships (in addition to the caller).

For human membership, the Membership.member field must contain a user with name populated (format: users/{user} ) and type set to User.Type.HUMAN . You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the user.name can be users/example@gmail.com . To invite Gmail users or users from external Google Workspace domains, user's email must be used for {user} .

For Google group membership, the Membership.group_member field must contain a group with name populated (format groups/{group} ). You can only add Google groups when setting Space.spaceType to SPACE .

Optional when setting Space.spaceType to SPACE .

Required when setting Space.spaceType to GROUP_CHAT , along with at least two memberships.

Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true ).

SlashCommand

A slash command in Google Chat.

فیلدها
command_id

int64

The ID of the slash command invoked.

SlashCommandMetadata

Annotation metadata for slash commands (/).

فیلدها
bot

User

The Chat app whose command was invoked.

type

Type

The type of slash command.

command_name

string

The name of the invoked slash command.

command_id

int64

The command ID of the invoked slash command.

triggers_dialog

bool

Indicates whether the slash command is for a dialog.

تایپ کنید

Enums
TYPE_UNSPECIFIED Default value for the enum. استفاده نکنید.
ADD Add Chat app to space.
INVOKE Invoke slash command in space.

فضا

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

فیلدها
name

string

Resource name of the space.

Format: spaces/{space}

type
(deprecated)

Type

Output only. Deprecated: Use space_type instead. The type of a space.

space_type

SpaceType

The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.

single_user_bot_dm

bool

اختیاری. Whether the space is a DM between a Chat app and a single human.

threaded
(deprecated)

bool

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

display_name

string

The space's display name. Required when creating a space . If you receive the error message ALREADY_EXISTS when creating a space or updating the displayName , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

For direct messages, this field might be empty.

Supports up to 128 characters.

external_user_allowed

bool

Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:

  • The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

For existing spaces, this field is output only.

space_threading_state

SpaceThreadingState

Output only. The threading state in the Chat space.

space_details

SpaceDetails

Details about the space including description and rules.

space_history_state

HistoryState

The message history state for messages and threads in this space.

import_mode

bool

اختیاری. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.

create_time

Timestamp

اختیاری. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

Only populated in the output when spaceType is GROUP_CHAT or SPACE .

last_active_time

Timestamp

Output only. Timestamp of the last message in the space.

admin_installed

bool

Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.

To support admin install, your Chat app must feature direct messaging.

membership_count

MembershipCount

Output only. The count of joined memberships grouped by member type. Populated when the space_type is SPACE , DIRECT_MESSAGE or GROUP_CHAT .

access_settings

AccessSettings

اختیاری. Specifies the access setting of the space. Only populated when the space_type is SPACE .

space_uri

string

Output only. The URI for a user to access the space.

Union field space_permission_settings . Represents the permission settings of a space. Only populated when the space_type is SPACE . space_permission_settings can be only one of the following:
predefined_permission_settings

PredefinedPermissionSettings

اختیاری. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the PermissionSettings field.

permission_settings

PermissionSettings

اختیاری. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, use predefined_permission_settings instead.

AccessSettings

Represents the access setting of the space.

فیلدها
access_state

AccessState

Output only. Indicates the access state of the space.

audience

string

اختیاری. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience .

Format: audiences/{audience}

To use the default target audience for the Google Workspace organization, set to audiences/default .

AccessState

Represents the access state of the space.

Enums
ACCESS_STATE_UNSPECIFIED Access state is unknown or not supported in this API.
PRIVATE Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.
DISCOVERABLE A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users .

MembershipCount

Represents the count of memberships of a space, grouped into categories.

فیلدها
joined_direct_human_user_count

int32

Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.

joined_group_count

int32

Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

فیلدها
managers_allowed

bool

Whether spaces managers have this permission.

members_allowed

bool

Whether non-manager members have this permission.

PermissionSettings

Permission settings for a named space. To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

فیلدها
manage_members_and_groups

PermissionSetting

Setting for managing members and groups in a space.

modify_space_details

PermissionSetting

Setting for updating space name, avatar, description and guidelines.

toggle_history

PermissionSetting

Setting for toggling space history on and off.

use_at_mention_all

PermissionSetting

Setting for using @all in a space.

manage_apps

PermissionSetting

Setting for managing apps in a space.

manage_webhooks

PermissionSetting

Setting for managing webhooks in a space.

post_messages

PermissionSetting

Output only. Setting for posting messages in a space.

reply_messages

PermissionSetting

Setting for replying to messages in a space.

PredefinedPermissionSettings

The space permission settings that you can specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces .

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED نامشخص استفاده نکنید.
COLLABORATION_SPACE Setting to make the space a collaboration space where all members can post messages.
ANNOUNCEMENT_SPACE Setting to make the space an announcement space where only space managers can post messages.

SpaceDetails

Details about the space including description and rules.

فیلدها
description

string

اختیاری. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

guidelines

string

اختیاری. The space's rules, expectations, and etiquette.

Supports up to 5,000 characters.

SpaceThreadingState

Specifies the type of threading state in the Chat space.

Enums
SPACE_THREADING_STATE_UNSPECIFIED رزرو شده است.
THREADED_MESSAGES Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.
GROUPED_MESSAGES Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.
UNTHREADED_MESSAGES Direct messages (DMs) between two people and group conversations between 3 or more people.

SpaceType

The type of space. Required when creating or updating a space. Output only for other usage.

Enums
SPACE_TYPE_UNSPECIFIED رزرو شده است.
SPACE A place where people send messages, share files, and collaborate. A SPACE can include Chat apps.
GROUP_CHAT Group conversations between 3 or more people. A GROUP_CHAT can include Chat apps.
DIRECT_MESSAGE 1:1 messages between two humans or a human and a Chat app.

تایپ کنید

Deprecated: Use SpaceType instead.

Enums
TYPE_UNSPECIFIED رزرو شده است.
ROOM Conversations between two or more humans.
DM 1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

فیلدها
spaces[]

SpaceUpdatedEventData

A list of updated spaces.

رویداد فضایی

An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat .

فیلدها
name

string

Resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

event_time

Timestamp

Time when the event occurred.

event_type

string

Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For spaceEvents.list() requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version.

Supported event types for messages :

  • New message: google.workspace.chat.message.v1.created
  • Updated message: google.workspace.chat.message.v1.updated
  • Deleted message: google.workspace.chat.message.v1.deleted
  • Multiple new messages: google.workspace.chat.message.v1.batchCreated
  • Multiple updated messages: google.workspace.chat.message.v1.batchUpdated
  • Multiple deleted messages: google.workspace.chat.message.v1.batchDeleted

Supported event types for memberships :

  • New membership: google.workspace.chat.membership.v1.created
  • Updated membership: google.workspace.chat.membership.v1.updated
  • Deleted membership: google.workspace.chat.membership.v1.deleted
  • Multiple new memberships: google.workspace.chat.membership.v1.batchCreated
  • Multiple updated memberships: google.workspace.chat.membership.v1.batchUpdated
  • Multiple deleted memberships: google.workspace.chat.membership.v1.batchDeleted

Supported event types for reactions :

  • New reaction: google.workspace.chat.reaction.v1.created
  • Deleted reaction: google.workspace.chat.reaction.v1.deleted
  • Multiple new reactions: google.workspace.chat.reaction.v1.batchCreated
  • Multiple deleted reactions: google.workspace.chat.reaction.v1.batchDeleted

Supported event types about the space :

  • Updated space: google.workspace.chat.space.v1.updated
  • Multiple space updates: google.workspace.chat.space.v1.batchUpdated

Union field payload .

payload can be only one of the following:

message_created_event_data

MessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

message_updated_event_data

MessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

message_deleted_event_data

MessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

message_batch_created_event_data

MessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

message_batch_updated_event_data

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

message_batch_deleted_event_data

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

space_updated_event_data

SpaceUpdatedEventData

Event payload for a space update.

Event type: google.workspace.chat.space.v1.updated

space_batch_updated_event_data

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

membership_created_event_data

MembershipCreatedEventData

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created

membership_updated_event_data

MembershipUpdatedEventData

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

membership_deleted_event_data

MembershipDeletedEventData

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

membership_batch_created_event_data

MembershipBatchCreatedEventData

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

reaction_created_event_data

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

reaction_deleted_event_data

ReactionDeletedEventData

Event payload for a deleted reaction.

Event type: google.workspace.chat.reaction.v1.deleted

reaction_batch_created_event_data

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

فیلدها
name

string

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

last_read_time

Timestamp

اختیاری. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.

SpaceUpdatedEventData

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

فیلدها
space

Space

The updated space.

موضوع

A thread in a Google Chat space. For example usage, see Start or reply to a message thread .

If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found.

فیلدها
name

string

Resource name of the thread.

Example: spaces/{space}/threads/{thread}

thread_key

string

اختیاری. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread name field instead.

ThreadReadState

A user's read state within a thread, used to identify read and unread messages.

فیلدها
name

string

Resource name of the thread read state.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_read_time

Timestamp

The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.

UpdateMembership Request

Request message for updating a membership.

فیلدها
membership

Membership

مورد نیاز. The membership to update. Only fields specified by update_mask are updated.

update_mask

FieldMask

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

  • role
use_admin_access

bool

When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

UpdateMessageRequest

Request to update a message.

فیلدها
message

Message

مورد نیاز. Message with fields updated.

update_mask

FieldMask

مورد نیاز. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

allow_missing

bool

اختیاری. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

فیلدها
space_read_state

SpaceReadState

مورد نیاز. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

  • The me alias. For example, users/me/spaces/{space}/spaceReadState .

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState .

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState .

Format: users/{user}/spaces/{space}/spaceReadState

update_mask

FieldMask

مورد نیاز. The field paths to update. Currently supported field paths:

  • last_read_time

When the last_read_time is before the latest message create time, the space appears as unread in the UI.

To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.

UpdateSpaceRequest

A request to update a single space.

فیلدها
space

Space

مورد نیاز. Space with fields to be updated. Space.name must be populated in the form of spaces/{space} . Only fields specified by update_mask are updated.

update_mask

FieldMask

مورد نیاز. The updated field paths, comma separated if there are multiple.

You can update the following fields for a space:

  • space_details

  • display_name : Only supports updating the display name for spaces where spaceType field is SPACE . If you receive the error message ALREADY_EXISTS , try a different value. An existing space within the Google Workspace organization might already use this display name.

  • space_type : Only supports changing a GROUP_CHAT space type to SPACE . Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with admin access.

  • space_history_state : Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with admin access.

  • access_settings.audience : Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE . If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode . To learn more, see Make a space discoverable to specific users . access_settings.audience is not supported with admin access.

  • Developer Preview: Supports changing the permission settings of a space, supported field paths include: permission_settings.manage_members_and_groups , permission_settings.modify_space_details , permission_settings.toggle_history , permission_settings.use_at_mention_all , permission_settings.manage_apps , permission_settings.manage_webhooks , permission_settings.reply_messages (Warning: mutually exclusive with all other non-permission settings field paths). permission_settings is not supported with admin access.

use_admin_access

bool

When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces OAuth 2.0 scope .

Some FieldMask values are not supported using admin access. For details, see the description of update_mask .

کاربر

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User resource only populates the user's name and type .

فیلدها
name

string

Resource name for a Google Chat user .

Format: users/{user} . users/app can be used as an alias for the calling app bot user.

For human users , {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789 , you can use users/user@example.com as an alias to reference users/123456789 . Only the canonical resource name (for example users/123456789 ) will be returned from the API.

display_name

string

Output only. The user's display name.

domain_id

string

Unique identifier of the user's Google Workspace domain.

type

Type

User type.

is_anonymous

bool

Output only. When true , the user is deleted or their profile is not visible.

تایپ کنید

Enums
TYPE_UNSPECIFIED Default value for the enum. استفاده نکنید.
HUMAN Human user.
BOT Chat app user.

UserMentionMetadata

Annotation metadata for user mentions (@).

فیلدها
user

User

The user mentioned.

type

Type

The type of user mention.

تایپ کنید

Enums
TYPE_UNSPECIFIED Default value for the enum. استفاده نکنید.
ADD Add user to space.
MENTION Mention user in space.

WidgetMarkup

A widget is a UI element that presents text and images.

فیلدها
buttons[]

Button

A list of buttons. Buttons is also oneof data and only one of these fields should be set.

Union field data . A WidgetMarkup can only have one of the following items. You can use multiple WidgetMarkup fields to display more items. data can be only one of the following:
text_paragraph

TextParagraph

Display a text paragraph in this widget.

image

Image

Display an image in this widget.

key_value

KeyValue

Display a key value item in this widget.

دکمه

A button. Can be a text button or an image button.

فیلدها

Union field type .

type can be only one of the following:

text_button

TextButton

A button with text and onclick action.

image_button

ImageButton

A button with image and onclick action.

FormAction

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

فیلدها
action_method_name

string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

parameters[]

ActionParameter

List of action parameters.

ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use action method = snooze() , passing the snooze type and snooze time in the list of string parameters.

فیلدها
key

string

The name of the parameter for the action script.

value

string

مقدار پارامتر.

نماد

The set of supported icons.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

تصویر

An image that's specified by a URL and can have an onclick action.

فیلدها
image_url

string

The URL of the image.

on_click

OnClick

The onclick action.

aspect_ratio

double

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

ImageButton

An image button with an onclick action.

فیلدها
on_click

OnClick

The onclick action.

name

string

The name of this image_button that's used for accessibility. Default value is provided if this name isn't specified.

Union field icons . The icon can be specified by an Icon enum or a URL. icons can be only one of the following:
icon

Icon

The icon specified by an enum that indices to an icon provided by Chat API.

icon_url

string

The icon specified by a URL.

KeyValue

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

فیلدها
top_label

string

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

content

string

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

content_multiline

bool

If the content should be multiline.

bottom_label

string

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

on_click

OnClick

The onclick action. Only the top label, bottom label, and content region are clickable.

Union field icons . At least one of icons, top_label and bottom_label must be defined. icons can be only one of the following:
icon

Icon

An enum value that's replaced by the Chat API with the corresponding icon image.

icon_url

string

The icon specified by a URL.

Union field control . A control widget. You can set either button or switch_widget , but not both. control can be only one of the following:
button

Button

A button that can be clicked to trigger an action.

OnClick

An onclick action (for example, open a link).

فیلدها

Union field data .

data can be only one of the following:

action

FormAction

A form action is triggered by this onclick action if specified.

TextButton

A button with text and onclick action.

فیلدها
text

string

The text of the button.

on_click

OnClick

The onclick action of the button.

TextParagraph

A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

فیلدها
text

string