Package google.chat.v1

شاخص

• ChatService (رابط)
• AccessoryWidget (پیام)
• ActionResponse (پیام)
• ActionResponse.ResponseType (enum)
• ActionResponse.SelectionItems (پیام)
• ActionResponse.UpdatedWidget (پیام)
• ActionStatus (پیام)
• Annotation (پیام)
• AnnotationType (enum)
• AttachedGif (پیام)
• Attachment (پیام)
• Attachment.Source (تعدادی)
• AttachmentDataRef (پیام)
• CardWithId (پیام)
• ChatSpaceLinkData (پیام)
• CompleteImportSpaceRequest (پیام)
• CompleteImportSpaceResponse (پیام)
• ContextualAddOnMarkup (پیام)
• ContextualAddOnMarkup.Card (پیام)
• ContextualAddOnMarkup.Card.CardAction (پیام)
• ContextualAddOnMarkup.Card.CardHeader (پیام)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (enum)
• ContextualAddOnMarkup.Card.Section (پیام)
• CreateCustomEmojiRequest (پیام)
• CreateMembershipRequest (پیام)
• CreateMessageRequest (پیام)
• CreateMessageRequest.MessageReplyOption (enum)
• CreateReactionRequest (پیام)
• CreateSpaceRequest (پیام)
• CustomEmoji (پیام)
• CustomEmoji.CustomEmojiPayload (پیام)
• DeleteCustomEmojiRequest (پیام)
• DeleteMembershipRequest (پیام)
• DeleteMessageRequest (پیام)
• DeleteReactionRequest (پیام)
• DeleteSpaceRequest (پیام)
• DeletionMetadata (پیام)
• DeletionMetadata.DeletionType (enum)
• Dialog (پیام)
• DialogAction (پیام)
• DriveDataRef (پیام)
• DriveLinkData (پیام)
• Emoji (پیام)
• EmojiReactionSummary (پیام)
• FindDirectMessageRequest (پیام)
• GetAttachmentRequest (پیام)
• GetCustomEmojiRequest (پیام)
• GetMembershipRequest (پیام)
• GetMessageRequest (پیام)
• GetSpaceEventRequest (پیام)
• GetSpaceNotificationSettingRequest (پیام)
• GetSpaceReadStateRequest (پیام)
• GetSpaceRequest (پیام)
• GetThreadReadStateRequest (پیام)
• Group (پیام)
• HistoryState (تعدادی)
• ListCustomEmojisRequest (پیام)
• ListCustomEmojisResponse (پیام)
• ListMembershipsRequest (پیام)
• ListMembershipsResponse (پیام)
• ListMessagesRequest (پیام)
• ListMessagesResponse (پیام)
• ListReactionsRequest (پیام)
• ListReactionsResponse (پیام)
• ListSpaceEventsRequest (پیام)
• ListSpaceEventsResponse (پیام)
• ListSpacesRequest (پیام)
• ListSpacesResponse (پیام)
• MatchedUrl (پیام)
• Membership (پیام)
• Membership.MembershipRole (تعدادی)
• Membership.MembershipState (تعدادی)
• MembershipBatchCreatedEventData (پیام)
• MembershipBatchDeletedEventData (پیام)
• MembershipBatchUpdatedEventData (پیام)
• MembershipCreatedEventData (پیام)
• MembershipDeletedEventData (پیام)
• MembershipUpdatedEventData (پیام)
• Message (پیام)
• MessageBatchCreatedEventData (پیام)
• MessageBatchDeletedEventData (پیام)
• MessageBatchUpdatedEventData (پیام)
• MessageCreatedEventData (پیام)
• MessageDeletedEventData (پیام)
• MessageUpdatedEventData (پیام)
• QuotedMessageMetadata (پیام)
• Reaction (پیام)
• ReactionBatchCreatedEventData (پیام)
• ReactionBatchDeletedEventData (پیام)
• ReactionCreatedEventData (پیام)
• ReactionDeletedEventData (پیام)
• RichLinkMetadata (پیام)
• RichLinkMetadata.RichLinkType (enum)
• SearchSpacesRequest (پیام)
• SearchSpacesResponse (پیام)
• SetUpSpaceRequest (پیام)
• SlashCommand (پیام)
• SlashCommandMetadata (پیام)
• SlashCommandMetadata.Type (enum)
• Space (پیام)
• Space.AccessSettings (پیام)
• Space.AccessSettings.AccessState (enum)
• Space.MembershipCount (پیام)
• Space.PermissionSetting (پیام)
• Space.PermissionSettings (پیام)
• Space.PredefinedPermissionSettings (enum)
• Space.SpaceDetails (پیام)
• Space.SpaceThreadingState (enum)
• Space.SpaceType (enum)
• Space.Type (enum)
• SpaceBatchUpdatedEventData (پیام)
• SpaceEvent (پیام)
• SpaceNotificationSetting (پیام)
• SpaceNotificationSetting.MuteSetting (enum)
• SpaceNotificationSetting.NotificationSetting (enum)
• SpaceReadState (پیام)
• SpaceUpdatedEventData (پیام)
• Thread (پیام)
• ThreadReadState (پیام)
• UpdateMembershipRequest (پیام)
• UpdateMessageRequest (پیام)
• UpdateSpaceNotificationSettingRequest (پیام)
• UpdateSpaceReadStateRequest (پیام)
• UpdateSpaceRequest (پیام)
• User (پیام)
• User.Type (enum)
• UserMentionMetadata (پیام)
• UserMentionMetadata.Type (enum)
• WidgetMarkup (پیام)
• WidgetMarkup.Button (پیام)
• WidgetMarkup.FormAction (پیام)
• WidgetMarkup.FormAction.ActionParameter (پیام)
• WidgetMarkup.Icon (enum)
• WidgetMarkup.Image (پیام)
• WidgetMarkup.ImageButton (پیام)
• WidgetMarkup.KeyValue (پیام)
• WidgetMarkup.OnClick (پیام)
• WidgetMarkup.OpenLink (پیام)
• WidgetMarkup.TextButton (پیام)
• WidgetMarkup.TextParagraph (پیام)

سرویس چت

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

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse ) فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند. به احراز هویت برنامه و تفویض اختیار در سطح دامنه نیاز دارد. برای اطلاعات بیشتر، به مجوز برنامه‌های گپ Google برای وارد کردن داده‌ها مراجعه کنید. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.import برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

CreateCustomEmoji

rpc CreateCustomEmoji( CreateCustomEmojiRequest ) returns ( CustomEmoji ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. یک ایموجی سفارشی ایجاد می کند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.customemojis برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

ایجاد عضویت

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership ) یک عضویت برای برنامه چت تماس گیرنده، یک کاربر یا یک گروه Google ایجاد می کند. ایجاد عضویت برای سایر برنامه‌های گپ پشتیبانی نمی‌شود. هنگام ایجاد عضویت، اگر خط‌مشی پذیرش خودکار عضو مشخص‌شده خاموش باشد، دعوت می‌شود و باید قبل از پیوستن، دعوت فضایی را بپذیرد. در غیر این صورت، ایجاد عضویت، عضو را مستقیماً به فضای مشخص شده اضافه می کند. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. برای مثال استفاده، نگاه کنید به: یک کاربر را به یک فضا دعوت یا اضافه کنید . یک گروه Google را به یک فضا دعوت یا اضافه کنید . برنامه چت را به یک فضا اضافه کنید . محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

ایجاد پیام

rpc CreateMessage( CreateMessageRequest ) returns ( Message ) پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید. متد create() به احراز هویت کاربر یا تأیید اعتبار برنامه نیاز دارد. Chat بسته به نوع احراز هویتی که در درخواست خود استفاده می کنید، فرستنده پیام را متفاوت نسبت می دهد. تصویر زیر نشان می دهد که چگونه Chat هنگام استفاده از احراز هویت برنامه، پیامی را نسبت می دهد. Chat برنامه چت را به عنوان فرستنده پیام نمایش می دهد. محتوای پیام می‌تواند شامل متن ( text )، کارت‌ها ( cardsV2 ) و ابزارک‌های جانبی ( accessoryWidgets ) باشد. تصویر زیر نشان می‌دهد که چگونه Chat هنگام استفاده از احراز هویت کاربر، یک پیام را مشخص می‌کند. Chat کاربر را به عنوان فرستنده پیام نمایش می دهد و برنامه Chat را با نمایش نام پیام به آن نسبت می دهد. محتوای پیام فقط می تواند حاوی متن ( text ) باشد. حداکثر اندازه پیام، با احتساب محتوای پیام، 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 ) فضایی بدون عضو ایجاد می کند. می توان از آن برای ایجاد یک فضای نامگذاری شده یا یک چت گروهی در Import mode استفاده کرد. برای مثال، ایجاد فاصله را ببینید. اگر هنگام ایجاد یک فاصله، پیام خطای ALREADY_EXISTS را دریافت کردید، یک displayName دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر هنگام احراز هویت به عنوان یک برنامه، قسمت space.customer باید در درخواست تنظیم شود. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

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

rpc DeleteCustomEmoji( DeleteCustomEmojiRequest ) returns ( Empty ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. یک ایموجی سفارشی را حذف می کند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.customemojis برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

حذف عضویت

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership ) عضویت را حذف می کند. برای مثال، به حذف یک کاربر یا برنامه چت Google از یک فضا مراجعه کنید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

DeleteMessage

rpc DeleteMessage( DeleteMessageRequest ) returns ( Empty ) یک پیام را حذف می کند. برای مثال، حذف یک پیام را ببینید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر هنگام استفاده از احراز هویت برنامه، درخواست‌ها فقط می‌توانند پیام‌های ایجاد شده توسط برنامه چت را حذف کنند. محدوده مجوز به یکی از حوزه های 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 ) فضای نامگذاری شده را حذف می کند. همیشه یک حذف آبشاری انجام می دهد، به این معنی که منابع فرزند فضا - مانند پیام های ارسال شده در فضا و عضویت در فضا - نیز حذف می شوند. برای مثال، حذف یک فاصله را ببینید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.delete https://www.googleapis.com/auth/chat.admin.delete https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.delete برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

FindDirectMessage

rpc FindDirectMessage( FindDirectMessageRequest ) returns ( Space ) پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. اگر فضای پیام مستقیم پیدا نشد، خطای 404 NOT_FOUND را برمی‌گرداند. برای مثال، به یافتن یک پیام مستقیم مراجعه کنید. با احراز هویت برنامه ، فضای پیام مستقیم بین کاربر مشخص شده و برنامه چت در حال تماس را برمی‌گرداند. با احراز هویت کاربر ، فضای پیام مستقیم بین کاربر مشخص شده و کاربر احراز هویت شده را برمی گرداند. // از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

GetAttachment
rpc GetAttachment( GetAttachmentRequest ) returns ( Attachment ) فراداده یک پیوست پیام را دریافت می کند. داده‌های پیوست با استفاده از API رسانه واکشی می‌شوند. برای مثال، به دریافت فراداده درباره پیوست پیام مراجعه کنید. به احراز هویت برنامه نیاز دارد. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.bot برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

GetCustomEmoji

rpc GetCustomEmoji( GetCustomEmojiRequest ) returns ( CustomEmoji ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. جزئیات یک ایموجی سفارشی را برمی‌گرداند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

GetMembership

rpc GetMembership( GetMembershipRequest ) returns ( Membership ) جزئیات عضویت را برمی‌گرداند. برای مثال، به دریافت جزئیات درباره عضویت کاربر یا برنامه چت Google مراجعه کنید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های 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 ) جزئیات یک فضا را برمی‌گرداند. برای مثال، به دریافت جزئیات در مورد یک فضا مراجعه کنید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent ) رویدادی را از فضای گپ Google برمی‌گرداند. بارگذاری رویداد حاوی جدیدترین نسخه منبعی است که تغییر کرده است. به عنوان مثال، اگر رویدادی را درباره یک پیام جدید درخواست کنید اما پیام بعداً به‌روزرسانی شد، سرور منبع Message به‌روز شده را در بارگذاری رویداد برمی‌گرداند. توجه: فیلد permissionSettings در شی Space داده های رویداد Space برای این درخواست بازگردانده نمی شود. نیاز به احراز هویت کاربر دارد. برای دریافت یک رویداد، کاربر احراز هویت شده باید عضوی از فضا باشد. برای مثال، به دریافت جزئیات یک رویداد از فضای گپ 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 برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting( GetSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. تنظیمات وضعیت اعلان فضا را دریافت می کند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.users.spacesettings برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

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 برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

ListCustomEmojis

rpc ListCustomEmojis( ListCustomEmojisRequest ) returns ( ListCustomEmojisResponse ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. ایموجی های سفارشی قابل مشاهده برای کاربر احراز هویت شده را فهرست می کند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

لیست اعضا

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse ) عضویت ها را در یک فضا فهرست می کند. برای مثال، فهرست کاربران و برنامه‌های چت Google را در یک فضا ببینید. فهرست کردن عضویت‌ها با احراز هویت برنامه ، عضویت‌ها را در فضاهایی فهرست می‌کند که برنامه Chat به آنها دسترسی دارد، اما عضویت‌های برنامه Chat، از جمله عضویت خود را استثنا نمی‌کند. فهرست کردن عضویت‌ها با احراز هویت کاربر ، عضویت‌ها را در فضاهایی فهرست می‌کند که کاربر احراز هویت شده به آنها دسترسی دارد. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های 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 ) پیام‌ها را در فضایی فهرست می‌کند که تماس‌گیرنده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها. اگر پیام‌هایی را از یک فضای بدون پیام فهرست کنید، پاسخ یک شی خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {} است. برای مثال، فهرست پیام‌ها را ببینید. نیاز به احراز هویت کاربر دارد. محدوده مجوز به یکی از حوزه های 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 برای [e-mail] 123456789 باشد، می‌توانید با تنظیم membership.member.name به users/[e-mail] یا users/123456789 ، کاربر را به فضا اضافه کنید. برای تعیین گروه‌های Google برای افزودن، عضویت‌ها را با membership.group_member.name مناسب اضافه کنید. برای افزودن یا دعوت یک گروه Google، از groups/{group} استفاده کنید، جایی که {group} id گروه از Cloud Identity Groups API است. برای مثال، می‌توانید از API جستجوی Cloud Identity Groups برای بازیابی شناسه 123456789 برای ایمیل گروهی [e-mail] استفاده کنید، سپس می‌توانید با تنظیم 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 ) عضویت را به روز می کند. برای مثال، به‌روزرسانی عضویت کاربر در یک فضا را ببینید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

UpdateMessage

rpc UpdateMessage( UpdateMessageRequest ) returns ( Message ) یک پیام را به روز می کند. بین روش های patch و update تفاوت وجود دارد. متد patch از یک درخواست patch استفاده می کند در حالی که روش update از یک درخواست put استفاده می کند. توصیه می کنیم از روش patch استفاده کنید. برای مثال، به‌روزرسانی یک پیام را ببینید. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه احراز هویت کاربر هنگام استفاده از احراز هویت برنامه، درخواست‌ها فقط می‌توانند پیام‌های ایجاد شده توسط برنامه چت را به‌روزرسانی کنند. محدوده مجوز به یکی از حوزه های 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 قبلاً از این نام نمایشی استفاده کند. از انواع احراز هویت زیر پشتیبانی می کند: احراز هویت برنامه با تأیید سرپرست در پیش‌نمایش برنامه‌نویس احراز هویت کاربر می‌توانید با تنظیم فیلد use_admin_access در درخواست، این روش را با امتیازات سرپرست تأیید و تأیید کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting( UpdateSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting ) پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. تنظیمات وضعیت اعلان فضا را به روز می کند. نیاز به احراز هویت کاربر دارد. محدوده مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/chat.users.spacesettings برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

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 ابرداده برای یک دستور اسلش.
rich_ link_ metadata	RichLinkMetadata ابرداده برای یک پیوند غنی.

AnnotationType

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

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

گیف پیوست شده

یک تصویر 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 یک بخش باید حداقل دارای یک ویجت باشد.

CreateCustomEmojiRequest

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
custom_ emoji	CustomEmoji مورد نیاز. ایموجی سفارشی برای ایجاد.

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

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

فیلدها
parent	string مورد نیاز. نام منبع فضایی که برای آن عضویت ایجاد می شود. قالب: spaces/{space}
membership	Membership مورد نیاز. رابطه عضویت برای ایجاد. فیلد memberType باید دارای کاربری با فیلدهای user.name و user.type باشد. سرور یک نام منبع اختصاص می دهد و هر چیزی را که مشخص شده است، بازنویسی می کند. وقتی یک برنامه چت یک رابطه عضویت برای یک کاربر انسانی ایجاد می‌کند، باید از محدوده‌های مجوز خاصی استفاده کند و مقادیر خاصی را برای فیلدهای خاص تعیین کند: هنگام احراز هویت به عنوان کاربر ، محدوده مجوز chat.memberships مورد نیاز است. هنگام احراز هویت به عنوان یک برنامه ، محدوده مجوز chat.app.memberships مورد نیاز است. احراز هویت به عنوان یک برنامه در دسترس است پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. user.type را روی HUMAN تنظیم کنید و user.name با قالب users/{user} تنظیم کنید، جایی که {user} می تواند آدرس ایمیل کاربر باشد. برای کاربران در همان سازمان Workspace {user} همچنین می‌تواند id شخص از People API یا id کاربر در Directory API باشد. برای مثال، اگر شناسه نمایه افراد API People برای [e-mail] 123456789 باشد، می‌توانید با تنظیم membership.member.name به users/[e-mail] یا users/123456789 ، کاربر را به فضا اضافه کنید. دعوت از کاربران خارج از سازمان Workspace که صاحب این فضا است نیاز به احراز هویت کاربر دارد. وقتی یک برنامه چت برای خود یک رابطه عضویت ایجاد می‌کند، باید به عنوان کاربر احراز هویت شود و از محدوده 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 و SpaceType.GROUP_CHAT پشتیبانی می شوند. SpaceType.GROUP_CHAT فقط در صورتی قابل استفاده است که importMode روی true تنظیم شده باشد. اگر پیام خطای ALREADY_EXISTS را دریافت کردید، یک displayName دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند. name فضا به سرور اختصاص داده شده است، بنابراین هر چیزی که در این قسمت مشخص شده است نادیده گرفته می شود.
request_ id	string اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. تعیین شناسه درخواست موجود، به جای ایجاد فضای جدید، فضای ایجاد شده با آن شناسه را برمی گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر تأیید شده متفاوت، یک خطا برمی‌گرداند.

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

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

فیلدها
name	string شناسه. نام منبع ایموجی سفارشی که توسط سرور اختصاص داده شده است. قالب: customEmojis/{customEmoji} پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
uid	string فقط خروجی کلید منحصر به فرد برای منبع ایموجی سفارشی.
emoji_ name	string اختیاری. تغییرناپذیر. نام ارائه شده توسط کاربر برای ایموجی سفارشی، که در سازمان منحصر به فرد است. زمانی که ایموجی سفارشی ایجاد می شود، لازم است، فقط در غیر این صورت خروجی بگیرید. نام ایموجی‌ها باید با دونقطه شروع و ختم شوند، باید با حروف کوچک باشند و فقط شامل نویسه‌های الفبایی، خط فاصله و زیرخط باشند. خط فاصله و زیرخط باید برای جدا کردن کلمات استفاده شود و نمی توان آنها را پشت سر هم به کار برد. مثال: :valid-emoji-name: پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
temporary_ image_ uri	string فقط خروجی نشانی وب تصویر برای شکلک سفارشی، حداقل 10 دقیقه معتبر است. توجه داشته باشید که هنگام ایجاد ایموجی سفارشی، این در پاسخ پر نمی شود. پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
payload	CustomEmojiPayload اختیاری. فقط ورودی داده های بار. هنگام ایجاد ایموجی سفارشی لازم است. پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

CustomEmojiPayload

داده های بارگذاری برای شکلک سفارشی.

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
file_ content	bytes مورد نیاز. فقط ورودی تصویر مورد استفاده برای ایموجی سفارشی. حجم بار باید کمتر از 256 کیلوبایت باشد و ابعاد تصویر باید بین 64 تا 500 پیکسل باشد. محدودیت ها در معرض تغییر هستند.
filename	string مورد نیاز. فقط ورودی نام فایل تصویری پسوندهای فایل پشتیبانی شده: .png ، .jpg ، .gif .

DeleteCustomEmojiRequest

درخواست حذف ایموجی سفارشی.

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
name	string مورد نیاز. نام منبع ایموجی سفارشی برای حذف. قالب: customEmojis/{customEmoji} می توانید از نام emoji به عنوان نام مستعار برای {customEmoji} استفاده کنید. به عنوان مثال، customEmojis/:example-emoji: که در آن :example-emoji: نام ایموجی برای یک ایموجی سفارشی است.

DeleteMembership Request

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

فیلدها
name	string مورد نیاز. نام منبع عضویت برای حذف. برنامه های چت می توانند عضویت کاربران انسانی یا خود آنها را حذف کنند. برنامه‌های چت نمی‌توانند عضویت برنامه‌های دیگر را حذف کنند. هنگام حذف عضویت انسانی، به قالب chat.memberships و spaces/{space}/members/{member} نیاز است. می توانید از ایمیل به عنوان نام مستعار برای {member} استفاده کنید. برای مثال، spaces/{space}/members/[e-mail] که در آن [e-mail] ایمیل کاربر گپ Google است. هنگام حذف عضویت برنامه، به محدوده و فضاهای chat.memberships.app و قالب‌های spaces/{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 Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده chat.admin.delete OAuth 2.0 نیاز دارد.

حذف متادیتا

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

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

نوع حذف

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

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

گفتگو

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

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

DialogAction

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

فیلدها
action_ status	ActionStatus فقط ورودی وضعیت درخواست برای فراخوانی یا ارسال گفتگو . در صورت لزوم وضعیت و پیامی را برای کاربران نمایش می دهد. مثلا در صورت خطا یا موفقیت.
action میدانی اتحادیه اقدام برای انجام. action فقط می تواند یکی از موارد زیر باشد:
dialog	Dialog فقط ورودی گفتگو برای درخواست

DriveDataRef

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

فیلدها
drive_ file_ id	string شناسه فایل درایو با Drive API استفاده کنید.

DriveLinkData

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

فیلدها
drive_ data_ ref	DriveDataRef یک DriveDataRef که به یک فایل Google Drive ارجاع می دهد.
mime_ type	string نوع mime منبع Google Drive پیوند شده.

ایموجی

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

فیلدها
content زمینه اتحادیه مورد نیاز. محتوای ایموجی. content فقط می تواند یکی از موارد زیر باشد:
unicode	string اختیاری. یک ایموجی اصلی که با یک رشته یونیکد نمایش داده می شود.
custom_ emoji	CustomEmoji فقط خروجی یک ایموجی سفارشی

EmojiReactionSummary

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

فیلدها
emoji	Emoji فقط خروجی ایموجی با واکنش ها مرتبط است.
reaction_ count	int32 فقط خروجی تعداد کل واکنش‌ها با استفاده از ایموجی مرتبط.

FindDirectMessageRequest

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

فیلدها

name

string مورد نیاز. نام منبع کاربر برای یافتن پیام مستقیم با. قالب: users/{user} ، که در آن {user} یا id شخص از People API یا id کاربر در Directory API است. برای مثال، اگر شناسه نمایه People API 123456789 باشد، می‌توانید با استفاده users/123456789 به عنوان name ، پیام مستقیمی با آن شخص پیدا کنید. وقتی به عنوان کاربر احراز هویت می‌شوید ، می‌توانید از ایمیل به عنوان نام مستعار برای {user} استفاده کنید. به عنوان مثال، users/[e-mail] که در آن [e-mail] ایمیل کاربر چت Google است.

GetAttachmentRequest

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

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

GetCustomEmojiRequest

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
name	string مورد نیاز. نام منبع ایموجی سفارشی. قالب: customEmojis/{customEmoji} می توانید از نام emoji به عنوان نام مستعار برای {customEmoji} استفاده کنید. به عنوان مثال، customEmojis/:example-emoji: که در آن :example-emoji: نام ایموجی برای یک ایموجی سفارشی است.

GetMembershipRequest

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

فیلدها
name	string مورد نیاز. نام منبع عضویت برای بازیابی. برای دریافت عضویت خود برنامه با استفاده از احراز هویت کاربر ، می‌توانید به صورت اختیاری از spaces/{space}/members/app استفاده کنید. قالب: spaces/{space}/members/{member} یا spaces/{space}/members/app می توانید از ایمیل کاربر به عنوان نام مستعار برای {member} استفاده کنید. برای مثال، spaces/{space}/members/[e-mail] که در آن [e-mail] ایمیل کاربر گپ Google است.
use_ admin_ access	bool اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به دامنه های chat.admin.memberships یا chat.admin.memberships.readonly OAuth 2.0 نیاز دارد. هنگام استفاده از دسترسی سرپرست، دریافت عضویت برنامه در یک فضا پشتیبانی نمی‌شود.

GetMessageRequest

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

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

GetSpaceEventRequest

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

فیلدها
name	string مورد نیاز. نام منبع رویداد فضایی. قالب: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
name	string مورد نیاز. قالب: users/{user}/space/{space}/spaceNotificationSetting users/me/spaces/{space}/spaceNotificationSetting ، یا users/[e-mail]/spaces/{space}/spaceNotificationSetting ، یا users/123456789/spaces/{space}/spaceNotificationSetting . توجه: فقط شناسه کاربری یا ایمیل تماس گیرنده در مسیر مجاز است.

GetSpaceReadStateRequest

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

فیلدها

name

string مورد نیاز. نام منبع وضعیت خواندن فضا برای بازیابی. فقط از دریافت وضعیت خواندن برای کاربر تماس گیرنده پشتیبانی می کند. برای مراجعه به کاربر تماس گیرنده، یکی از موارد زیر را تنظیم کنید: نام مستعار me برای مثال، users/me/spaces/{space}/spaceReadState . آدرس ایمیل Workspace آنها. برای مثال، users/[e-mail]/spaces/{space}/spaceReadState . شناسه کاربری آنها به عنوان مثال، users/123456789/spaces/{space}/spaceReadState . قالب: users/{user}/space/{space}/spaceReadState

GetSpaceRequest

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

فیلدها
name	string مورد نیاز. نام منبع فضا، به شکل spaces/{space} . قالب: spaces/{space}
use_ admin_ access	bool اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به دامنه های chat.admin.spaces یا chat.admin.spaces.readonly OAuth 2.0 نیاز دارد.

GetThreadReadStateRequest

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

فیلدها

name

string مورد نیاز. نام منبع موضوع خواندن وضعیت برای بازیابی. فقط از دریافت وضعیت خواندن برای کاربر تماس گیرنده پشتیبانی می کند. برای مراجعه به کاربر تماس گیرنده، یکی از موارد زیر را تنظیم کنید: نام مستعار me برای مثال، users/me/spaces/{space}/threads/{thread}/threadReadState . آدرس ایمیل Workspace آنها. برای مثال، users/[e-mail]/spaces/{space}/threads/{thread}/threadReadState . شناسه کاربری آنها به عنوان مثال، users/123456789/spaces/{space}/threads/{thread}/threadReadState . قالب: users/{user}/space/{space}/threads/{thread}/threadReadState

گروه

یک گروه گوگل در چت گوگل.

فیلدها
name	string نام منبع برای یک گروه Google. یک گروه را در Cloud Identity Groups API نشان می دهد. قالب: گروه/{گروه}

History State

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

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

ListCustomEmojisRequest

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
page_ size	int32 اختیاری. حداکثر تعداد ایموجی سفارشی برگردانده شده است. این سرویس می تواند شکلک های سفارشی کمتری نسبت به این مقدار برگرداند. اگر مشخص نشده باشد، مقدار پیش فرض 25 است. حداکثر مقدار 200 است. مقادیر بالای 200 به 200 تغییر می کند.
page_ token	string اختیاری. (در صورت از سرگیری درخواست قبلی.) یک نشانه صفحه دریافت شده از تماس قبلی با شکلک سفارشی. این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه‌بندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه می‌کند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود.
filter	string اختیاری. یک فیلتر پرس و جو پشتیبانی از فیلتر توسط سازنده. برای فیلتر بر اساس سازنده، باید یک مقدار معتبر را مشخص کنید. در حال حاضر فقط creator("users/me") و NOT creator("users/me") برای فیلتر کردن ایموجی های سفارشی پذیرفته می شوند که آیا توسط کاربر تماس گیرنده ایجاد شده اند یا خیر. برای مثال، کوئری زیر شکلک های سفارشی ایجاد شده توسط تماس گیرنده را برمی گرداند: creator("users/me") درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

ListCustomEmojisResponse

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
custom_ emojis[]	CustomEmoji لیست نامرتب لیست ایموجی های سفارشی در صفحه درخواستی (یا اول).
next_ page_ token	string نشانه ای که می توانید آن را به عنوان pageToken برای بازیابی صفحه بعدی نتایج ارسال کنید. اگر خالی باشد، هیچ صفحه بعدی وجود ندارد.

ListMembershipsRequest

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

فیلدها
parent	string مورد نیاز. نام منبع فضایی که فهرست عضویت برای آن واکشی شود. قالب: spaces/{space}
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 روی true تنظیم شده است، مورد نیاز است. سایر فیلترهای نوع عضو رد خواهند شد. به عنوان مثال، پرس و جوهای زیر معتبر هستند: 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 Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده chat.admin.memberships.readonly یا chat.admin.memberships OAuth 2.0 نیاز دارد. فهرست کردن عضویت برنامه در یک فضا هنگام استفاده از دسترسی سرپرست پشتیبانی نمی‌شود.

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.name ) فیلتر کنید. برای فیلتر کردن پیام ها بر اساس تاریخ ایجاد آنها، create_time با یک مهر زمانی در قالب 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.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 Chat که رویدادها در آن رخ داده است. قالب: spaces/{space} .
page_ size	int32 اختیاری. حداکثر تعداد رویدادهای فضایی برگردانده شده است. ممکن است این سرویس کمتر از این مقدار را برگرداند. مقادیر منفی یک خطای INVALID_ARGUMENT را برمی‌گرداند.
page_ token	string اختیاری. یک نشانه صفحه، دریافت شده از تماس رویدادهای فضایی فهرست قبلی. این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده برای فهرست رویدادهای فضایی باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. انتقال مقادیر مختلف به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره شود.
filter	string مورد نیاز. یک فیلتر پرس و جو شما باید حداقل یک نوع رویداد ( event_type ) را با استفاده از عملگر has : مشخص کنید. برای فیلتر کردن بر اساس چندین نوع رویداد، از عملگر OR استفاده کنید. انواع رویداد دسته‌ای را در فیلتر خود حذف کنید. درخواست به طور خودکار هر رویداد دسته ای مرتبط را برمی گرداند. برای مثال، اگر بر اساس واکنش‌های جدید فیلتر کنید ( google.workspace.chat.reaction.v1.created )، سرور رویدادهای واکنش‌های جدید دسته‌ای را نیز برمی‌گرداند ( google.workspace.chat.reaction.v1.batchCreated ). برای لیستی از انواع رویدادهای پشتیبانی شده، به مستندات مرجع SpaceEvents مراجعه کنید. به صورت اختیاری، می‌توانید بر اساس زمان شروع ( start_time ) و زمان پایان ( end_time ) نیز فیلتر کنید: start_time : مُهر زمانی انحصاری که از آن فهرست رویدادهای فضایی شروع می شود. می توانید رویدادهایی را که تا 28 روز پیش رخ داده اند فهرست کنید. اگر مشخص نباشد، رویدادهای فضایی 28 روز گذشته را فهرست می‌کند. end_time : مُهر زمانی شامل تا زمانی که رویدادهای فضایی فهرست می‌شوند. اگر مشخص نشده باشد، رویدادها را تا زمان درخواست فهرست می کند. برای تعیین زمان شروع یا پایان، از عملگر و فرمت برابر = در 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 نتایج به ترتیب زمانی برگردانده می شوند (ابتدا قدیمی ترین رویداد). توجه: فیلد permissionSettings در شی Space برای درخواست‌های فهرست برگردانده نمی‌شود.
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 رد می‌شوند.

ListSpacesResponse

پاسخ برای یک لیست درخواست فاصله.

فیلدها
spaces[]	Space فهرست فضاهای موجود در صفحه درخواستی (یا اول). توجه: فیلد permissionSettings در شی Space برای درخواست‌های فهرست برگردانده نمی‌شود.
next_ page_ token	string برای بازیابی صفحه بعدی نتایج، می توانید یک نشانه به عنوان pageToken ارسال کنید. اگر خالی باشد، هیچ صفحه بعدی وجود ندارد.

MatchedUrl

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

فیلدها
url	string فقط خروجی نشانی اینترنتی که مطابقت داشت.

عضویت

نشان دهنده یک رابطه عضویت در 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 که عضویت با آن مطابقت دارد. خواندن یا تغییر عضویت در Google Groups به احراز هویت کاربر نیاز دارد.

نقش عضویت

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

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

کشور عضویت

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

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

MembershipBatchCreatedEventData

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

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

فیلدها
memberships[]	MembershipCreatedEventData لیستی از عضویت های جدید

MembershipBatchDeletedEventData

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

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

فیلدها
memberships[]	MembershipDeletedEventData لیستی از عضویت های حذف شده

MembershipBatchUpdatedEventData

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

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

فیلدها
memberships[]	MembershipUpdatedEventData لیستی از عضویت های به روز شده

MembershipCreatedEventData

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

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

فیلدها
membership	Membership عضویت جدید

MembershipDeletedEventData

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

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

فیلدها
membership	Membership عضویت حذف شده فقط فیلدهای name و state پر شده است.

MembershipUpdatedEventData

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

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

فیلدها
membership	Membership عضویت به روز شده

پیام

پیامی در فضای چت Google.

فیلدها
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 فقط خروجی زمانی که پیام در چت گوگل حذف شد. اگر پیام هرگز حذف نشود، این قسمت خالی است.
text	string اختیاری. متن ساده متن پیام اولین پیوند به یک تصویر، ویدیو یا صفحه وب، یک تراشه پیش‌نمایش تولید می‌کند. همچنین می‌توانید از یک کاربر گپ Google یا همه افراد حاضر در فضا @ نام ببرید . برای آشنایی با ایجاد پیام های متنی، به ارسال پیام مراجعه کنید.
formatted_ text	string فقط خروجی حاوی text پیام با نشانه‌گذاری‌هایی است که برای قالب‌بندی ارتباط اضافه شده است. این فیلد ممکن است تمام قالب‌بندی‌های قابل مشاهده در UI را ثبت نکند، اما شامل موارد زیر است: نحو نشانه گذاری برای پررنگ، مورب، خط خطی، تک فاصله، بلوک تک فضا، و لیست گلوله‌ای. نام کاربر با استفاده از قالب <users/{user}> . ابرپیوندهای سفارشی با استفاده از قالب <{url}|{rendered_text}> که در آن اولین رشته URL و رشته دوم متن ارائه شده است — برای مثال، <http://example.com|custom text> . شکلک سفارشی با استفاده از قالب :{emoji_name}: —به عنوان مثال، :smile: . این مورد برای شکلک‌های یونیکد، مانند U+1F600 برای شکلک‌های چهره خندان، صدق نمی‌کند. برای اطلاعات بیشتر، مشاهده قالب بندی متن ارسال شده در پیام را ببینید
cards[] (deprecated)	Card این مورد منسوخ شده است! منسوخ شده: به جای آن از cards_v2 استفاده کنید. کارت‌های غنی، قالب‌بندی‌شده و تعاملی که می‌توانید برای نمایش عناصر رابط کاربری مانند: متون قالب‌بندی شده، دکمه‌ها و تصاویر قابل کلیک استفاده کنید. کارت‌ها معمولاً در زیر متن ساده پیام نمایش داده می‌شوند. cards و cards_v2 می توانند حداکثر 32 کیلوبایت حجم داشته باشند.
cards_ v2[]	CardWithId اختیاری. آرایه ای از کارت ها فقط برنامه‌های چت می‌توانند کارت ایجاد کنند. اگر برنامه چت شما به عنوان کاربر احراز هویت شود ، پیام ها نمی توانند حاوی کارت باشند. برای یادگیری نحوه ایجاد پیام حاوی کارت، به ارسال پیام مراجعه کنید. طراحی و پیش نمایش کارت ها با Card Builder. کارت ساز را باز کنید
annotations[]	Annotation فقط خروجی حاشیه نویسی مرتبط با text در این پیام.
thread	Thread موضوعی که پیام به آن تعلق دارد. برای مثال استفاده، شروع یا پاسخ دادن به رشته پیام را ببینید.
space	Space فقط خروجی اگر برنامه چت شما به عنوان کاربر احراز هویت شود ، خروجی فقط name فضا را پر می کند.
fallback_ text	string اختیاری. شرح متن ساده کارت‌های پیام، که زمانی استفاده می‌شود که کارت‌های واقعی نمایش داده نمی‌شوند - به عنوان مثال، اعلان‌های تلفن همراه.
action_ response	ActionResponse فقط ورودی پارامترهایی که یک برنامه چت می تواند برای پیکربندی نحوه ارسال پاسخ خود استفاده کند.
argument_ text	string فقط خروجی متن ساده پیام با تمام اشاره‌های برنامه Chat حذف شده است.
slash_ command	SlashCommand فقط خروجی اطلاعات فرمان را در صورت وجود بریده بریده کنید.
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 اختیاری. تغییرناپذیر. ورودی برای ایجاد یک پیام، در غیر این صورت فقط خروجی. کاربری که می تواند پیام را مشاهده کند. پس از تنظیم، پیام خصوصی است و فقط برای کاربر مشخص شده و برنامه چت قابل مشاهده است. برای گنجاندن این فیلد در درخواست خود، باید با استفاده از احراز هویت برنامه با Chat API تماس بگیرید و موارد زیر را حذف کنید: پیوست ها ویجت های جانبی برای جزئیات، به ارسال پیام خصوصی مراجعه کنید.
deletion_ metadata	DeletionMetadata فقط خروجی اطلاعاتی در مورد پیام حذف شده زمانی که delete_time تنظیم شده باشد، پیامی حذف می شود.
quoted_ message_ metadata	QuotedMessageMetadata فقط خروجی اطلاعاتی درباره پیامی که توسط کاربر چت Google در یک فضا نقل شده است. کاربران چت گوگل می توانند پیامی را نقل قول کنند تا به آن پاسخ دهند.
attached_ gifs[]	AttachedGif فقط خروجی تصاویر GIF که به پیام پیوست شده اند.
accessory_ widgets[]	AccessoryWidget اختیاری. یک یا چند ویجت تعاملی که در پایین یک پیام ظاهر می شود. می‌توانید ویجت‌های جانبی را به پیام‌هایی که حاوی متن، کارت یا هر دو متن و کارت هستند اضافه کنید. برای پیام هایی که حاوی گفتگو هستند پشتیبانی نمی شود. برای جزئیات، به افزودن ویجت‌های تعاملی در پایین پیام رجوع کنید. ایجاد پیام با ویجت های جانبی نیاز به احراز هویت برنامه دارد.

MessageBatchCreatedEventData

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

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

فیلدها
messages[]	MessageCreatedEventData لیستی از پیام های جدید

MessageBatchDeletedEventData

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

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

فیلدها
messages[]	MessageDeletedEventData لیستی از پیام های حذف شده

MessageBatchUpdatedEventData

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

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

فیلدها
messages[]	MessageUpdatedEventData لیستی از پیام های به روز شده

MessageCreatedEventData

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

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

فیلدها
message	Message پیام جدید.

MessageDeletedEventData

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

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

فیلدها
message	Message پیام حذف شده فقط فیلدهای name ، createTime ، deleteTime و deletionMetadata پر شده است.

MessageUpdatedEventData

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

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

فیلدها
message	Message پیام به روز شده

QuotedMessageMetadata

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

فیلدها
name	string فقط خروجی نام منبع پیام نقل شده. قالب: spaces/{space}/messages/{message}
last_ update_ time	Timestamp فقط خروجی مهر زمانی که پیام نقل‌قول‌شده ایجاد شد یا آخرین باری که پیام نقل‌قول‌شده به‌روزرسانی شد.

واکنش

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

فیلدها
name	string شناسه. نام منبع واکنش قالب: spaces/{space}/messages/{message}/reactions/{reaction}
user	User فقط خروجی کاربری که واکنش را ایجاد کرده است.
emoji	Emoji مورد نیاز. ایموجی مورد استفاده در واکنش.

ReactionBatchCreatedEventData

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

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

فیلدها
reactions[]	ReactionCreatedEventData لیستی از واکنش های جدید

ReactionBatchDeletedEventData

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

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

فیلدها
reactions[]	ReactionDeletedEventData لیستی از واکنش های حذف شده

ReactionCreatedEventData

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

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

فیلدها
reaction	Reaction واکنش جدید

واکنشدهم

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

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

فیلدها
reaction	Reaction واکنش حذف شده

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

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

فیلدها
uri	string URI این لینک.
rich_ link_ type	RichLinkType نوع لینک غنی.
data میدانی اتحادیه. داده ها برای منبع مرتبط. data فقط می توانند یکی از موارد زیر باشند:
drive_ link_ data	DriveLinkData داده ها برای یک لینک درایو.
chat_ space_ link_ data	ChatSpaceLinkData داده ها برای یک لینک فضایی چت.

نوع غنی

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

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

SearchspacesRequest

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

فیلدها
use_ admin_ access	bool وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به دامنه 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

جستجو

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

فیلدها
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 Workspace ممکن است از قبل از این نام نمایشی استفاده کند. برای ایجاد یک گپ گروهی ، 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 را تنظیم نکنید. اگر یک فضای DIRECT_MESSAGE از قبل وجود داشته باشد ، به جای ایجاد یک فضای جدید ، آن فضا برگردانده می شود.
request_ id	string اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. مشخص کردن شناسه درخواست موجود ، فضای ایجاد شده با آن شناسه را به جای ایجاد یک فضای جدید باز می گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر معتبر متفاوت خطایی را برمی گرداند.
memberships[]	Membership اختیاری. کاربران یا گروه های Google Chat برای دعوت به پیوستن به فضا. کاربر فراخوانی را حذف کنید ، زیرا آنها به طور خودکار اضافه می شوند. این مجموعه در حال حاضر تا 20 عضویت (علاوه بر تماس گیرنده) اجازه می دهد. برای عضویت در انسانی ، قسمت Membership.member ماه نوامبر باید شامل یک user با name جمعیتی باشد (فرمت: users/{user} ) و type به User.Type.HUMAN تنظیم کنید. شما فقط می توانید کاربران انسانی را هنگام تنظیم یک فضا اضافه کنید (اضافه کردن برنامه های چت فقط برای تنظیم پیام مستقیم با برنامه تماس پشتیبانی می شود). همچنین می توانید اعضا را با استفاده از ایمیل کاربر به عنوان نام مستعار برای {کاربر} اضافه کنید. به عنوان مثال ، user.name می تواند users/[e-mail] باشد/[e-mail]. برای دعوت از کاربران Gmail یا کاربران از دامنه های فضای کاری خارجی Google ، از ایمیل کاربر برای {user} استفاده می شود. برای عضویت در Google Group ، قسمت Membership.group_member . group_member باید شامل group با name جمعیتی باشد ( groups/{group} ). فقط می توانید گروه های Google را هنگام تنظیم فضا اضافه کنید. Space.spaceType به SPACE . اختیاری هنگام تنظیم Space.spaceType به SPACE . در هنگام تنظیم فضا مورد نیاز است Space.spaceType به GROUP_CHAT ، همراه با حداقل دو عضویت. در هنگام تنظیم Space.spaceType به DIRECT_MESSAGE با یک کاربر انسانی ، همراه با یک عضویت ، مورد نیاز است. هنگام ایجاد مکالمه 1: 1 بین یک برنامه چت انسان و تماس (هنگام تنظیم Space.spaceType به DIRECT_MESSAGE و Space.singleUserBotDm to true ) باید خالی باشد.

ازمون

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

فیلدها
command_ id	int64 شناسه فرمان Slash فراخوانی شد.

Slashcommandmetadata

ابرداده حاشیه نویسی برای دستورات slash (/).

فیلدها
bot	User برنامه چت که فرمان آن فراخوانی شده است.
type	Type نوع فرمان slash.
command_ name	string نام فرمان slash فراخوانی شده.
command_ id	int64 شناسه فرمان فرمان Slash فراخوانی شده.
triggers_ dialog	bool نشان می دهد که آیا دستور slash برای یک گفتگو است یا خیر.

تایپ کنید

Enums
TYPE_UNSPECIFIED	مقدار پیش فرض برای enum. استفاده نکنید.
ADD	برنامه چت را به فضا اضافه کنید.
INVOKE	از دستور Slash در فضا استفاده کنید.

فضا

فضایی در Google Chat. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.

فیلدها
name	string شناسه. نام منبع فضا قالب: spaces/{space} جایی که {space} شناسه اختصاص داده شده توسط سیستم برای فضا را نشان می دهد. شما می توانید ID space را با فراخوانی متد spaces.list() یا از URL space بدست آورید. به عنوان مثال، اگر URL فاصله https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA باشد، شناسه فاصله AAAAAAAAA است.
type (deprecated)	Type این مورد منسوخ شده است! فقط خروجی Deprecated: به جای آن از space_type استفاده کنید. نوع یک فضا.
space_ type	SpaceType اختیاری. نوع فضا. هنگام ایجاد یک فضا یا به روز رسانی نوع فضای یک فضا مورد نیاز است. خروجی فقط برای استفاده های دیگر.
single_ user_ bot_ dm	bool اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است.
threaded (deprecated)	bool این مورد منسوخ شده است! فقط خروجی منسوخ شده: به جای آن از spaceThreadingState استفاده کنید. آیا پیام ها در این فضا قرار می گیرند یا خیر.
display_ name	string اختیاری. نام نمایشی فضا هنگام ایجاد فضایی با spaceType نوع SPACE مورد نیاز است. اگر هنگام ایجاد فاصله یا به‌روزرسانی displayName پیام خطای ALREADY_EXISTS را دریافت کردید، یک displayName دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند. برای پیام های مستقیم، این قسمت ممکن است خالی باشد. پشتیبانی از 128 کاراکتر
external_ user_ allowed	bool اختیاری. تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید: کاربر احراز هویت شده از یک حساب مصرف کننده (حساب کاربری مدیریت نشده) استفاده می کند. به‌طور پیش‌فرض، فضایی که توسط حساب مصرف‌کننده ایجاد می‌شود، به هر کاربر چت Google اجازه می‌دهد. برای فضاهای موجود، این فیلد فقط خروجی است.
space_ threading_ state	SpaceThreadingState فقط خروجی حالت رشته در فضای چت.
space_ details	SpaceDetails اختیاری. جزئیات در مورد فضا از جمله توضیحات و قوانین.
space_ history_ state	HistoryState اختیاری. وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا.
import_ mode	bool اختیاری. آیا این فضا در Import Mode به عنوان بخشی از انتقال داده به Google Workspace ایجاد شده است یا خیر. وقتی فضاها وارد می‌شوند، تا زمانی که وارد کردن کامل نشود برای کاربران قابل مشاهده نیستند. ایجاد یک فضا در Import Mode نیاز به احراز هویت کاربر دارد.
create_ time	Timestamp اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در چت، زمان ایجاد فضا. این فیلد فقط خروجی است، مگر زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات، این قسمت را روی مهر زمانی تاریخی که در آن فضا در منبع ایجاد شده است، تنظیم کنید تا زمان ایجاد اصلی حفظ شود. فقط زمانی در خروجی پر می شود که spaceType GROUP_CHAT یا SPACE باشد.
last_ active_ time	Timestamp فقط خروجی مهر زمانی آخرین پیام در فضا. پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
admin_ installed	bool فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران می‌توانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راه‌اندازی کنند. برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیام‌رسانی مستقیم داشته باشد.
membership_ count	MembershipCount فقط خروجی تعداد عضویت های پیوسته گروه بندی شده بر اساس نوع عضو. هنگامی که space_type SPACE ، DIRECT_MESSAGE یا GROUP_CHAT است ، جمع می شود. پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
access_ settings	AccessSettings اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که space_type SPACE باشد.
space_ uri	string فقط خروجی URI برای دسترسی کاربر به فضا.
customer	string اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضایی با تأیید اعتبار برنامه و SpaceType SPACE است، در غیر این صورت نباید تنظیم شود. در قالب customers/{customer} ، که در آن customer id [منبع مشتری SDK مدیریت] ( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) است. برنامه‌های خصوصی همچنین می‌توانند از نام مستعار customers/my_customer برای ایجاد فضا در همان سازمان Google Workspace به عنوان برنامه استفاده کنند. برای DM ها، این فیلد پر نیست. پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.
فیلد اتحادیه space_permission_settings . تنظیمات مجوز یک فضا را نشان می دهد. فقط زمانی پر می شود که space_type SPACE باشد. نیاز به احراز هویت کاربر دارد. space_permission_settings فقط می تواند یکی از موارد زیر باشد:
predefined_ permission_ settings	PredefinedPermissionSettings اختیاری. فقط ورودی تنظیمات مجوز فضا از پیش تعریف شده، ورودی فقط هنگام ایجاد یک فضا. اگر فیلد تنظیم نشده باشد، فضای همکاری ایجاد می شود. پس از ایجاد فضا، تنظیمات در قسمت PermissionSettings پر می شوند.
permission_ settings	PermissionSettings اختیاری. تنظیمات مجوز فضا برای فضاهای موجود. ورودی برای به‌روزرسانی تنظیمات دقیق مجوز فضا، جایی که تنظیمات مجوز موجود جایگزین می‌شوند. خروجی تنظیمات مجوز فعلی را فهرست می کند.

AccessSettings

تنظیم دسترسی فضا را نشان می دهد.

فیلدها
access_ state	AccessState فقط خروجی وضعیت دسترسی فضا را نشان می دهد.
audience	string اختیاری. نام منبع مخاطب هدف که می‌تواند فضا را کشف کند، به فضا بپیوندد و پیام‌های موجود در فضا را پیش‌نمایش کند. اگر تنظیم نشود، فقط کاربران یا گروه‌های Google که به صورت جداگانه دعوت شده یا به فضا اضافه شده‌اند می‌توانند به آن دسترسی داشته باشند. برای جزئیات، به ایجاد فضای قابل کشف برای مخاطب هدف مراجعه کنید. قالب: audiences/{audience} برای استفاده از مخاطبان هدف پیش‌فرض برای سازمان Google Workspace، روی audiences/default تنظیم کنید. خواندن مخاطب هدف پشتیبانی می کند: احراز هویت کاربر احراز هویت برنامه با تأیید سرپرست با محدوده chat.app.spaces در پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند. این فیلد هنگام استفاده از محدوده chat.bot با احراز هویت برنامه پر نمی شود. تنظیم مخاطب هدف نیاز به احراز هویت کاربر دارد.

AccessState

وضعیت دسترسی فضا را نشان می دهد.

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

تعداد عضویت

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

فیلدها
joined_ direct_ human_ user_ count	int32 فقط خروجی تعداد کاربران انسانی که مستقیماً به فضا ملحق شده اند، بدون احتساب کاربرانی که با عضویت در یک گروه ملحق شده اند.
joined_ group_ count	int32 فقط خروجی تعداد تمام گروه هایی که مستقیماً به فضا پیوسته اند.

PermissionSetting

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

فیلدها
managers_ allowed	bool اختیاری. آیا مدیران فضاها این مجوز را دارند.
members_ allowed	bool اختیاری. آیا اعضای غیر مدیر این مجوز را دارند.

PermissionSettings

تنظیمات مجوزی که می‌توانید هنگام به‌روزرسانی فضای نام‌گذاری شده موجود مشخص کنید.

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

فیلدها
manage_ members_ and_ groups	PermissionSetting اختیاری. تنظیم برای مدیریت اعضا و گروه ها در یک فضا.
modify_ space_ details	PermissionSetting اختیاری. تنظیم برای به‌روزرسانی نام فضا، آواتار، توضیحات و دستورالعمل‌ها.
toggle_ history	PermissionSetting اختیاری. تنظیم برای روشن و خاموش کردن تاریخچه فضا.
use_ at_ mention_ all	PermissionSetting اختیاری. تنظیم برای استفاده از @all در یک فاصله.
manage_ apps	PermissionSetting اختیاری. تنظیم برای مدیریت برنامه ها در یک فضا.
manage_ webhooks	PermissionSetting اختیاری. تنظیماتی برای مدیریت وب هوک ها در یک فضا.
post_ messages	PermissionSetting فقط خروجی تنظیم برای ارسال پیام در یک فضا.
reply_ messages	PermissionSetting اختیاری. تنظیم برای پاسخ دادن به پیام ها در یک فاصله.

PredefinedPermissionSettings

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

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	نامشخص استفاده نکنید.
COLLABORATION_SPACE	تنظیم برای تبدیل فضا به فضای همکاری که در آن همه اعضا می توانند پیام ارسال کنند.
ANNOUNCEMENT_SPACE	تنظیم برای تبدیل فضا به فضای اعلامیه ای که فقط مدیران فضا می توانند پیام ارسال کنند.

جزئیات فضایی

جزئیات در مورد فضا از جمله توضیحات و قوانین.

فیلدها
description	string اختیاری. توضیحاتی در مورد فضا به عنوان مثال، موضوع بحث فضا، هدف عملکردی یا شرکت کنندگان را شرح دهید. تا 150 کاراکتر را پشتیبانی می کند.
guidelines	string اختیاری. قوانین، انتظارات و آداب فضا. پشتیبانی از 5000 کاراکتر

SpaceThreadingState

نوع حالت threading را در فضای چت مشخص می کند.

Enums
SPACE_THREADING_STATE_UNSPECIFIED	رزرو شده است.
THREADED_MESSAGES	فضاهای نامگذاری شده که از رشته های پیام پشتیبانی می کنند. هنگامی که کاربران به یک پیام پاسخ می‌دهند، می‌توانند در درون رشته پاسخ دهند، که پاسخ آنها را در متن پیام اصلی نگه می‌دارد.
GROUPED_MESSAGES	فضاهای نامگذاری شده که مکالمه بر اساس موضوع سازماندهی می شود. موضوعات و پاسخ های آنها با هم گروه بندی می شوند.
UNTHREADED_MESSAGES	پیام های مستقیم (DM) بین دو نفر و مکالمات گروهی بین 3 نفر یا بیشتر.

SpaceType

نوع فضا. هنگام ایجاد یا به‌روزرسانی یک فضا ضروری است. خروجی فقط برای استفاده های دیگر.

Enums
SPACE_TYPE_UNSPECIFIED	رزرو شده است.
SPACE	مکانی که در آن افراد پیام می فرستند، فایل ها را به اشتراک می گذارند و با هم همکاری می کنند. یک SPACE می تواند شامل برنامه های چت باشد.
GROUP_CHAT	مکالمات گروهی بین 3 نفر یا بیشتر. یک GROUP_CHAT می‌تواند شامل برنامه‌های چت باشد.
DIRECT_MESSAGE	پیام های 1:1 بین دو انسان یا یک انسان و یک برنامه چت.

تایپ کنید

منسوخ شده: به جای آن از SpaceType استفاده کنید.

Enums
TYPE_UNSPECIFIED	رزرو شده است.
ROOM	مکالمات بین دو یا چند انسان.
DM	1:1 پیام مستقیم بین یک انسان و یک برنامه چت، که در آن همه پیام ها مسطح هستند. توجه داشته باشید که این شامل پیام های مستقیم بین دو انسان نمی شود.

SpacebatchupdatedEventData

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

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

فیلدها
spaces[]	SpaceUpdatedEventData لیستی از فضاهای به روز شده.

فضا

رویدادی که نشان دهنده تغییر یا فعالیت در یک فضای گپ Google است. برای کسب اطلاعات بیشتر ، به کار با رویدادهای Google Chat مراجعه کنید.

فیلدها
name	string نام منابع رویداد فضایی. قالب: spaces/{space}/spaceEvents/{spaceEvent}
event_ time	Timestamp زمان وقوع رویداد
event_ type	string نوع رویداد فضایی. هر نوع رویداد دارای یک نسخه دسته ای است که نشان دهنده چندین نمونه از نوع رویداد است که در یک دوره زمانی کوتاه رخ می دهد. برای درخواست های spaceEvents.list() ، انواع رویداد دسته ای را در فیلتر پرس و جو خود حذف کنید. به طور پیش فرض ، سرور هم نوع رویداد و هم نسخه دسته ای آن را برمی گرداند. انواع رویداد پشتیبانی شده برای پیام ها : پیام جدید: google.workspace.chat.message.v1.created پیام به روز شده: google.workspace.chat.message.v1.updated پیام حذف شده: google.workspace.chat.message.v1.deleted چندین پیام جدید: google.workspace.chat.message.v1.batchCreated چندین پیام به روز شده: google.workspace.chat.message.v1.batchUpdated پیام های حذف شده متعدد: google.workspace.chat.message.v1.batchDeleted انواع رویداد پشتیبانی شده برای عضویت : عضویت جدید: google.workspace.chat.membership.v1.created عضویت به روز شده: google.workspace.chat.membership.v1.updated عضویت حذف شده: google.workspace.chat.membership.v1.deleted چندین عضویت جدید: google.workspace.chat.membership.v1.batchCreated عضویت های متعدد به روز شده: google.workspace.chat.membership.v1.batchUpdated عضویت های چندگانه حذف شده: google.workspace.chat.membership.v1.batchDeleted انواع رویداد پشتیبانی شده برای واکنش ها : واکنش جدید: google.workspace.chat.reaction.v1.created واکنش حذف شده: google.workspace.chat.reaction.v1.deleted چندین واکنش جدید: google.workspace.chat.reaction.v1.batchCreated چندین واکنش حذف شده: google.workspace.chat.reaction.v1.batchDeleted انواع رویداد پشتیبانی شده در مورد فضا : فضای به روز شده: google.workspace.chat.space.v1.updated به روزرسانی های چند فضا: google.workspace.chat.space.v1.batchUpdated
payload میدان اتحادیه. payload فقط می تواند یکی از موارد زیر باشد:
message_ created_ event_ data	MessageCreatedEventData بارگیری رویداد برای یک پیام جدید. نوع رویداد: google.workspace.chat.message.v1.created
message_ updated_ event_ data	MessageUpdatedEventData بارگیری رویداد برای یک پیام به روز شده. نوع رویداد: google.workspace.chat.message.v1.updated
message_ deleted_ event_ data	MessageDeletedEventData بارگیری رویداد برای یک پیام حذف شده. نوع رویداد: google.workspace.chat.message.v1.deleted
message_ batch_ created_ event_ data	MessageBatchCreatedEventData بارگذاری رویداد برای چندین پیام جدید. نوع رویداد: google.workspace.chat.message.v1.batchCreated
message_ batch_ updated_ event_ data	MessageBatchUpdatedEventData بارگذاری رویداد برای چندین پیام به روز شده. نوع رویداد: google.workspace.chat.message.v1.batchUpdated
message_ batch_ deleted_ event_ data	MessageBatchDeletedEventData بار رویداد برای چندین پیام حذف شده. نوع رویداد: google.workspace.chat.message.v1.batchDeleted
space_ updated_ event_ data	SpaceUpdatedEventData بارگذاری رویداد برای به روزرسانی فضایی. نوع رویداد: google.workspace.chat.space.v1.updated
space_ batch_ updated_ event_ data	SpaceBatchUpdatedEventData بارگذاری رویداد برای به روزرسانی های متعدد در یک فضا. نوع رویداد: google.workspace.chat.space.v1.batchUpdated
membership_ created_ event_ data	MembershipCreatedEventData بارگیری رویداد برای عضویت جدید. نوع رویداد: google.workspace.chat.membership.v1.created
membership_ updated_ event_ data	MembershipUpdatedEventData بارگیری رویداد برای عضویت به روز شده. نوع رویداد: google.workspace.chat.membership.v1.updated
membership_ deleted_ event_ data	MembershipDeletedEventData بارگذاری رویداد برای عضویت حذف شده. نوع رویداد: google.workspace.chat.membership.v1.deleted
membership_ batch_ created_ event_ data	MembershipBatchCreatedEventData بارگذاری رویداد برای چندین عضویت جدید. نوع رویداد: google.workspace.chat.membership.v1.batchCreated
membership_ batch_ updated_ event_ data	MembershipBatchUpdatedEventData بارگذاری رویداد برای چندین عضویت به روز شده. نوع رویداد: google.workspace.chat.membership.v1.batchUpdated
membership_ batch_ deleted_ event_ data	MembershipBatchDeletedEventData بارگذاری رویداد برای چندین عضویت حذف شده. نوع رویداد: google.workspace.chat.membership.v1.batchDeleted
reaction_ created_ event_ data	ReactionCreatedEventData بارگذاری رویداد برای یک واکنش جدید. نوع رویداد: google.workspace.chat.reaction.v1.created
reaction_ deleted_ event_ data	ReactionDeletedEventData بارگذاری رویداد برای یک واکنش حذف شده. نوع رویداد: google.workspace.chat.reaction.v1.deleted
reaction_ batch_ created_ event_ data	ReactionBatchCreatedEventData بار رویداد برای چندین واکنش جدید. نوع رویداد: google.workspace.chat.reaction.v1.batchCreated
reaction_ batch_ deleted_ event_ data	ReactionBatchDeletedEventData بار رویداد برای چندین واکنش حذف شده. نوع رویداد: google.workspace.chat.reaction.v1.batchDeleted

فضانوردی

تنظیمات اعلان یک کاربر در یک فضا.

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
name	string شناسه. نام منبع تنظیم اطلاع رسانی فضایی. فرمت: users/{user}/spaces/{space}/spaceNotificationSetting .
notification_ setting	NotificationSetting تنظیم اعلان
mute_ setting	MuteSetting تنظیمات ناگوار فضا.

لجری

انواع تنظیمات ناگوار فضا.

Enums
MUTE_SETTING_UNSPECIFIED	رزرو شده است.
UNMUTED	کاربر بر اساس تنظیم اعلان ، اعلان هایی را برای فضا دریافت می کند.
MUTED	کاربر بدون در نظر گرفتن تنظیمات اعلان ، هیچ اعلان برای فضا دریافت نمی کند.

اعلان ها

انواع تنظیمات اعلان.

Enums
NOTIFICATION_SETTING_UNSPECIFIED	رزرو شده است.
ALL	اعلان ها توسط mentions ، موضوعات دنبال شده ، اولین پیام از موضوعات جدید ایجاد می شوند. تمام موضوعات جدید به طور خودکار دنبال می شوند ، مگر اینکه به صورت دستی توسط کاربر مورد بررسی قرار گیرد.
MAIN_CONVERSATIONS	اعلان توسط mentions ، دنبال کردن موضوعات ، اولین پیام از موضوعات جدید است. برای 1: 1 پیام مستقیم در دسترس نیست.
FOR_YOU	اعلان توسط mentions ایجاد می شود و موضوعات را دنبال می کند. برای 1: 1 پیام مستقیم در دسترس نیست.
OFF	اعلان خاموش است.

فضا

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

فیلدها
name	string نام منابع وضعیت خوانده شده فضا. قالب: users/{user}/spaces/{space}/spaceReadState
last_ read_ time	Timestamp اختیاری. زمان به روزرسانی فضای کاربر به روز شد. معمولاً این مربوط به زمان بندی آخرین پیام خواندن یا یک نشانگر زمانی است که توسط کاربر مشخص شده است تا آخرین موقعیت خوانده شده را در یک فضا علامت گذاری کند.

فضانوردان

بارگذاری رویداد برای یک فضای به روز شده.

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

فیلدها
space	Space فضای به روز شده

موضوع

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

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

فیلدها
name	string شناسه. نام منبع موضوع. مثال: spaces/{space}/threads/{thread}
thread_ key	string اختیاری. ورودی برای ایجاد یا به روزرسانی یک موضوع. در غیر این صورت ، فقط خروجی. شناسه تاپیک پشتیبانی از حداکثر 4000 کاراکتر این شناسه منحصر به برنامه چت است که آن را تنظیم می کند. به عنوان مثال ، اگر چندین برنامه چت با استفاده از همان کلید موضوع پیام ایجاد کنید ، پیام ها در موضوعات مختلف ارسال می شوند. برای پاسخ به موضوع ایجاد شده توسط یک شخص یا برنامه چت دیگر ، به جای آن قسمت name Thread را مشخص کنید.

threadreadstate

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

فیلدها
name	string نام منابع حالت خوانده شده موضوع. فرمت: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_ read_ time	Timestamp زمان به روزرسانی موضوع کاربر به روز شد. معمولاً این با زمان بندی آخرین پیام خواندن در یک موضوع مطابقت دارد.

updatemembershipRequest

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

فیلدها
membership	Membership مورد نیاز. عضویت برای به روزرسانی. فقط زمینه های مشخص شده توسط update_mask به روز می شوند.
update_ mask	FieldMask مورد نیاز. مسیرهای میدانی برای به روزرسانی. مقادیر متعدد را با کاما جدا کنید یا از * برای به روزرسانی تمام مسیرهای میدانی استفاده کنید. در حال حاضر مسیرهای میدانی پشتیبانی شده: role
use_ admin_ access	bool اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به محدوده chat.admin.memberships OAuth 2.0 نیاز دارد.

updatemessagerequest

درخواست به روزرسانی یک پیام.

فیلدها
message	Message مورد نیاز. پیام با زمینه های به روز شده.
update_ mask	FieldMask مورد نیاز. مسیرهای میدانی برای به روزرسانی. مقادیر متعدد را با کاما جدا کنید یا از * برای به روزرسانی تمام مسیرهای میدانی استفاده کنید. در حال حاضر مسیرهای میدانی پشتیبانی شده: text attachment cards (نیاز به احراز هویت برنامه دارد.) cards_v2 (نیاز به احراز هویت برنامه دارد.) accessory_widgets (نیاز به احراز هویت برنامه دارد.)
allow_ missing	bool اختیاری. اگر true و پیام پیدا نشود ، یک پیام جدید ایجاد می شود و updateMask نادیده گرفته می شود. شناسه پیام مشخص شده باید دارای مشتری باشد یا درخواست از بین نرود.

به روزرسانی های pacenotificationtingrequest

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

پیش‌نمایش برنامه‌نویس: به‌عنوان بخشی از برنامه پیش‌نمایش برنامه‌نویس Google Workspace موجود است که دسترسی زودهنگام به ویژگی‌های خاصی را اعطا می‌کند.

فیلدها
space_ notification_ setting	SpaceNotificationSetting مورد نیاز. نام منبع تنظیمات اطلاع رسانی فضایی باید در قالب users/{user}/spaces/{space}/spaceNotificationSetting جمع آوری شود. فقط زمینه های مشخص شده توسط update_mask به روز می شوند.
update_ mask	FieldMask مورد نیاز. مسیرهای میدانی پشتیبانی شده: - notification_setting - mute_setting

به روزرسانی

درخواست پیام برای به روزرسانی های API.

فیلدها
space_ read_ state	SpaceReadState مورد نیاز. فضای خوانده شده و قسمت های به روزرسانی. فقط از به روزرسانی حالت خوانده شده برای کاربر فراخوانی پشتیبانی می کند. برای مراجعه به کاربر تماس ، یکی از موارد زیر را تنظیم کنید: من نام me به عنوان مثال ، users/me/spaces/{space}/spaceReadState . آدرس ایمیل فضای کاری آنها. به عنوان مثال ، users/[e-mail]/spaces/{space}/spaceReadState /[e-mail]/spaces/space }/spacereadstate. شناسه کاربر آنها به عنوان مثال ، users/123456789/spaces/{space}/spaceReadState . قالب: کاربران/{کاربر}/فضاها/{فضا}/SpacereadState
update_ mask	FieldMask مورد نیاز. مسیرهای میدانی برای به روزرسانی. در حال حاضر مسیرهای میدانی پشتیبانی شده: last_read_time هنگامی که last_read_time پیام قبل از آخرین پیام ایجاد می شود ، فضا به صورت خوانده نشده در UI ظاهر می شود. برای علامت گذاری به عنوان خوانده شده ، last_read_time روی هر مقدار بعداً (بزرگتر) تنظیم کنید تا آخرین پیام ایجاد زمان. last_read_time مجبور به مطابقت با آخرین پیام ایجاد شده است. توجه داشته باشید که حالت خوانده شده فضا فقط بر وضعیت خوانده شده پیام هایی که در مکالمه سطح بالای فضا قابل مشاهده است ، تأثیر می گذارد. پاسخ در موضوعات تحت تأثیر این جدول زمانی قرار نمی گیرد و در عوض به حالت خوانده شده موضوع متکی است.

به روزرسانی

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

فیلدها
space	Space مورد نیاز. فضا با زمینه هایی که باید به روز شوند. Space.name باید به شکل spaces/{space} جمع شود. فقط زمینه های مشخص شده توسط update_mask به روز می شوند.
update_ mask	FieldMask مورد نیاز. مسیرهای میدانی به روز شده ، کاما در صورت وجود چندین نفر از هم جدا شده است. می توانید زمینه های زیر را برای یک فضا به روز کنید: space_details : توضیحات فضا را به روز می کند. تا 150 کاراکتر را پشتیبانی می کند. display_name : فقط از به روزرسانی نام نمایش برای فضاهایی که در آن فضای spaceType SPACE است پشتیبانی می کند. اگر پیام خطا را ALREADY_EXISTS دریافت کردید ، مقدار دیگری را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند. space_type : فقط از تغییر یک نوع فضایی GROUP_CHAT به SPACE پشتیبانی می کند. display_name به همراه space_type در ماسک بروزرسانی قرار دهید و اطمینان حاصل کنید که فضای مشخص شده دارای نام صفحه نمایش غیر خالی و نوع فضایی SPACE است. از جمله ماسک space_type و نوع SPACE در فضای مشخص شده هنگام به روزرسانی نام صفحه نمایش اختیاری است اگر فضای موجود از نوع SPACE برخوردار باشد. تلاش برای به روزرسانی نوع فضا به روش های دیگر منجر به خطای استدلال نامعتبر می شود. space_type با useAdminAccess پشتیبانی نمی شود. space_history_state : تنظیمات تاریخچه فضا را با روشن یا خاموش کردن فضا به روز می کند. فقط در صورت فعال بودن تنظیمات تاریخ برای سازمان فضای کاری Google پشتیبانی می شود. برای به روزرسانی وضعیت تاریخچه فضا ، شما باید تمام ماسک های میدانی دیگر را در درخواست خود حذف کنید. space_history_state با استفاده از useAdminAccess پشتیبانی نمی شود. access_settings.audience : تنظیم دسترسی به چه کسی می تواند فضا را کشف کند ، به فضا بپیوندید و پیام ها را در فضای نامگذاری شده که در آن فضای spaceType SPACE است ، پیش نمایش کنید. اگر فضای موجود مخاطب هدف دارد ، می توانید مخاطب را حذف کرده و دسترسی به فضا را با حذف یک مقدار برای این ماسک میدانی محدود کنید. برای به روزرسانی تنظیمات دسترسی برای یک فضا ، کاربر تأیید کننده باید یک مدیر فضا باشد و تمام ماسک های زمینه دیگر را در درخواست شما حذف کند. اگر فضا در حالت واردات باشد ، نمی توانید این قسمت را به روز کنید. برای کسب اطلاعات بیشتر، به ایجاد فضای قابل کشف برای کاربران خاص مراجعه کنید. access_settings.audience با استفاده از useAdminAccess پشتیبانی نمی شود. permission_settings : از تغییر تنظیمات مجوز یک فضا پشتیبانی می کند. هنگام به روزرسانی تنظیمات مجوز ، فقط می توانید ماسک های زمینه permissionSettings مشخص کنید. شما نمی توانید همزمان ماسک های زمینه دیگر را به روز کنید. permissionSettings با استفاده از useAdminAccess پشتیبانی نمی شوند. ماسک های میدانی پشتیبانی شده عبارتند از: permission_settings.manageMembersAndGroups permission_settings.modifySpaceDetails permission_settings.toggleHistory permission_settings.useAtMentionAll permission_settings.manageApps permission_settings.manageWebhooks permission_settings.replyMessages
use_ admin_ access	bool اختیاری. وقتی true ، روش با استفاده از امتیازات سرپرست Google Workspace کاربر اجرا می‌شود. کاربر تماس گیرنده باید یک سرپرست Google Workspace با امتیاز مدیریت چت و مکالمات فضاها باشد. به دامنه chat.admin.spaces oauth 2.0 نیاز دارد. برخی از مقادیر FieldMask با استفاده از Admin Access پشتیبانی نمی شوند. برای جزئیات بیشتر ، به توضیحات update_mask مراجعه کنید.

کاربر

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

فیلدها
name	string نام منابع برای user گپ Google. قالب: users/{user} . users/app می توانند به عنوان نام مستعار برای کاربر bot برنامه تماس استفاده شوند. برای human users ، {user} همان شناسه کاربر است: id برای شخص در API مردم. به عنوان مثال ، users/123456789 در API چت نشان دهنده همان شخص 123456789 شناسه پروفایل شخص در افراد API است. id برای کاربر در API Admin SDK API. آدرس ایمیل کاربر می تواند به عنوان نام مستعار برای {user} در درخواست های API استفاده شود. به عنوان مثال ، اگر شناسه پروفایل People API Person برای [e-mail] 123456789 است ، می توانید users/[e-mail] به عنوان نام مستعار برای users/123456789 استفاده کنید. فقط نام منابع متعارف (به عنوان مثال users/123456789 ) از API بازگردانده می شود.
display_ name	string فقط خروجی نام نمایشی کاربر
domain_ id	string شناسه منحصر به فرد دامنه فضای کاری Google کاربر.
type	Type نوع کاربر
is_ anonymous	bool فقط خروجی در صورت true ، کاربر حذف می شود یا مشخصات آنها قابل مشاهده نیست.

تایپ کنید

Enums
TYPE_UNSPECIFIED	مقدار پیش فرض برای enum. استفاده نکنید.
HUMAN	کاربر انسانی
BOT	کاربر برنامه چت.

usermentionmetadata

ابرداده حاشیه نویسی برای ذکر کاربر (@).

فیلدها
user	User کاربر ذکر کرد.
type	Type نوع ذکر کاربر.

تایپ کنید

Enums
TYPE_UNSPECIFIED	مقدار پیش فرض برای enum. استفاده نکنید.
ADD	کاربر را به فضا اضافه کنید.
MENTION	کاربر را در فضا ذکر کنید.

ویراچه

ویجت یک عنصر UI است که متن و تصاویر را ارائه می دهد.

فیلدها
buttons[]	Button لیستی از دکمه ها دکمه ها همچنین oneof data است و فقط باید یکی از این زمینه ها تنظیم شود.
data میدانی اتحادیه. WidgetMarkup فقط می تواند یکی از موارد زیر را داشته باشد. برای نمایش موارد بیشتر می توانید از چندین زمینه WidgetMarkup استفاده کنید. data فقط می توانند یکی از موارد زیر باشند:
text_ paragraph	TextParagraph یک پاراگراف متن را در این ویجت نمایش دهید.
image	Image تصویر را در این ویجت نمایش دهید.
key_ value	KeyValue یک مورد با ارزش کلیدی را در این ویجت نمایش دهید.

دکمه

یک دکمه می تواند یک دکمه متن یا یک دکمه تصویر باشد.

فیلدها
type میدان اتحادیه. type فقط می تواند یکی از موارد زیر باشد:
text_ button	TextButton یک دکمه با متن و onclick Action.
image_ button	ImageButton یک دکمه با تصویر و onclick Action.

شکل گیری

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

فیلدها
action_ method_ name	string از نام این روش برای شناسایی کدام قسمت از فرم ایجاد فرم فرم استفاده می شود. این اطلاعات به عنوان بخشی از رویداد کلیک کارت به برنامه گپ باز می گردد. می توانید از همان نام روش برای چندین عنصر استفاده کنید که باعث ایجاد یک رفتار مشترک می شوند.
parameters[]	ActionParameter لیست پارامترهای عمل.

عمل پارامتر

لیست پارامترهای رشته ای برای تهیه هنگام استفاده از روش عمل. به عنوان مثال ، سه دکمه چرت را در نظر بگیرید: اکنون چرت بزنید ، یک روز چرت بزنید ، هفته آینده چرت بزنید. شما ممکن است action method = snooze() استفاده کنید ، از نوع چرت زدن عبور کرده و زمان را در لیست پارامترهای رشته قرار دهید.

فیلدها
key	string نام پارامتر برای اسکریپت اکشن.
value	string مقدار پارامتر.

نماد

مجموعه ای از نمادهای پشتیبانی شده.

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

تصویر

تصویری که توسط یک URL مشخص شده و می تواند یک عمل onclick داشته باشد.

فیلدها
image_ url	string URL تصویر.
on_ click	OnClick عمل onclick .
aspect_ ratio	double نسبت ابعاد این تصویر (عرض و ارتفاع). این قسمت به شما امکان می دهد در حالی که منتظر بارگیری آن هستید ، ارتفاع مناسب را برای تصویر رزرو کنید. این به معنای غلبه بر نسبت ابعاد داخلی تصویر نیست. در صورت عدم استفاده ، سرور آن را با پیش بینی تصویر پر می کند.

دکمه تصویر

یک دکمه تصویر با یک عمل onclick .

فیلدها
on_ click	OnClick عمل onclick .
name	string نام این image_button که برای دسترسی استفاده می شود. اگر این نام مشخص نشده باشد ، مقدار پیش فرض ارائه می شود.
icons میدانی اتحادیه. نماد را می توان با یک Icon یا URL enum کرد. icons فقط می توانند یکی از موارد زیر باشند:
icon	Icon نماد مشخص شده توسط یک enum که به یک نماد تهیه شده توسط API CHAT اشاره می کند.
icon_ url	string نماد مشخص شده توسط یک URL.

KeyValue

یک عنصر UI حاوی یک کلید (برچسب) و یک مقدار (محتوا) است. این عنصر همچنین می تواند شامل برخی از اقدامات مانند دکمه onclick باشد.

فیلدها
top_ label	string متن برچسب بالا. متن فرمت شده پشتیبانی می شود. برای اطلاعات بیشتر درباره قالب‌بندی متن، به قالب‌بندی متن در برنامه‌های چت Google و قالب‌بندی متن در افزونه‌های Google Workspace مراجعه کنید.
content	string متن محتوا متن فرمت شده پشتیبانی شده و همیشه مورد نیاز است. برای اطلاعات بیشتر درباره قالب‌بندی متن، به قالب‌بندی متن در برنامه‌های چت Google و قالب‌بندی متن در افزونه‌های Google Workspace مراجعه کنید.
content_ multiline	bool اگر محتوا باید چند لایه باشد.
bottom_ label	string متن برچسب پایین. متن فرمت شده پشتیبانی می شود. برای اطلاعات بیشتر درباره قالب‌بندی متن، به قالب‌بندی متن در برنامه‌های چت Google و قالب‌بندی متن در افزونه‌های Google Workspace مراجعه کنید.
on_ click	OnClick عمل onclick . فقط برچسب برتر ، برچسب پایین و منطقه محتوا قابل کلیک است.
icons میدانی اتحادیه. حداقل یکی از آیکون ها ، top_label و bottom_label باید تعریف شود. icons فقط می توانند یکی از موارد زیر باشند:
icon	Icon مقدار enum که توسط API چت با تصویر نماد مربوطه جایگزین شده است.
icon_ url	string نماد مشخص شده توسط یک URL.
control میدان اتحادیه. ویجت کنترل شما می توانید button یا switch_widget را تنظیم کنید ، اما هر دو نیست. control می تواند تنها یکی از موارد زیر باشد:
button	Button دکمه ای که می توان برای ایجاد یک عمل کلیک کرد.

OnClick

یک عمل onclick (به عنوان مثال ، پیوند را باز کنید).

فیلدها
data میدانی اتحادیه. data فقط می توانند یکی از موارد زیر باشند:
action	FormAction در صورت مشخص شدن ، یک عمل فرم توسط این عمل onclick ایجاد می شود.
open_ link	OpenLink این عمل onclick در صورت مشخص شدن یک عمل لینک باز را تحریک می کند.

OpenLink

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

فیلدها
url	string URL برای باز کردن.

دکمه متن

یک دکمه با متن و onclick Action.

فیلدها
text	string متن دکمه.
on_ click	OnClick عمل onclick دکمه.

تانگراگراف

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

فیلدها
text	string