Package google.chat.v1

الفهرس

• ChatService (واجهة)
• AccessoryWidget (رسالة)
• ActionResponse (رسالة)
• ActionResponse.ResponseType (تعداد)
• ActionResponse.SelectionItems (رسالة)
• ActionResponse.UpdatedWidget (رسالة)
• ActionStatus (رسالة)
• Annotation (رسالة)
• AnnotationType (تعداد)
• AppCommandMetadata (رسالة)
• AppCommandMetadata.AppCommandType (تعداد)
• AttachedGif (رسالة)
• Attachment (رسالة)
• Attachment.Source (تعداد)
• AttachmentDataRef (رسالة)
• CalendarEventLinkData (رسالة)
• CardWithId (رسالة)
• ChatSpaceLinkData (رسالة)
• CompleteImportSpaceRequest (رسالة)
• CompleteImportSpaceResponse (رسالة)
• ContextualAddOnMarkup (رسالة)
• ContextualAddOnMarkup.Card (رسالة)
• ContextualAddOnMarkup.Card.CardAction (رسالة)
• ContextualAddOnMarkup.Card.CardHeader (رسالة)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (تعداد)
• ContextualAddOnMarkup.Card.Section (رسالة)
• CreateCustomEmojiRequest (رسالة)
• CreateMembershipRequest (رسالة)
• CreateMessageRequest (رسالة)
• CreateMessageRequest.MessageReplyOption (تعداد)
• CreateReactionRequest (رسالة)
• CreateSpaceRequest (رسالة)
• CustomEmoji (رسالة)
• CustomEmoji.CustomEmojiPayload (رسالة)
• CustomEmojiMetadata (رسالة)
• DeleteCustomEmojiRequest (رسالة)
• DeleteMembershipRequest (رسالة)
• DeleteMessageRequest (رسالة)
• DeleteReactionRequest (رسالة)
• DeleteSpaceRequest (رسالة)
• DeletionMetadata (رسالة)
• DeletionMetadata.DeletionType (تعداد)
• 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 (رسالة)
• MeetSpaceLinkData (رسالة)
• MeetSpaceLinkData.HuddleStatus (تعداد)
• MeetSpaceLinkData.Type (تعداد)
• 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 (تعداد)
• SearchSpacesRequest (رسالة)
• SearchSpacesResponse (رسالة)
• SetUpSpaceRequest (رسالة)
• SlashCommand (رسالة)
• SlashCommandMetadata (رسالة)
• SlashCommandMetadata.Type (تعداد)
• Space (رسالة)
• Space.AccessSettings (رسالة)
• Space.AccessSettings.AccessState (تعداد)
• Space.MembershipCount (رسالة)
• Space.PermissionSetting (رسالة)
• Space.PermissionSettings (رسالة)
• Space.PredefinedPermissionSettings (تعداد)
• Space.SpaceDetails (رسالة)
• Space.SpaceThreadingState (تعداد)
• Space.SpaceType (تعداد)
• Space.Type (تعداد)
• SpaceBatchUpdatedEventData (رسالة)
• SpaceEvent (رسالة)
• SpaceNotificationSetting (رسالة)
• SpaceNotificationSetting.MuteSetting (تعداد)
• SpaceNotificationSetting.NotificationSetting (تعداد)
• SpaceReadState (رسالة)
• SpaceUpdatedEventData (رسالة)
• Thread (رسالة)
• ThreadReadState (رسالة)
• UpdateMembershipRequest (رسالة)
• UpdateMessageRequest (رسالة)
• UpdateSpaceNotificationSettingRequest (رسالة)
• UpdateSpaceReadStateRequest (رسالة)
• UpdateSpaceRequest (رسالة)
• User (رسالة)
• User.Type (تعداد)
• UserMentionMetadata (رسالة)
• UserMentionMetadata.Type (تعداد)
• WidgetMarkup (رسالة)
• WidgetMarkup.Button (رسالة)
• WidgetMarkup.FormAction (رسالة)
• WidgetMarkup.FormAction.ActionParameter (رسالة)
• WidgetMarkup.Icon (تعداد)
• WidgetMarkup.Image (رسالة)
• WidgetMarkup.ImageButton (رسالة)
• WidgetMarkup.KeyValue (رسالة)
• WidgetMarkup.OnClick (رسالة)
• WidgetMarkup.OpenLink (رسالة)
• WidgetMarkup.TextButton (رسالة)
• WidgetMarkup.TextParagraph (رسالة)

ChatService

تتيح للمطوّرين إنشاء تطبيقات وعمليات دمج في Chat على "منصة Google Chat".

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse) تُكمل هذه الطريقة عملية الاستيراد للمساحة المحدّدة وتتيحها للمستخدمين. يتطلّب مصادقة المستخدم والتفويض على مستوى النطاق باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.import لمزيد من المعلومات، يُرجى الاطّلاع على مقالة منح تطبيقات Google Chat الإذن باستيراد البيانات. نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.import لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji) تنشئ هذه الطريقة رمز إيموجي مخصّصًا. لا تتوفّر الرموز التعبيرية المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، راجِع المقالتَين التعرّف على الرموز التعبيرية المخصصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.customemojis نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.customemojis لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) تُنشئ هذه الطريقة عضوية لتطبيق الاتصال في Chat أو لمستخدم أو لمجموعة Google. لا تتوفّر إمكانية إنشاء عضويات لتطبيقات Chat الأخرى. عند إنشاء عضوية، إذا كان العضو المحدّد قد أوقف سياسة القبول التلقائي، ستتم دعوته، وعليه قبول دعوة الفضاء قبل الانضمام إليه. بخلاف ذلك، يؤدي إنشاء اشتراك إلى إضافة العضو مباشرةً إلى المساحة المحدّدة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض: https://www.googleapis.com/auth/chat.app.memberships مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app (لإضافة تطبيق الاتصال إلى المساحة) https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاق التفويض التالي: https://www.googleapis.com/auth/chat.admin.memberships لا تتوفّر مصادقة التطبيق لحالات الاستخدام التالية: دعوة مستخدمين من خارج مؤسسة Workspace التي تمتلك المساحة إضافة "مجموعة Google" إلى مساحة إضافة تطبيق Chat إلى مساحة للاطّلاع على أمثلة على الاستخدام، يُرجى الرجوع إلى: دعوة مستخدم أو إضافته إلى مساحة دعوة مجموعة Google أو إضافتها إلى مساحة أضِف تطبيق Chat إلى مساحة. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message) تُنشئ هذه الطريقة رسالة في مساحة Google Chat. للاطّلاع على مثال، يُرجى الانتقال إلى إرسال رسالة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.create https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) يحدّد Chat هوية مرسل الرسالة بشكل مختلف استنادًا إلى نوع المصادقة الذي تستخدمه في طلبك. تعرض الصورة التالية كيف ينسب Chat رسالة عند استخدام مصادقة التطبيق. يعرض Chat تطبيق Chat كمُرسِل الرسالة. يمكن أن يتضمّن محتوى الرسالة نصًا (text) وبطاقات (cardsV2) وأدوات ملحقة (accessoryWidgets). تعرض الصورة التالية كيف ينسب Chat رسالة عند استخدام مصادقة المستخدم. يعرض Chat المستخدم كمُرسِل الرسالة ويشير إلى تطبيق Chat في الرسالة من خلال عرض اسمه. يمكن أن يحتوي محتوى الرسالة على نص فقط (text). الحد الأقصى لحجم الرسالة، بما في ذلك محتوى الرسالة، هو 32,000 بايت. بالنسبة إلى طلبات الردّ التلقائي على الويب، لا يحتوي الردّ على الرسالة الكاملة. يتم ملء الحقلَين name وthread.name فقط بالإضافة إلى المعلومات التي تم تضمينها في الطلب. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.create لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction) تنشئ هذه الطريقة تفاعلاً وتضيفه إلى رسالة. للاطّلاع على مثال، راجِع المقالة إضافة تفاعل إلى رسالة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.reactions.create https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.create لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space) تنشئ هذه الطريقة مساحة. يمكن استخدامها لإنشاء مساحة مُسمّاة أو محادثة جماعية في Import mode. للاطّلاع على مثال، راجِع إنشاء مساحة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف وأحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) عند إجراء المصادقة كتطبيق، يجب ضبط الحقل space.customer في الطلب. عند المصادقة كتطبيق، تتم إضافة تطبيق Chat كعضو في المساحة. ومع ذلك، على عكس المصادقة البشرية، لا تتم إضافة تطبيق Chat كمدير للمساحة. بشكلٍ تلقائي، يمكن لجميع أعضاء المساحة إزالة تطبيق Chat منها. للسماح لمدراء المساحة فقط بإزالة التطبيق من مساحة، اضبط space.permission_settings.manage_apps على managers_allowed. يعتمد الاشتراك في المساحة عند إنشائها على ما إذا تم إنشاؤها في Import mode: وضع الاستيراد: لا يتم إنشاء أي أعضاء. جميع الأوضاع الأخرى: تتم إضافة المستخدم الذي يجري المكالمة كعضو. وهي: التطبيق نفسه عند استخدام ميزة "مصادقة التطبيق" المستخدم البشري عند استخدام مصادقة المستخدم إذا تلقّيت رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة، جرِّب استخدام displayName مختلف. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.spaces.create https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty) يحذف هذا الإجراء رمزًا تعبيريًا مخصّصًا. بشكلٍ تلقائي، يمكن للمستخدمين حذف رموز الإيموجي المخصّصة التي أنشأوها فقط. يمكن لمدراء الرموز التعبيرية الذين يعيّنهم المشرف حذف أي رمز تعبيري مخصّص في المؤسسة. اطّلِع على مقالة التعرّف على الرموز التعبيرية المخصصة في Google Chat. لا تتوفّر الرموز التعبيرية المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، راجِع المقالتَين التعرّف على الرموز التعبيرية المخصصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.customemojis نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.customemojis لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership) تحذف هذه الطريقة عضوية. للاطّلاع على مثال، يُرجى الانتقال إلى إزالة مستخدم أو تطبيق Google Chat من مساحة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض: https://www.googleapis.com/auth/chat.app.memberships مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app (لإزالة تطبيق الاتصال من المساحة) https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاق التفويض التالي: https://www.googleapis.com/auth/chat.admin.memberships لا تتوفّر مصادقة التطبيق لحالات الاستخدام التالية: إزالة مجموعة Google من مساحة إزالة تطبيق Chat من مساحة لحذف عضويات مدراء المساحة، يجب أن يكون مقدّم الطلب مدير مساحة. إذا كنت تستخدم مصادقة التطبيق، يجب أن يكون تطبيق Chat هو منشئ المساحة. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty) لحذف رسالة للاطّلاع على مثال، يُرجى الانتقال إلى حذف رسالة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق مع نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) عند استخدام مصادقة التطبيق، يمكن للطلبات حذف الرسائل التي أنشأها تطبيق Chat الذي يتم إجراء المكالمة منه فقط. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty) لحذف تفاعل مع رسالة للاطّلاع على مثال، يُرجى الانتقال إلى حذف تفاعل. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty) يحذف هذا الإجراء مساحة مُسمّاة. يتم دائمًا تنفيذ عملية حذف متسلسلة، ما يعني أنّه يتم أيضًا حذف الموارد الفرعية للمساحة، مثل الرسائل المنشورة في المساحة والعضويات في المساحة. للاطّلاع على مثال، يُرجى الانتقال إلى حذف مساحة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض: https://www.googleapis.com/auth/chat.app.delete (في المساحات التي أنشأها التطبيق فقط) مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.delete https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاق التفويض التالي: https://www.googleapis.com/auth/chat.admin.delete نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.delete https://www.googleapis.com/auth/chat.admin.delete https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.delete لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space) تعرض هذه الطريقة الرسالة المباشرة الحالية مع المستخدم المحدّد. إذا لم يتم العثور على مساحة رسالة مباشرة، يتم عرض الخطأ 404 NOT_FOUND. للاطّلاع على مثال، راجِع مقالة العثور على رسالة مباشرة. باستخدام مصادقة التطبيق، يتم عرض مساحة الرسائل المباشرة بين المستخدم المحدّد وتطبيق Chat الذي يتم الاتصال به. باستخدام مصادقة المستخدم، تعرض هذه الطريقة مساحة الرسائل المباشرة بين المستخدم المحدّد والمستخدم الذي تمت مصادقته. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق مع نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces نطاقات الأذونات يجب توفير أحد نطاقات 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) تعرض هذه الطريقة البيانات الوصفية لمرفق رسالة. يتم جلب بيانات المرفقات باستخدام واجهة برمجة التطبيقات الخاصة بالوسائط. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على بيانات وصفية حول مرفق رسالة. يتطلّب مصادقة التطبيق باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.bot نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.bot لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji) تعرض هذه الطريقة تفاصيل حول إيموجي مخصّص. لا تتوفّر الرموز التعبيرية المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، راجِع المقالتَين التعرّف على الرموز التعبيرية المخصصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership) تعرض هذه الطريقة تفاصيل حول عضوية. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على تفاصيل حول عضوية مستخدم أو تطبيق Google Chat. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships (يتطلّب موافقة المشرف) مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetMessage

rpc GetMessage(GetMessageRequest) returns (Message) تعرض هذه الطريقة تفاصيل حول رسالة. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على تفاصيل حول رسالة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق مع نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages ملاحظة: قد تعرض هذه الطريقة رسالة من عضو أو مساحة محظورة. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space) تعرض هذه الطريقة تفاصيل حول مساحة. للاطّلاع على مثال، يُرجى الانتقال إلى الاطّلاع على تفاصيل حول مساحة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces مع موافقة المشرف مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces تنطبق القيود التالية على مصادقة التطبيق: لا تتم تعبئة space.access_settings إلا عند استخدام النطاق chat.app.spaces. لا تتم تعبئة space.predefind_permission_settings وspace.permission_settings إلا عند استخدام النطاق chat.app.spaces، وفقط للمساحات التي أنشأها التطبيق. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.spaces لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent) تعرض هذه الطريقة حدثًا من مساحة Google Chat. يحتوي حمولة الحدث على أحدث إصدار من المورد الذي تم تغييره. على سبيل المثال، إذا طلبت حدثًا حول رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، سيعرض الخادم مورد Message المعدَّل في حمولة الحدث. ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر "المساحة" ضمن بيانات حدث "المساحة" لهذا الطلب. يتطلّب مصادقة المستخدم باستخدام نطاق تفويض مناسب لقراءة البيانات المطلوبة: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships للحصول على حدث، يجب أن يكون المستخدم الذي تمّت مصادقته عضوًا في المساحة. للاطّلاع على مثال، راجِع الحصول على تفاصيل حول حدث من مساحة في Google Chat. نطاقات الأذونات يجب توفير أحد نطاقات 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) تعرض هذه السمة إعدادات الإشعارات في المساحة. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على إعدادات إشعارات المساحة الخاصة بالمتصل. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.users.spacesettings نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.users.spacesettings لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState) تعرض هذه الطريقة تفاصيل حول حالة القراءة لدى المستخدم في مساحة معيّنة، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على تفاصيل حول حالة قراءة مستخدم لمساحة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState) تعرض هذه الطريقة تفاصيل حول حالة قراءة المستخدم ضمن سلسلة محادثات، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على تفاصيل حول حالة قراءة سلسلة محادثات خاصة بمستخدم. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.users.readstate.readonly https://www.googleapis.com/auth/chat.users.readstate نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.users.readstate https://www.googleapis.com/auth/chat.users.readstate.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse) تعرض هذه الطريقة رموز الإيموجي المخصّصة المرئية للمستخدم الذي تمّت مصادقته. لا تتوفّر الرموز التعبيرية المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، راجِع المقالتَين التعرّف على الرموز التعبيرية المخصصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.customemojis.readonly https://www.googleapis.com/auth/chat.customemojis نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.customemojis https://www.googleapis.com/auth/chat.customemojis.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse) تعرض هذه الطريقة عضويات المستخدم في مساحة. للاطّلاع على مثال، راجِع إدراج المستخدمين وتطبيقات Google Chat في مساحة. تعرض قائمة الاشتراكات التي تتضمّن مصادقة التطبيق الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكنها تستثني اشتراكات تطبيق Chat، بما في ذلك اشتراكه الخاص. تعرض قائمة العضويات التي تتضمّن مصادقة المستخدم العضويات في المساحات التي يمكن للمستخدم المصادَق عليه الوصول إليها. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.app.memberships (يتطلّب موافقة المشرف) مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.admin.memberships نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.admin.memberships.readonly https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse) تدرِج هذه الطريقة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء والمساحات المحظورة. إذا أدرجت رسائل من مساحة لا تحتوي على أي رسائل، سيكون الردّ عبارة عن عنصر فارغ. عند استخدام واجهة REST/HTTP، تحتوي الاستجابة على عنصر JSON فارغ، {}. للاطّلاع على مثال، يُرجى الانتقال إلى قائمة الرسائل. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse) تعرض هذه السمة قائمة بالتفاعلات مع رسالة. للحصول على مثال، اطّلِع على عرض التفاعلات مع رسالة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.messages.reactions.readonly لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse) تعرض هذه الطريقة الأحداث من مساحة Google Chat. بالنسبة إلى كل حدث، تحتوي الحِزمة على أحدث نسخة من مرجع Chat. على سبيل المثال، إذا أدرجت أحداثًا حول أعضاء جدد في المساحة، يعرض الخادم موارد Membership تحتوي على أحدث تفاصيل العضوية. إذا تمت إزالة أعضاء جدد خلال الفترة المطلوبة، ستحتوي حمولة الحدث على مورد Membership فارغ. يتطلّب مصادقة المستخدم باستخدام نطاق تفويض مناسب لقراءة البيانات المطلوبة: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.messages.readonly https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.messages.reactions.readonly https://www.googleapis.com/auth/chat.messages.reactions https://www.googleapis.com/auth/chat.memberships.readonly https://www.googleapis.com/auth/chat.memberships لعرض الأحداث، يجب أن يكون المستخدم الذي تمّت المصادقة عليه عضوًا في المساحة. للاطّلاع على مثال، راجِع عرض قائمة بالأحداث من مساحة في Google Chat. نطاقات الأذونات يجب توفير أحد نطاقات 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) تعرض هذه الطريقة المساحات التي يكون المتصل عضوًا فيها. لا يتم إدراج المحادثات الجماعية والرسائل المباشرة إلا بعد إرسال الرسالة الأولى. للاطّلاع على مثال، راجِع المساحات المدرَجة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق مع نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces.readonly https://www.googleapis.com/auth/chat.spaces لعرض جميع المساحات المسماة حسب مؤسسة 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 لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse) تعرض هذه الطريقة قائمة بالمساحات في مؤسسة Google Workspace استنادًا إلى عملية بحث يجريها المشرف. يتطلّب مصادقة المستخدم باستخدام امتيازات المشرف وأحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.admin.spaces.readonly https://www.googleapis.com/auth/chat.admin.spaces في الطلب، اضبط قيمة 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. على سبيل المثال، إذا كان رقم تعريف ملف المستخدم [e-mail] في People API هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/[e-mail] أو users/123456789. لتحديد مجموعات Google التي تريد إضافتها، أضِف عضويات باستخدام membership.group_member.name المناسب. لإضافة مجموعة Google أو دعوة مجموعة Google، استخدِم groups/{group}، حيث يمثّل {group} id للمجموعة من Cloud Identity Groups API. على سبيل المثال، يمكنك استخدام Cloud Identity Groups lookup API لاسترداد المعرّف 123456789 لعنوان البريد الإلكتروني للمجموعة [e-mail]، ثم يمكنك إضافة المجموعة إلى المساحة من خلال ضبط membership.group_member.name على groups/123456789. لا يتوفّر البريد الإلكتروني للمجموعة، ولا يمكن إضافة مجموعات Google إلا كأعضاء في المساحات التي تحمل أسماء. في مساحة أو محادثة جماعية تحمل اسمًا، إذا حظر المتصل بعض الأعضاء أو تم حظره من قِبلهم أو لم يكن لديه إذن بإضافة بعض الأعضاء، لن تتم إضافة هؤلاء الأعضاء إلى المساحة التي تم إنشاؤها. لإنشاء رسالة مباشرة بين المستخدم الذي يجري المكالمة ومستخدم آخر، حدِّد عضوية واحدة فقط لتمثيل المستخدم. إذا حظر أحد المستخدمَين الآخر، سيفشل الطلب ولن يتم إنشاء الرسالة المباشرة. لإنشاء رسالة مباشرة بين المستخدم الذي يجري المكالمة والتطبيق الذي يجري المكالمة، اضبط قيمة Space.singleUserBotDm على true ولا تحدّد أي عضويات. يمكنك استخدام هذه الطريقة فقط لإعداد رسالة مباشرة مع تطبيق الاتصال. لإضافة تطبيق الاتصال كعضو في مساحة أو رسالة مباشرة حالية بين مستخدمَين، يُرجى الاطّلاع على دعوة مستخدم أو تطبيق أو إضافته إلى مساحة. إذا كانت هناك رسالة مباشرة بين مستخدمَين، حتى إذا حظر أحدهما الآخر في وقت تقديم الطلب، سيتم عرض الرسالة المباشرة الحالية. لا تتوافق المساحات مع الردود في سلاسل محادثات. إذا تلقّيت رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب displayName مختلفًا. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces.create https://www.googleapis.com/auth/chat.spaces نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership) تعديل اشتراك للاطّلاع على مثال، يُرجى الرجوع إلى تعديل عضوية مستخدم في مساحة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض: https://www.googleapis.com/auth/chat.app.memberships (في المساحات التي أنشأها التطبيق فقط) مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاق التفويض التالي: https://www.googleapis.com/auth/chat.admin.memberships نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.memberships https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message) تعديل رسالة هناك فرق بين طريقتَي patch وupdate. يستخدم الإجراء patch طلب patch، بينما يستخدم الإجراء update طلب put. ننصحك باستخدام الطريقة patch. للاطّلاع على مثال، يُرجى الانتقال إلى تعديل رسالة. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق مع نطاق التفويض: https://www.googleapis.com/auth/chat.bot مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.messages https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) عند استخدام مصادقة التطبيق، يمكن للطلبات تعديل الرسائل التي أنشأها تطبيق Chat الذي يجري المكالمة فقط. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.bot https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.messages لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space) تعديل مساحة للاطّلاع على مثال، يُرجى الرجوع إلى مقالة تعديل مساحة. إذا كنت تعدّل الحقل displayName وظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب اسمًا معروضًا مختلفًا. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. يتوافق مع الأنواع التالية من المصادقة: مصادقة التطبيق من خلال موافقة المشرف وأحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.app.spaces مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط) تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاقات التفويض التالية: https://www.googleapis.com/auth/chat.admin.spaces تنطبق القيود التالية على مصادقة التطبيق: لتعديل space.predefined_permission_settings أو space.permission_settings، يجب أن يكون التطبيق هو من أنشأ المساحة. لا يمكن تعديل space.access_settings.audience عند المصادقة باستخدام التطبيق. نطاقات الأذونات يجب توفير أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.app.spaces https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting) تعديل إعدادات إشعارات المساحة للاطّلاع على مثال، يُرجى الانتقال إلى تعديل إعدادات إشعارات المساحة للمتصل. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.users.spacesettings نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.users.spacesettings لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState) تعدّل هذه الطريقة حالة القراءة الخاصة بالمستخدم في مساحة معيّنة، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، راجِع تعديل حالة قراءة مساحة مستخدم. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض: https://www.googleapis.com/auth/chat.users.readstate نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.users.readstate لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

AccessoryWidget

عنصر تفاعلي واحد أو أكثر يظهر في أسفل الرسالة. لمزيد من التفاصيل، يُرجى الاطّلاع على إضافة أدوات تفاعلية في أسفل الرسالة.

الحقول
حقل الدمج action نوع الإجراء يمكن أن تكون action إحدى القيم التالية فقط:
button_list	ButtonList قائمة بالأزرار

ActionResponse

المَعلمات التي يمكن أن يستخدمها تطبيق Chat لتحديد طريقة نشر الرد.

الحقول
type	ResponseType الإدخال فقط نوع رد تطبيق Chat
url	string الإدخال فقط عنوان URL الذي يمكن للمستخدمين استخدامه للمصادقة أو الإعداد (لأنواع الردود REQUEST_CONFIG فقط)
dialog_action	DialogAction الإدخال فقط ردّ على حدث تفاعلي مرتبط بمربّع حوار يجب أن يكون مصحوبًا بـ ResponseType.Dialog.
updated_widget	UpdatedWidget الإدخال فقط ردّ التطبيق المصغّر المعدَّل

ResponseType

نوع رد تطبيق Chat

عمليات التعداد
TYPE_UNSPECIFIED	النوع التلقائي الذي يتم التعامل معه على أنّه NEW_MESSAGE.
NEW_MESSAGE	نشرها كرسالة جديدة في الموضوع
UPDATE_MESSAGE	عدِّل رسالة تطبيق Chat. يُسمح بذلك فقط في حدث CARD_CLICKED يكون فيه نوع مرسل الرسالة BOT.
UPDATE_USER_MESSAGE_CARDS	تعديل البطاقات في رسالة المستخدم لا يُسمح بذلك إلا كردّ على حدث MESSAGE يتضمّن عنوان URL مطابقًا، أو حدث CARD_CLICKED يكون فيه نوع مرسل الرسالة HUMAN. يتم تجاهل النص.
REQUEST_CONFIG	يمكنك أن تطلب من المستخدم بشكل خاص إجراء مصادقة أو ضبط إضافي.
DIALOG	تعرض هذه السمة مربّع حوار.
UPDATE_WIDGET	طلب البحث عن خيارات الإكمال التلقائي لنص التطبيق المصغّر

SelectionItems

قائمة بنتائج الإكمال التلقائي للتطبيقات المصغّرة

الحقول
items[]	SelectionItem مصفوفة من عناصر SelectionItem.

UpdatedWidget

بالنسبة إلى عناصر واجهة المستخدم selectionInput، تعرض هذه السمة اقتراحات الإكمال التلقائي لقائمة اختيار متعدّد.

الحقول
widget	string رقم تعريف الأداة التي تم تعديلها يجب أن يتطابق المعرّف مع معرّف التطبيق المصغّر الذي أرسل طلب التعديل.
حقل الدمج updated_widget تم تعديل التطبيق المصغّر استجابةً لإجراء من المستخدم. يمكن أن تكون updated_widget إحدى القيم التالية فقط:
suggestions	SelectionItems قائمة بنتائج الإكمال التلقائي للتطبيقات المصغّرة

ActionStatus

تمثّل هذه السمة حالة طلب استدعاء مربّع حوار أو إرساله.

الحقول
status_code	Code تمثّل هذه السمة رمز الحالة.
user_facing_message	string الرسالة التي سيتم إرسالها إلى المستخدمين بشأن حالة طلباتهم في حال عدم ضبطها، يتم إرسال رسالة عامة استنادًا إلى status_code.

تعليق توضيحي

يمكن ربط التعليقات التوضيحية بنص الرسالة العادي أو بالشرائح التي تتضمّن روابط تؤدي إلى مراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google" مع start_index وlength بقيمة 0. لإضافة تنسيق أساسي إلى رسالة نصية، اطّلِع على تنسيق الرسائل النصية.

مثال على نص الرسالة العادي:

Hello @FooBot how are you!"

البيانات الوصفية للتعليقات التوضيحية المقابلة:

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

الحقول
type	AnnotationType تمثّل هذه السمة نوع التعليق التوضيحي.
length	int32 طول السلسلة الفرعية في نص الرسالة العادي الذي يتطابق معه هذا التعليق التوضيحي. في حال عدم توفّرها، تشير إلى مدة 0.
start_index	int32 فهرس البداية (يبدأ من 0، ويشمل القيمة) في نص الرسالة العادي الذي يتوافق مع هذا التعليق التوضيحي.
حقل الدمج metadata بيانات وصفية إضافية حول التعليق التوضيحي يمكن أن تكون metadata إحدى القيم التالية فقط:
user_mention	UserMentionMetadata البيانات الوصفية لإشارة المستخدم
slash_command	SlashCommandMetadata البيانات الوصفية لأمر يبدأ بشرطة مائلة
rich_link_metadata	RichLinkMetadata تمثّل هذه السمة البيانات الوصفية الخاصة برابط تفاعلي.
custom_emoji_metadata	CustomEmojiMetadata البيانات الوصفية لرمز إيموجي مخصّص

AnnotationType

نوع التعليق التوضيحي

عمليات التعداد
ANNOTATION_TYPE_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
USER_MENTION	تمت الإشارة إلى مستخدم.
SLASH_COMMAND	يتم استدعاء أمر يبدأ بشرطة مائلة.
RICH_LINK	تعليق توضيحي لرابط تفاعلي
CUSTOM_EMOJI	تعليق توضيحي لرمز إيموجي مخصّص

AppCommandMetadata

البيانات الوصفية حول أمر تطبيق Chat

الحقول
app_command_id	int32 معرّف الأمر المحدّد في إعدادات Chat API
app_command_type	AppCommandType نوع أمر تطبيق Chat.

AppCommandType

نوع أمر تطبيق Chat. لمزيد من التفاصيل، يُرجى الاطّلاع على أنواع أوامر تطبيقات Chat.

عمليات التعداد
APP_COMMAND_TYPE_UNSPECIFIED	القيمة التلقائية غير محدد
SLASH_COMMAND	أمر يبدأ بشرطة مائلة يرسل المستخدم الأمر في رسالة Chat.
QUICK_COMMAND	طلب سريع يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسالة.

AttachedGif

صورة 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 النتائج فقط. عنوان URL الخاص بالصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق للمستخدم. يجب ألا تستخدم تطبيقات المحادثة عنوان URL هذا لتنزيل محتوى المرفقات.
download_uri	string النتائج فقط. عنوان URL للتنزيل الذي يجب استخدامه للسماح لمستخدم بشري بتنزيل المرفق يجب ألا تستخدم تطبيقات المحادثة عنوان URL هذا لتنزيل محتوى المرفقات.
source	Source النتائج فقط. مصدر المرفق
حقل الدمج data_ref مرجع البيانات إلى المرفق. يمكن أن تكون data_ref إحدى القيم التالية فقط:
attachment_data_ref	AttachmentDataRef اختياريّ. مرجع إلى بيانات المرفق. يُستخدَم هذا الحقل لإنشاء الرسائل أو تعديلها مع المرفقات، أو مع Media API لتنزيل بيانات المرفقات.
drive_data_ref	DriveDataRef النتائج فقط. مرجع إلى المرفق في Google Drive يُستخدَم هذا الحقل مع Google Drive API.

المصدر

مصدر المرفق

عمليات التعداد
SOURCE_UNSPECIFIED	محجوز
DRIVE_FILE	الملف هو ملف Google Drive.
UPLOADED_CONTENT	يتم تحميل الملف إلى Chat.

AttachmentDataRef

مرجع إلى بيانات المرفق.

الحقول
resource_name	string اختياريّ. اسم مصدر بيانات المرفق يُستخدَم هذا الحقل مع واجهة برمجة تطبيقات الوسائط لتنزيل بيانات المرفقات.
attachment_upload_token	string اختياريّ. رمز مميّز غير شفاف يحتوي على مرجع إلى مرفق تم تحميله. يتم التعامل معها من قِبل العملاء كسلسلة غير شفافة، ويتم استخدامها لإنشاء رسائل Chat أو تعديلها مع المرفقات.

CalendarEventLinkData

بيانات روابط الأحداث في "تقويم Google"

الحقول
calendar_id	string معرّف التقويم المرتبط.
event_id	string معرّف الحدث لحدث التقويم المرتبط

CardWithId

بطاقة في رسالة Google Chat

يمكن لتطبيقات Chat فقط إنشاء بطاقات. إذا كان تطبيق Chat يصادق على هوية المستخدم، لا يمكن أن تحتوي الرسالة على بطاقات.

تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات"

فتح "أداة إنشاء البطاقات"

الحقول
card_id	string هذه السمة مطلوبة إذا كانت الرسالة تحتوي على بطاقات متعددة. معرّف فريد لبطاقة في رسالة.
card	Card بطاقة. الحد الأقصى للحجم هو 32 كيلوبايت.

ChatSpaceLinkData

بيانات روابط مساحات Chat

الحقول
space	string مساحة مورد مساحة Chat المرتبطة التنسيق: spaces/{space}
thread	string سلسلة محادثات مورد مساحة Chat المرتبطة التنسيق: spaces/{space}/threads/{thread}
message	string رسالة مورد مساحة Chat المرتبطة التنسيق: 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 Chat.

الحقول
action_label	string كان يتم عرض التصنيف في عنصر قائمة الإجراءات.
on_click	OnClick الإجراء الذي يتم تنفيذه عند النقر على عنصر الإجراء هذا.

CardHeader

الحقول
title	string يجب تحديد العنوان. يبلغ ارتفاع العنوان قيمة ثابتة: إذا تم تحديد كل من العنوان والعنوان الفرعي، سيشغل كل منهما سطرًا واحدًا. إذا تم تحديد العنوان فقط، سيشغل كلا السطرين.
subtitle	string تمثّل هذه السمة العنوان الفرعي لعنوان البطاقة.
image_style	ImageStyle نوع الصورة (على سبيل المثال، حدود مربّعة أو حدود دائرية)
image_url	string عنوان URL الخاص بالصورة في عنوان البطاقة

ImageStyle

عمليات التعداد
IMAGE_STYLE_UNSPECIFIED
IMAGE	حدود مربّعة
AVATAR	حدود دائرية

القسم

يحتوي القسم على مجموعة من الأدوات التي يتم عرضها (عموديًا) بالترتيب المحدّد. في جميع المنصات، تكون البطاقات ذات عرض ثابت ضيق، لذا لا حاجة حاليًا إلى خصائص التنسيق (مثل، float).

الحقول
header	string تمثّل هذه السمة عنوان القسم. يمكن استخدام النص المنسَّق. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".
widgets[]	WidgetMarkup يجب أن يحتوي القسم على أداة واحدة على الأقل.

CreateCustomEmojiRequest

طلب لإنشاء رمز إيموجي مخصّص

الحقول
custom_emoji	CustomEmoji مطلوب. رمز الإيموجي المخصّص الذي تريد إنشاءه

CreateMembershipRequest

رسالة طلب إنشاء عضوية

الحقول
parent	string مطلوب. تمثّل هذه السمة الاسم الكامل للمساحة التي سيتم إنشاء العضوية فيها. التنسيق: spaces/{space}
membership	Membership مطلوب. تمثّل هذه السمة علاقة العضوية التي سيتم إنشاؤها. يجب أن يحتوي الحقل memberType على مستخدم تم ملء الحقلَين user.name وuser.type الخاصين به. سيحدّد الخادم اسم مورد وسيتجاهل أي اسم تم تحديده. عندما ينشئ تطبيق Chat علاقة عضوية لمستخدم بشري، يجب أن يستخدم نطاقات تفويض معيّنة ويضبط قيمًا محدّدة لحقول معيّنة: عند المصادقة كمستخدم، يكون نطاق إذن chat.memberships مطلوبًا. عند المصادقة كتطبيق، يجب توفير نطاق ترخيص chat.app.memberships. اضبط user.type على HUMAN، واضبط user.name بالتنسيق users/{user}، حيث يمكن أن يكون {user} عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن يكون {user} أيضًا id الشخص من People API، أو id للمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف ملف المستخدم [e-mail] في People API هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/[e-mail] أو users/123456789. تتطلّب دعوة مستخدمين من خارج مؤسسة Workspace التي تمتلك المساحة مصادقة المستخدم. عندما ينشئ تطبيق Chat علاقة عضوية لنفسه، يجب أن يصادق على هويته كمستخدم وأن يستخدم النطاق chat.memberships.app، ويضبط user.type على BOT، ويضبط user.name على users/app.
use_admin_access	bool اختياريّ. عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم. يجب أن يكون المستخدم الذي يجري المكالمة مشرفًا في Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب ذلك chat.admin.memberships نطاق OAuth 2.0. لا تتوفّر إمكانية إنشاء عضويات في التطبيقات أو إنشاء عضويات للمستخدمين خارج مؤسسة Google Workspace الخاصة بالمشرف باستخدام إذن الوصول كمشرف.

CreateMessageRequest

تنشئ هذه الطريقة رسالة.

الحقول
parent	string مطلوب. اسم المورد للمساحة التي سيتم إنشاء الرسالة فيها. التنسيق: spaces/{space}
message	Message مطلوب. نص الرسالة
thread_key (deprecated)	string تم إيقاف هذا العنصر نهائيًا. اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة thread.thread_key بدلاً منها. معرّف سلسلة المحادثات يمكن أن يتضمّن ما يصل إلى 4,000 حرف. لبدء سلسلة محادثات أو إضافة رسالة إليها، أنشئ رسالة وحدِّد threadKey أو thread.name. للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها.
request_id	string اختياريّ. معرّف طلب فريد لهذه الرسالة. يؤدي تحديد رقم تعريف طلب حالي إلى عرض الرسالة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء رسالة جديدة.
message_reply_option	MessageReplyOption اختياريّ. تحدّد هذه السمة ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة. عند الردّ على تفاعلات المستخدمين، يتم تجاهل هذا الحقل. بالنسبة إلى التفاعلات ضمن سلسلة محادثات، يتم إنشاء الرد في سلسلة المحادثات نفسها. بخلاف ذلك، يتم إنشاء الرد كسلسلة محادثات جديدة.
message_id	string اختياريّ. معرّف مخصّص للرسالة. تتيح تطبيقات Lets Chat الحصول على رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين المعرّف الذي يحدّده النظام في اسم مورد الرسالة (الممثّل في حقل الرسالة name). يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية: يبدأ بـ "client-". على سبيل المثال، client-custom-name هو معرّف مخصّص صالح، ولكن custom-name ليس كذلك. يحتوي على ما يصل إلى 63 حرفًا وأحرف صغيرة وأرقامًا وواصلات فقط. أن يكون فريدًا ضمن مساحة لا يمكن لتطبيق Chat استخدام المعرّف المخصّص نفسه لرسائل مختلفة. لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة.

MessageReplyOption

تحدّد هذه السمة كيفية الردّ على رسالة. قد تتم إضافة المزيد من الولايات في المستقبل.

عمليات التعداد
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 على "صحيح". إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب استخدام displayName مختلف. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. يتم تحديد المساحة name على الخادم، لذا سيتم تجاهل أي شيء محدّد في هذا الحقل.
request_id	string اختياريّ. معرّف فريد لهذا الطلب. يُنصح باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد معرّف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض خطأ.

CustomEmoji

يمثّل هذا النوع رمز إيموجي مخصّصًا.

الحقول
name	string المعرّف اسم مصدر الإيموجي المخصّص، الذي يحدّده الخادم التنسيق: customEmojis/{customEmoji}
uid	string النتائج فقط. مفتاح فريد لمورد رموز الإيموجي المخصّصة.
emoji_name	string اختياريّ. غير قابل للتغيير اسم الإيموجي المخصّص الذي يقدّمه المستخدم، وهو اسم فريد داخل المؤسسة. هذه السمة مطلوبة عند إنشاء رمز الإيموجي المخصّص، ويتم عرضها فقط في الحالات الأخرى. يجب أن تبدأ أسماء الرموز التعبيرية وتنتهي بعلامة النقطتين الرأسيتين، ويجب أن تكون بأحرف صغيرة ويمكن أن تحتوي فقط على أحرف أبجدية رقمية وواصلات وشرطات سفلية. يجب استخدام الواصلات والشرطات السفلية لفصل الكلمات ولا يمكن استخدامها بشكل متتابع. مثلاً: :valid-emoji-name:
temporary_image_uri	string النتائج فقط. عنوان URL مؤقت للصورة الخاصة برمز الإيموجي المخصّص، ويكون صالحًا لمدة 10 دقائق على الأقل. يُرجى العِلم أنّه لا تتم تعبئة هذا الحقل في الرد عند إنشاء رمز الإيموجي المخصّص.
payload	CustomEmojiPayload اختياريّ. الإدخال فقط بيانات الحمولة مطلوب عند إنشاء رمز الإيموجي المخصّص.

CustomEmojiPayload

بيانات الحمولة لرمز الإيموجي المخصّص

الحقول
file_content	bytes مطلوب. الإدخال فقط الصورة المستخدَمة لرمز الإيموجي المخصّص يجب أن يكون حجم الحمولة أقل من 256 كيلوبايت وأن يكون حجم الصورة مربعًا ويتراوح بين 64 و500 بكسل. هذه القيود قابلة للتغيير.
filename	string مطلوب. الإدخال فقط اسم ملف الصورة امتدادات الملفات المتوافقة: .png و.jpg و.gif

CustomEmojiMetadata

البيانات الوصفية للتعليقات التوضيحية لرموز الإيموجي المخصّصة

الحقول
custom_emoji	CustomEmoji رمز الإيموجي المخصّص

DeleteCustomEmojiRequest

طلب حذف رمز إيموجي مخصّص

الحقول
name	string مطلوب. اسم المورد الخاص بالإيموجي المخصّص المطلوب حذفه. التنسيق: customEmojis/{customEmoji} يمكنك استخدام اسم الإيموجي كاسم مستعار لـ {customEmoji}. على سبيل المثال، customEmojis/:example-emoji: حيث :example-emoji: هو اسم الإيموجي المخصّص.

DeleteMembershipRequest

طلب حذف عضوية في مساحة

الحقول
name	string مطلوب. اسم المورد الخاص بالاشتراك المطلوب حذفه. يمكن لتطبيقات المحادثة حذف عضويات المستخدمين أو عضوياتها. لا يمكن لتطبيقات المحادثة حذف اشتراكات التطبيقات الأخرى. عند حذف عضوية مستخدم، يجب توفُّر نطاق chat.memberships مع مصادقة المستخدم أو نطاق chat.memberships.app مع مصادقة التطبيق وتنسيق spaces/{space}/members/{member}. يمكنك استخدام عنوان البريد الإلكتروني كاسم مستعار لـ {member}. على سبيل المثال، spaces/{space}/members/[e-mail] حيث [e-mail] هو البريد الإلكتروني لمستخدم Google Chat. عند حذف عضوية في تطبيق، يجب استخدام النطاق 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، إذا كانت الرسالة تتضمّن ردودًا في سلسلة محادثات، يتعذّر حذفها. لا ينطبق هذا الإعداد إلا عند المصادقة كمستخدم. ليس له أي تأثير عند المصادقة كتطبيق Chat.

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.

DeletionMetadata

معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط delete_time.

الحقول
deletion_type	DeletionType تشير إلى المستخدم الذي حذف الرسالة.

DeletionType

مَن حذف الرسالة وكيف تم حذفها قد تتم إضافة المزيد من القيم في المستقبل. اطّلِع على مقالة تعديل رسالة أو حذفها في Google Chat للحصول على تفاصيل حول الحالات التي يمكن فيها حذف الرسائل.

عمليات التعداد
DELETION_TYPE_UNSPECIFIED	هذه القيمة غير مستخدَمة.
CREATOR	حذف المستخدم رسالته.
SPACE_OWNER	حذَف مدير المساحة الرسالة.
ADMIN	حذف مشرف Google Workspace الرسالة. يمكن للمشرفين حذف أي رسالة في المساحة، بما في ذلك الرسائل المرسَلة من أي عضو في المساحة أو تطبيق Chat.
APP_MESSAGE_EXPIRY	حذف تطبيق Chat رسالته الخاصة عند انتهاء صلاحيتها.
CREATOR_VIA_APP	حذف تطبيق Chat الرسالة نيابةً عن المنشئ (باستخدام مصادقة المستخدم).
SPACE_OWNER_VIA_APP	حذف تطبيق Chat الرسالة نيابةً عن مدير المساحة (باستخدام مصادقة المستخدم).
SPACE_MEMBER	حذف أحد أعضاء المساحة الرسالة. يمكن للمستخدمين حذف الرسائل التي ترسلها التطبيقات.

مربّع حوار

البرنامج المغلِّف حول نص بطاقة مربّع الحوار

الحقول
body	Card الإدخال فقط نص مربع الحوار الذي يتم عرضه في نافذة مشروطة لا تتوافق تطبيقات Google Chat مع عناصر البطاقات التالية: DateTimePicker وOnChangeAction.

DialogAction

يحتوي على مربّع حوار ورمز حالة الطلب.

الحقول
action_status	ActionStatus الإدخال فقط حالة طلب استدعاء مربّع حوار أو إرساله. تعرِض هذه السمة حالة ورسالة للمستخدمين، إذا لزم الأمر. على سبيل المثال، في حال حدوث خطأ أو نجاح.
حقل الدمج action الإجراء المطلوب تنفيذه يمكن أن تكون action إحدى القيم التالية فقط:
dialog	Dialog الإدخال فقط مربّع الحوار الخاص بالطلب

DriveDataRef

مرجع إلى بيانات مرفق في Drive

الحقول
drive_file_id	string رقم تعريف ملف Drive الاستخدام مع 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 Chat.

GetAttachmentRequest

طلب الحصول على مرفق

الحقول
name	string مطلوب. اسم المورد للمرفق، بالتنسيق spaces/{space}/messages/{message}/attachments/{attachment}

GetCustomEmojiRequest

طلب لعرض رمز إيموجي مخصّص واحد.

الحقول
name	string مطلوب. اسم المورد الخاص برمز الإيموجي المخصّص التنسيق: customEmojis/{customEmoji} يمكنك استخدام اسم الإيموجي كاسم مستعار لـ {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 Chat.
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

طلب رسالة للحصول على إعدادات إشعارات المساحة يتيح هذا الإجراء الحصول على إعدادات الإشعارات للمستخدم الذي يجري المكالمة فقط.

الحقول
name	string مطلوب. التنسيق: users/{user}/spaces/{space}/spaceNotificationSetting users/me/spaces/{space}/spaceNotificationSetting، أو users/[e-mail]/spaces/{space}/spaceNotificationSetting، أو users/123456789/spaces/{space}/spaceNotificationSetting. ملاحظة: يُسمح فقط بمعرّف المستخدم أو البريد الإلكتروني للمتصل في المسار.

GetSpaceReadStateRequest

رسالة الطلب لواجهة برمجة التطبيقات GetSpaceReadState

الحقول

name

string مطلوب. تمثّل هذه السمة اسم المورد لحالة القراءة في المساحة التي سيتم استردادها. يتيح هذا الإذن الحصول على حالة القراءة للمستخدم الذي يجري المكالمة فقط. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارات التالية: الاسم المستعار me مثلاً: users/me/spaces/{space}/spaceReadState عنوان بريدهم الإلكتروني على Workspace مثلاً: users/[e-mail]/spaces/{space}/spaceReadState رقم تعريف المستخدم مثلاً: users/123456789/spaces/{space}/spaceReadState التنسيق: users/{user}/spaces/{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

الحقول

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 Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

مجموعة

مجموعة Google في Google Chat

الحقول
name	string اسم المورد لمجموعة Google تمثّل هذه السمة مجموعة في Cloud Identity Groups API. التنسيق: groups/{group}

HistoryState

حالة السجلّ للرسائل والمساحات تحدّد هذه السمة مدة الاحتفاظ بالرسائل وسلاسل المحادثات بعد إنشائها.

عمليات التعداد
HISTORY_STATE_UNSPECIFIED	القيمة التلقائية لا تستخدم هذه السمة.
HISTORY_OFF	السجلّ غير مفعَّل. يتم الاحتفاظ بالرسائل وسلاسل المحادثات لمدة 24 ساعة.
HISTORY_ON	السجلّ مفعَّل. تحدّد قواعد الاحتفاظ بالبيانات في Vault في المؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات.

ListCustomEmojisRequest

طلب لعرض قائمة برموز إيموجي مخصّصة

الحقول
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

ردّ لعرض رموز الإيموجي المخصّصة في القائمة

الحقول
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 على "صحيح". سيتم رفض فلاتر أنواع الأعضاء الأخرى. على سبيل المثال، الاستعلامات التالية صالحة: 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 لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب ذلك نطاق OAuth 2.0 chat.admin.memberships.readonly أو chat.admin.memberships. لا تتوفّر إمكانية إدراج عضويات التطبيقات في مساحة عند استخدام إذن الوصول كمشرف.

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). للفلترة حسب نوع المساحة، يجب تحديد قيمة تعداد صالحة، مثل 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 مطابق في رسالة Chat يمكن لتطبيقات المحادثة معاينة عناوين URL المطابقة. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة معاينة الروابط.

الحقول
url	string النتائج فقط. عنوان URL الذي تمت مطابقته.

MeetSpaceLinkData

بيانات روابط مساحة Meet

الحقول
meeting_code	string رمز اجتماع مساحة Meet المرتبطة.
type	Type تشير هذه السمة إلى نوع مساحة Meet.
huddle_status	HuddleStatus اختياريّ. النتائج فقط. إذا كانت اجتماعًا سريعًا، يشير إلى حالة الاجتماع السريع. بخلاف ذلك، يتم إلغاء ضبطها.

HuddleStatus

حالة الاجتماع السريع

عمليات التعداد
HUDDLE_STATUS_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
STARTED	بدأ الاجتماع السريع.
ENDED	انتهى الاجتماع السريع. في هذه الحالة، لن يكون معرّف الموارد المنتظم (URI) والمعرّفات لمساحة Meet صالحَين.
MISSED	فاتتك مكالمة Huddle. في هذه الحالة، لن يكون معرّف الموارد المنتظم (URI) والمعرّفات لمساحة Meet صالحَين.

النوع

نوع مساحة Meet

عمليات التعداد
TYPE_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
MEETING	مساحة Meet هي اجتماع.
HUDDLE	مساحة Meet هي اجتماع سريع.

العضوية

تمثّل هذه السمة علاقة العضوية في Google Chat، مثل ما إذا تمت دعوة مستخدم أو تطبيق Chat إلى مساحة أو كان جزءًا منها أو غير متوفّر فيها.

الحقول
name	string المعرّف تمثّل هذه السمة اسم المورد الخاص بالاشتراك، والذي يحدّده الخادم. التنسيق: spaces/{space}/members/{member}
state	MembershipState النتائج فقط. حالة الاشتراك
role	MembershipRole اختياريّ. دور المستخدم في مساحة Chat، والذي يحدّد الإجراءات المسموح له بتنفيذها في المساحة لا يمكن استخدام هذا الحقل كإدخال إلا في UpdateMembership.
create_time	Timestamp اختياريّ. غير قابل للتغيير وقت إنشاء العضوية، مثل وقت انضمام عضو إلى مساحة أو تلقّيه دعوة للانضمام إليها هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه لاستيراد العضويات السابقة في مساحات وضع الاستيراد.
delete_time	Timestamp اختياريّ. غير قابل للتغيير وقت حذف العضوية، مثلاً عندما غادر عضو مساحة أو تمت إزالته منها هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه لاستيراد العضويات السابقة في مساحات وضع الاستيراد.
حقل الدمج memberType تمثّل هذه السمة العضو المرتبط بهذه العضوية. قد تتوفّر أنواع أخرى من الأعضاء في المستقبل. يمكن أن تكون memberType إحدى القيم التالية فقط:
member	User اختياريّ. مستخدم Google Chat أو تطبيق Google Chat الذي يتوافق معه الاشتراك إذا كان تطبيق Chat يصادق كمستخدم، ستملأ النتيجة المستخدم name وtype.
group_member	Group اختياريّ. مجموعة Google التي تتوافق مع العضوية تتطلّب قراءة العضويات في "مجموعات Google" أو تعديلها مصادقة المستخدم.

MembershipRole

تمثّل هذه السمة الإجراءات المسموح بها للمستخدم في مساحة Chat. قد تتم إضافة المزيد من قيم التعداد في المستقبل.

عمليات التعداد
MEMBERSHIP_ROLE_UNSPECIFIED	القيمة التلقائية بالنسبة إلى users: هذا المستخدم ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى Google Groups: يتم دائمًا تعيين هذا الدور لهم (قد يتم استخدام قيم تعداد أخرى في المستقبل).
ROLE_MEMBER	عضو في المساحة لدى المستخدم أذونات أساسية، مثل إرسال رسائل إلى المساحة. في المحادثات الفردية والمحادثات الجماعية بدون اسم، يتم منح هذا الدور لجميع المشاركين.
ROLE_MANAGER	مدير مساحة لدى المستخدم جميع الأذونات الأساسية بالإضافة إلى أذونات المشرف التي تتيح له إدارة المساحة، مثل إضافة أعضاء أو إزالتهم. تتوفّر هذه الميزة في SpaceType.SPACE فقط.

MembershipState

تحدّد هذه السمة علاقة العضو بالمساحة. قد نتيح استخدام هذه الميزة في بلدان أخرى في المستقبل.

عمليات التعداد
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 Chat

الحقول
name	string المعرّف اسم المورد الخاص بالرسالة التنسيق: spaces/{space}/messages/{message} حيث {space} هو رقم تعريف المساحة التي تتم مشاركة الرسالة فيها، و{message} هو رقم تعريف الرسالة الذي يحدّده النظام. على سبيل المثال، spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB. إذا ضبطت معرّفًا مخصّصًا عند إنشاء رسالة، يمكنك استخدام هذا المعرّف لتحديد الرسالة في طلب من خلال استبدال {message} بالقيمة من الحقل clientAssignedMessageId. على سبيل المثال، spaces/AAAAAAAAAAA/messages/client-custom-name. لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة.
sender	User النتائج فقط. المستخدم الذي أنشأ الرسالة إذا كان تطبيق Chat يصادق كمستخدم، ستملأ النتيجة المستخدم name وtype.
create_time	Timestamp اختياريّ. غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يشير هذا الحقل إلى الوقت الذي تم فيه إنشاء الرسالة. هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه في مساحات وضع الاستيراد. بالنسبة إلى المساحات في وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني السابق الذي تم فيه إنشاء الرسالة في المصدر من أجل الحفاظ على وقت الإنشاء الأصلي.
last_update_time	Timestamp النتائج فقط. الوقت الذي عدّل فيه أحد المستخدمين الرسالة آخر مرة إذا لم يتم تعديل الرسالة مطلقًا، سيكون هذا الحقل فارغًا.
delete_time	Timestamp النتائج فقط. الوقت الذي تم فيه حذف الرسالة في Google Chat إذا لم يتم حذف الرسالة مطلقًا، يكون هذا الحقل فارغًا.
text	string اختياريّ. نص الرسالة العادي يؤدي الرابط الأول إلى صورة أو فيديو أو صفحة ويب إلى إنشاء شريحة معاينة. يمكنك أيضًا الإشارة إلى مستخدم Google Chat باستخدام@ أو الإشارة إلى جميع المستخدمين في المساحة. لمعرفة المزيد عن إنشاء الرسائل النصية، يُرجى الاطّلاع على إرسال رسالة.
formatted_text	string النتائج فقط. يحتوي على الرسالة text مع إضافة علامات لتحديد التنسيق. قد لا يتضمّن هذا الحقل كل التنسيق المرئي في واجهة المستخدم، ولكنّه يشمل ما يلي: بنية الترميز للخط الغامق والمائل والمشطوب والمسافة الثابتة وكتلة المسافة الثابتة والقائمة النقطية إشارات المستخدمين بالتنسيق <users/{user}> روابط تشعّبية مخصّصة تستخدم التنسيق <{url}|{rendered_text}> حيث يكون السلسلة الأولى هي عنوان URL والثانية هي النص المعروض، مثلاً <http://example.com|custom text>. رموز إيموجي مخصّصة باستخدام التنسيق :{emoji_name}:، مثل :smile: لا ينطبق ذلك على رموز الإيموجي بتنسيق Unicode، مثل U+1F600 لوجه مبتسم. لمزيد من المعلومات، يُرجى الاطّلاع على عرض تنسيق النص المُرسَل في رسالة.
cards[] (deprecated)	Card تم إيقاف هذا العنصر نهائيًا. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة cards_v2 بدلاً منها. بطاقات منسَّقة وتفاعلية وغنية بالتفاصيل يمكنك استخدامها لعرض عناصر واجهة المستخدم، مثل النصوص المنسَّقة والأزرار والصور القابلة للنقر يتم عادةً عرض البطاقات أسفل نص الرسالة العادي. يمكن أن يصل حجم cards وcards_v2 إلى 32 كيلوبايت كحد أقصى.
cards_v2[]	CardWithId اختياريّ. صفيف من البطاقات يمكن لتطبيقات Chat فقط إنشاء بطاقات. إذا كان تطبيق Chat يصادق على المستخدم، لا يمكن أن تحتوي الرسائل على بطاقات. للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، اطّلِع على إرسال رسالة. تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات" فتح "أداة إنشاء البطاقات"
annotations[]	Annotation النتائج فقط. يمكن ربط التعليقات التوضيحية بنص الرسالة العادي أو بالشرائح التي تتضمّن روابط تؤدي إلى مراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google" مع start_index وlength بقيمة 0.
thread	Thread سلسلة المحادثات التي تنتمي إليها الرسالة للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها.
space	Space النتائج فقط. إذا كان تطبيق Chat يصادق كمستخدم، لن يتم ملء الإخراج إلا في المساحة name.
fallback_text	string اختياريّ. وصف بنص عادي لبطاقات الرسالة، ويُستخدم عندما يتعذّر عرض البطاقات الفعلية، مثل الإشعارات على الأجهزة الجوّالة.
action_response	ActionResponse الإدخال فقط المَعلمات التي يمكن أن يستخدمها تطبيق Chat لتحديد طريقة نشر الرد.
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. لتضمين هذا الحقل في طلبك، عليك طلب بيانات من Chat API باستخدام مصادقة التطبيق وحذف ما يلي: المرفقات أدوات الملحقات لمزيد من التفاصيل، يُرجى الاطّلاع على إرسال رسالة بشكل خاص.
deletion_metadata	DeletionMetadata النتائج فقط. معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط delete_time.
quoted_message_metadata	QuotedMessageMetadata النتائج فقط. معلومات حول رسالة اقتبسها مستخدم Google Chat في مساحة يمكن لمستخدمي Google Chat اقتباس رسالة للردّ عليها.
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 التفاعل الجديد

ReactionDeletedEventData

حمولة الحدث لتفاعل محذوف

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

الحقول
reaction	Reaction التفاعل المحذوف

RichLinkMetadata

رابط غني بصريًا يؤدي إلى مرجع يمكن ربط الروابط المنسّقة بنص الرسالة العادي أو تمثيلها على شكل شرائح مرتبطة بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع start_index وlength بقيمة 0.

الحقول
uri	string معرّف الموارد المنتظم (URI) لهذا الرابط.
rich_link_type	RichLinkType نوع الرابط الغني بصريًا.
حقل الدمج data بيانات المرجع المرتبط يمكن أن تكون data إحدى القيم التالية فقط:
drive_link_data	DriveLinkData بيانات لرابط في Drive
chat_space_link_data	ChatSpaceLinkData بيانات رابط مساحة Chat
meet_space_link_data	MeetSpaceLinkData بيانات رابط مساحة Meet
calendar_event_link_data	CalendarEventLinkData تمثّل هذه السمة بيانات رابط حدث في "تقويم Google".

RichLinkType

نوع الرابط الغني بصريًا. وقد تتم إضافة المزيد من الأنواع في المستقبل.

عمليات التعداد
RICH_LINK_TYPE_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
DRIVE_FILE	نوع رابط غني في Google Drive
CHAT_SPACE	نوع رابط غني بصريًا لمساحة Chat على سبيل المثال، شريحة ذكية لمساحة.
MEET_SPACE	نوع رابط غني بصريًا لرسالة Meet على سبيل المثال، شريحة Meet
CALENDAR_EVENT	نوع رابط غني بصريًا لرسالة في "تقويم Google" على سبيل المثال، شريحة "تقويم Google".

SearchSpacesRequest

طلب البحث عن قائمة بالمساحات استنادًا إلى طلب بحث

الحقول
use_admin_access	bool عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم. يجب أن يكون المستخدم الذي يجري المكالمة مشرفًا في Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب ذلك نطاق OAuth 2.0 chat.admin.spaces.readonly أو chat.admin.spaces. لا تتيح هذه الطريقة حاليًا سوى الوصول الإداري، وبالتالي لا يتم قبول سوى 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_allowed إلا مع عوامل التشغيل OR. يتوافق last_active_time وcreate_time مع عاملَي التشغيل AND وOR. لا يمكن استخدام AND إلا لتمثيل فاصل زمني، مثل last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00". طلبات البحث التالية صالحة: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by	string اختياريّ. كيفية ترتيب قائمة المساحات في ما يلي السمات المتوافقة التي يمكن ترتيب النتائج حسبها: membership_count.joined_direct_human_user_count: يشير إلى عدد المستخدمين من البشر الذين انضموا مباشرةً إلى مساحة. last_active_time: يشير إلى الوقت الذي تمت فيه إضافة آخر عنصر مؤهَّل إلى أي موضوع في هذه المساحة. create_time: يشير إلى وقت إنشاء المساحة. في ما يلي قيم عملية الترتيب الصالحة: ASC للترتيب التصاعدي القيمة التلقائية DESC للترتيب التنازلي بناء الجملة المتوافق هو: membership_count.joined_direct_human_user_count DESC membership_count.joined_direct_human_user_count ASC last_active_time DESC last_active_time ASC create_time DESC create_time ASC

SearchSpacesResponse

ردّ يتضمّن قائمة بالمساحات التي تتطابق مع طلب البحث عن المساحات

الحقول
spaces[]	Space صفحة المساحات المطلوبة
next_page_token	string رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، يعني ذلك أنّه لا توجد صفحات لاحقة.
total_size	int32 إجمالي عدد المساحات التي تتطابق مع طلب البحث، على مستوى جميع الصفحات إذا كانت النتيجة تتضمّن أكثر من 10,000 مساحة، تكون هذه القيمة تقديرية.

SetUpSpaceRequest

طلب إنشاء مساحة وإضافة مستخدمين محدّدين إليها

الحقول
space	Space مطلوب. يجب ملء حقل Space.spaceType. لإنشاء مساحة، اضبط Space.spaceType على SPACE واضبط Space.displayName. إذا تلقّيت رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب displayName مختلفًا. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. لإنشاء محادثة جماعية، اضبط Space.spaceType على GROUP_CHAT. لا تضبط Space.displayName. لإنشاء محادثة فردية بين مستخدمَين، اضبط قيمة Space.spaceType على DIRECT_MESSAGE وقيمة Space.singleUserBotDm على false. لا تضبط Space.displayName أو Space.spaceDetails. لإنشاء محادثة فردية بين مستخدم بشري وتطبيق Chat للمكالمات، اضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm على true. لا تضبط Space.displayName أو Space.spaceDetails. إذا كانت مساحة DIRECT_MESSAGE متوفّرة، سيتم عرضها بدلاً من إنشاء مساحة جديدة.
request_id	string اختياريّ. معرّف فريد لهذا الطلب. يُنصح باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد معرّف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض خطأ.
memberships[]	Membership اختياريّ. مستخدمو Google Chat أو المجموعات التي تريد دعوتها للانضمام إلى المساحة لا تُدرِج المستخدم الذي يجري المكالمة، لأنّه تتم إضافته تلقائيًا. تسمح المجموعة حاليًا بما يصل إلى 49 عضوًا (بالإضافة إلى المتصل). بالنسبة إلى عضوية الإنسان، يجب أن يحتوي الحقل Membership.member على user مع ملء name (التنسيق: users/{user}) وضبط type على User.Type.HUMAN. يمكنك إضافة مستخدمين حقيقيين فقط عند إعداد مساحة (لا تتوفّر إضافة تطبيقات Chat إلا عند إعداد الرسائل المباشرة باستخدام تطبيق الاتصال). يمكنك أيضًا إضافة أعضاء باستخدام عنوان البريد الإلكتروني للمستخدم كاسم مستعار لـ {user}. على سبيل المثال، يمكن أن يكون user.name هو users/[e-mail]. لدعوة مستخدمي Gmail أو مستخدمين من نطاقات Google Workspace خارجية، يجب استخدام عنوان البريد الإلكتروني للمستخدم في {user}. بالنسبة إلى عضوية مجموعة Google، يجب أن يحتوي الحقل Membership.group_member على group مع تعبئة name (التنسيق groups/{group}). لا يمكنك إضافة مجموعات Google إلا عند ضبط Space.spaceType على SPACE. اختيارية عند ضبط Space.spaceType على SPACE هذه السمة مطلوبة عند ضبط قيمة Space.spaceType على GROUP_CHAT، بالإضافة إلى اشتراكَين على الأقل. يجب توفُّرها عند ضبط Space.spaceType على DIRECT_MESSAGE مع مستخدم بشري، بالإضافة إلى اشتراك واحد فقط. يجب أن يكون فارغًا عند إنشاء محادثة فردية بين مستخدم بشري وتطبيق Chat للمكالمات (عند ضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm على true).

SlashCommand

بيانات وصفية حول أمر يبدأ بشرطة مائلة في Google Chat

الحقول
command_id	int64 معرّف الأمر الذي يبدأ بشرطة مائلة

SlashCommandMetadata

البيانات الوصفية للتعليقات التوضيحية للأوامر التي تبدأ بشرطة مائلة (/).

الحقول
bot	User تطبيق Chat الذي تم استدعاء الأمر منه
type	Type نوع الأمر الذي يبدأ بشرطة مائلة
command_name	string اسم أمر الشرطة المائلة الذي تم استدعاؤه.
command_id	int64 معرّف الأمر الذي تم استدعاؤه.
triggers_dialog	bool تشير إلى ما إذا كان الأمر الذي يبدأ بشرطة مائلة مخصّصًا لمربّع حوار.

النوع

عمليات التعداد
TYPE_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
ADD	أضِف تطبيق Chat إلى المساحة.
INVOKE	استدعاء أمر يبدأ بشرطة مائلة في مساحة

مسافة

مساحة في Google Chat المساحات هي محادثات بين مستخدمَين أو أكثر أو رسائل مباشرة بين مستخدم وتطبيق Chat.

الحقول
name	string المعرّف اسم المورد الخاص بالمساحة التنسيق: spaces/{space} حيث يمثّل {space} المعرّف الذي يحدّده النظام للمساحة. يمكنك الحصول على رقم تعريف المساحة من خلال استدعاء الطريقة spaces.list() أو من عنوان URL الخاص بالمساحة. على سبيل المثال، إذا كان عنوان URL للمساحة هو https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA، سيكون رقم تعريف المساحة هو AAAAAAAAA.
type (deprecated)	Type تم إيقاف هذا العنصر نهائيًا. النتائج فقط. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة space_type بدلاً منها. نوع المساحة
space_type	SpaceType اختياريّ. نوع المساحة يجب توفير هذه السمة عند إنشاء مساحة أو تعديل نوعها. النتائج فقط للاستخدامات الأخرى.
single_user_bot_dm	bool اختياريّ. تُستخدَم لتحديد ما إذا كانت المساحة عبارة عن رسالة مباشرة بين تطبيق Chat ومستخدم واحد.
threaded (deprecated)	bool تم إيقاف هذا العنصر نهائيًا. النتائج فقط. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة spaceThreadingState بدلاً منها. ما إذا كانت الرسائل منظَّمة في سلاسل محادثات في هذه المساحة
display_name	string اختياريّ. تمثّل هذه السمة الاسم المعروض للمساحة. يجب إدخالها عند إنشاء مساحة تتضمّن spaceType بقيمة SPACE. إذا تلقّيت رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة أو تعديل displayName، جرِّب استخدام displayName مختلف. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض. بالنسبة إلى الرسائل المباشرة، قد يكون هذا الحقل فارغًا. يمكن أن يتضمّن ما يصل إلى 128 حرفًا.
external_user_allowed	bool اختياريّ. غير قابل للتغيير تحدّد ما إذا كانت هذه المساحة تسمح لأي مستخدم في Google Chat بأن يكون عضوًا فيها. المدخلات عند إنشاء مساحة في مؤسسة Google Workspace يجب حذف هذا الحقل عند إنشاء مساحات في الحالات التالية: يستخدم المستخدم الذي تمّت مصادقته حساب مستهلك (حساب مستخدم غير مُدار). بشكلٍ تلقائي، تسمح المساحة التي يتم إنشاؤها باستخدام حساب مستهلك لأي مستخدم في Google Chat. بالنسبة إلى المساحات الحالية، هذا الحقل هو للنتائج فقط.
space_threading_state	SpaceThreadingState النتائج فقط. حالة سلاسل المحادثات في مساحة Chat
space_details	SpaceDetails اختياريّ. تفاصيل حول المساحة، بما في ذلك الوصف والقواعد
space_history_state	HistoryState اختياريّ. حالة سجلّ الرسائل والردود في هذه المساحة
import_mode	bool اختياريّ. ما إذا تم إنشاء هذه المساحة في Import Mode كجزء من عملية نقل البيانات إلى Google Workspace أثناء استيراد المساحات، لا تظهر للمستخدمين إلى أن يكتمل الاستيراد. يتطلّب إنشاء مساحة في Import Modeمصادقة المستخدم.
create_time	Timestamp اختياريّ. غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يظهر وقت إنشاء المساحة. هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه في مساحات وضع الاستيراد. بالنسبة إلى المساحات في وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني السابق الذي تم إنشاء المساحة فيه في المصدر من أجل الاحتفاظ بوقت الإنشاء الأصلي. تتم تعبئة هذا الحقل في الناتج فقط عندما تكون قيمة spaceType هي GROUP_CHAT أو SPACE.
last_active_time	Timestamp النتائج فقط. الطابع الزمني لآخر رسالة في المساحة.
admin_installed	bool النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة التي تتضمّن تطبيقًا في Chat، سواء أنشأ المشرف على Google Workspace المساحة أم لا يمكن للمشرفين تثبيت تطبيق Chat وإعداد رسالة مباشرة معه نيابةً عن المستخدمين في مؤسستهم. لكي يكون تطبيق Chat متوافقًا مع التثبيت من خلال المشرف، يجب أن يتيح إرسال الرسائل المباشرة.
membership_count	MembershipCount النتائج فقط. عدد العضويات التي تم الانضمام إليها، ويتم تجميعها حسب نوع العضو. تتم تعبئة هذه السمة عندما تكون قيمة space_type هي SPACE أو DIRECT_MESSAGE أو GROUP_CHAT.
access_settings	AccessSettings اختياريّ. تحدّد هذه السمة إعدادات الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE.
space_uri	string النتائج فقط. معرّف URI الذي يمكن للمستخدم استخدامه للوصول إلى المساحة
import_mode_expire_time	Timestamp النتائج فقط. الوقت الذي سيحذف فيه النظام المساحة تلقائيًا إذا بقيت في وضع الاستيراد يجب الخروج من وضع الاستيراد لكل مساحة تم إنشاؤها في هذا الوضع قبل انتهاء وقت الصلاحية باستخدام spaces.completeImport. تتم تعبئة هذا الحقل فقط للمساحات التي تم إنشاؤها باستخدام وضع الاستيراد.
customer	string اختياريّ. غير قابل للتغيير رقم تعريف العميل الخاص بنطاق المساحة. يجب ضبط هذه السمة فقط عند إنشاء مساحة باستخدام مصادقة التطبيق وكانت قيمة SpaceType هي SPACE، وإلا يجب عدم ضبطها. بالتنسيق customers/{customer}، حيث customer هو id من مصدر بيانات العميل في Admin SDK. يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المستعار customers/my_customer لإنشاء المساحة في مؤسسة Google Workspace نفسها التي يتوفّر فيها التطبيق. لا تتم تعبئة هذا الحقل للرسائل المباشرة.
حقل الدمج space_permission_settings تمثّل هذه السمة إعدادات الأذونات الخاصة بمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. يمكن أن تكون space_permission_settings إحدى القيم التالية فقط:
predefined_permission_settings	PredefinedPermissionSettings اختياريّ. الإدخال فقط إعدادات أذونات المساحة المحدّدة مسبقًا، يتم إدخالها فقط عند إنشاء مساحة. في حال عدم ضبط الحقل، يتم إنشاء مساحة تعاون. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل PermissionSettings. يتيح ضبط إعدادات الأذونات المحدّدة مسبقًا ما يلي: مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاقين chat.app.spaces أو chat.app.spaces.create مصادقة المستخدم
permission_settings	PermissionSettings اختياريّ. إعدادات أذونات المساحة للمساحات الحالية إدخال لتعديل إعدادات أذونات المساحة المحدّدة، حيث يتم استبدال إعدادات الأذونات الحالية. تعرض هذه السمة إعدادات الأذونات الحالية. تتيح قراءة إعدادات الأذونات وتعديلها ما يلي: مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاق chat.app.spaces لا تتم تعبئة هذا الحقل ولا يمكن ضبطه إلا عندما ينشئ تطبيق Chat المساحة. مصادقة المستخدم

AccessSettings

تمثّل هذه السمة إعدادات الوصول إلى المساحة.

الحقول
access_state	AccessState النتائج فقط. تشير هذه السمة إلى حالة الوصول إلى المساحة.
audience	string اختياريّ. اسم المورد للجمهور المستهدف الذي يمكنه اكتشاف المساحة والانضمام إليها ومعاينة الرسائل فيها. في حال عدم ضبط هذا الخيار، لن يتمكّن من الوصول إلى المساحة سوى المستخدمين أو "مجموعات Google" الذين تمت دعوتهم أو إضافتهم بشكل فردي إلى المساحة. لمزيد من التفاصيل، يُرجى الاطّلاع على إتاحة اكتشاف مساحة لجمهور مستهدف. التنسيق: audiences/{audience} لاستخدام الجمهور المستهدف التلقائي لمؤسسة Google Workspace، اضبط القيمة على audiences/default. تتيح قراءة الجمهور المستهدَف ما يلي: مصادقة المستخدم مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاق chat.app.spaces لا يتم ملء هذا الحقل عند استخدام النطاق chat.bot مع مصادقة التطبيق. يتطلّب ضبط الجمهور المستهدف مصادقة المستخدم.

AccessState

تمثّل هذه السمة حالة الوصول إلى المساحة.

عمليات التعداد
ACCESS_STATE_UNSPECIFIED	حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه.
PRIVATE	يمكن فقط للمستخدمين أو "مجموعات Google" التي تمت إضافتها أو دعوتها بشكل فردي من قِبل مستخدمين آخرين أو مشرفي Google Workspace العثور على المساحة والوصول إليها.
DISCOVERABLE	منح مدير المساحة جمهورًا مستهدفًا إذن الوصول إلى المساحة. يمكن أيضًا للمستخدمين أو "مجموعات Google" الذين تمت إضافتهم أو دعوتهم بشكل فردي إلى المساحة العثور على المساحة والوصول إليها. لمزيد من المعلومات، يُرجى الاطّلاع على إتاحة مساحة لمستخدمين محدّدين. يتطلّب إنشاء مساحات قابلة للاكتشاف مصادقة المستخدم.

MembershipCount

تمثّل هذه السمة عدد عضويات المساحة، ويتم تجميعها في فئات.

الحقول
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

إعدادات الأذونات المحدّدة مسبقًا التي يمكنك تحديدها فقط عند إنشاء مساحة مُسمّاة قد تتم إضافة المزيد من الإعدادات في المستقبل. للحصول على تفاصيل حول إعدادات الأذونات للمساحات التي تحمل أسماء، يُرجى الاطّلاع على التعرّف على المساحات.

عمليات التعداد
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED	غير محدد لا تستخدِمها.
COLLABORATION_SPACE	إعداد لجعل المساحة مساحة تعاون يمكن لجميع الأعضاء نشر الرسائل فيها
ANNOUNCEMENT_SPACE	إعداد لجعل المساحة مساحة إشعارات يمكن فيها لمدراء المساحة فقط نشر الرسائل

SpaceDetails

تفاصيل حول المساحة، بما في ذلك الوصف والقواعد

الحقول
description	string اختياريّ. تمثّل هذه السمة وصفًا للمساحة. على سبيل المثال، يمكنك وصف موضوع المناقشة في المساحة أو الغرض الوظيفي منها أو المشاركين فيها. يمكن أن يتضمّن ما يصل إلى 150 حرفًا.
guidelines	string اختياريّ. قواعد المساحة وتوقعاتها وآداب التعامل فيها يمكن أن تتضمّن ما يصل إلى 5,000 حرف.

SpaceThreadingState

تحدّد هذه السمة نوع حالة سلاسل المحادثات في مساحة Chat.

عمليات التعداد
SPACE_THREADING_STATE_UNSPECIFIED	محجوز
THREADED_MESSAGES	المساحات المُسمّاة التي تتيح سلاسل المحادثات عندما يرد المستخدمون على رسالة، يمكنهم الردّ في سلسلة المحادثات، ما يحافظ على ردّهم في سياق الرسالة الأصلية.
GROUPED_MESSAGES	مساحات تحمل أسماءً ويتم فيها تنظيم المحادثة حسب الموضوع يتم تجميع المواضيع وردودها معًا.
UNTHREADED_MESSAGES	الرسائل المباشرة بين شخصين والمحادثات الجماعية بين 3 أشخاص أو أكثر

SpaceType

نوع المساحة يجب توفير هذا الإذن عند إنشاء مساحة أو تعديلها. النتائج فقط للاستخدامات الأخرى.

عمليات التعداد
SPACE_TYPE_UNSPECIFIED	محجوز
SPACE	مكان يرسل فيه المستخدمون الرسائل ويشاركون الملفات ويتعاونون. يمكن أن تتضمّن SPACE تطبيقات Chat.
GROUP_CHAT	المحادثات الجماعية بين 3 أشخاص أو أكثر يمكن أن تتضمّن GROUP_CHAT تطبيقات Chat.
DIRECT_MESSAGE	الرسائل بين مستخدمَين أو بين مستخدم وتطبيق Chat

النوع

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة SpaceType بدلاً منها.

عمليات التعداد
TYPE_UNSPECIFIED	محجوز
ROOM	المحادثات بين شخصين أو أكثر
DM	رسالة مباشرة بين مستخدم بشري وتطبيق Chat، حيث تكون جميع الرسائل مسطّحة. يُرجى العِلم أنّ هذا لا يشمل الرسائل المباشرة بين شخصين.

SpaceBatchUpdatedEventData

حمولة الحدث لتعديلات متعدّدة على مساحة

نوع الحدث: google.workspace.chat.space.v1.batchUpdated

الحقول
spaces[]	SpaceUpdatedEventData قائمة بمساحات العمل المعدَّلة

SpaceEvent

حدث يمثّل تغييرًا أو نشاطًا في مساحة Google Chat لمزيد من المعلومات، راجِع العمل مع الأحداث من 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

SpaceNotificationSetting

إعدادات الإشعارات لدى مستخدم في مساحة

الحقول
name	string المعرّف اسم المورد لإعدادات إشعارات المساحة. التنسيق: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting	NotificationSetting إعدادات الإشعارات
mute_setting	MuteSetting إعداد كتم صوت الإشعارات في المساحة

MuteSetting

أنواع إعدادات كتم إشعارات المساحة

عمليات التعداد
MUTE_SETTING_UNSPECIFIED	محجوز
UNMUTED	سيتلقّى المستخدم إشعارات بشأن المساحة استنادًا إلى إعدادات الإشعارات.
MUTED	لن يتلقّى المستخدم أي إشعارات للمساحة، بغض النظر عن إعدادات الإشعارات.

NotificationSetting

أنواع إعدادات الإشعارات وقد يتم توفير أنواع أخرى في المستقبل.

عمليات التعداد
NOTIFICATION_SETTING_UNSPECIFIED	محجوز
ALL	يتم إرسال الإشعارات عند الإشارة إلى شخص باستخدام @أو عند متابعة سلاسل المحادثات أو عند إرسال الرسالة الأولى في سلاسل المحادثات الجديدة. تتم متابعة جميع سلاسل المحادثات الجديدة تلقائيًا، ما لم يلغِ المستخدم متابعتها يدويًا.
MAIN_CONVERSATIONS	يتم تشغيل الإشعار عند الإشارة إلى شخص باستخدام @أو في سلاسل المحادثات التي تتم متابعتها أو عند إرسال أول رسالة في سلاسل المحادثات الجديدة. لا تتوفّر للرسائل المباشرة بين شخصين.
FOR_YOU	يتم تشغيل الإشعار عند الإشارة إليك باستخدام @أو في سلاسل المحادثات التي تتابعها. لا تتوفّر للرسائل المباشرة بين شخصين.
OFF	الإشعار غير مفعّل.

SpaceReadState

حالة القراءة الخاصة بالمستخدم في مساحة، تُستخدَم لتحديد الرسائل المقروءة وغير المقروءة

الحقول
name	string اسم المورد لحالة القراءة في المساحة التنسيق: users/{user}/spaces/{space}/spaceReadState
last_read_time	Timestamp اختياريّ. الوقت الذي تم فيه تعديل حالة قراءة المستخدم للمساحة عادةً ما يتطابق هذا الطابع الزمني مع الطابع الزمني لآخر رسالة تمت قراءتها، أو مع طابع زمني يحدّده المستخدم لتحديد موضع آخر رسالة تمت قراءتها في مساحة.

SpaceUpdatedEventData

حمولة الحدث لمساحة تم تعديلها

نوع الحدث: google.workspace.chat.space.v1.updated

الحقول
space	Space المساحة المعدَّلة

Thread

سلسلة محادثات في مساحة Google Chat للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها.

إذا حدّدت سلسلة محادثات عند إنشاء رسالة، يمكنك ضبط الحقل messageReplyOption لتحديد ما يحدث في حال عدم العثور على سلسلة محادثات مطابقة.

الحقول
name	string المعرّف اسم المورد الخاص السلسلة مثلاً: spaces/{space}/threads/{thread}
thread_key	string اختياريّ. إدخال لإنشاء سلسلة محادثات أو تعديلها وبخلاف ذلك، يتم عرض النتائج فقط. معرّف سلسلة المحادثات يمكن أن يتضمّن ما يصل إلى 4,000 حرف. هذا المعرّف فريد لتطبيق Chat الذي يضبطه. على سبيل المثال، إذا أنشأت تطبيقات Chat متعددة رسالة باستخدام مفتاح سلسلة المحادثات نفسه، سيتم نشر الرسائل في سلاسل محادثات مختلفة. للرد في سلسلة محادثات أنشأها مستخدم أو تطبيق Chat آخر، حدِّد حقل سلسلة المحادثات name بدلاً من ذلك.

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. يجب أن يكون معرّف الرسالة المحدّد معرّفًا يحدّده العميل، وإلا سيتعذّر تنفيذ الطلب.

UpdateSpaceNotificationSettingRequest

طلب تعديل إعدادات إشعارات المساحة يتيح هذا الإجراء تعديل إعدادات الإشعارات للمستخدم الذي يجري المكالمة فقط.

الحقول
space_notification_setting	SpaceNotificationSetting مطلوب. يجب ملء اسم المورد لإعدادات إشعارات المساحة بالتنسيق users/{user}/spaces/{space}/spaceNotificationSetting. يتم تعديل الحقول المحدّدة بواسطة update_mask فقط.
update_mask	FieldMask مطلوب. مسارات الحقول المتوافقة: notification_setting mute_setting

UpdateSpaceReadStateRequest

رسالة الطلب لواجهة برمجة التطبيقات UpdateSpaceReadState

الحقول
space_read_state	SpaceReadState مطلوب. حالة القراءة في المساحة والحقول المطلوب تعديلها يتيح هذا الإجراء تعديل حالة القراءة للمستخدم الذي يجري المكالمة فقط. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارات التالية: الاسم المستعار me مثلاً: users/me/spaces/{space}/spaceReadState عنوان بريدهم الإلكتروني على Workspace مثلاً: users/[e-mail]/spaces/{space}/spaceReadState رقم تعريف المستخدم مثلاً: users/123456789/spaces/{space}/spaceReadState التنسيق: users/{user}/spaces/{space}/spaceReadState
update_mask	FieldMask مطلوب. مسارات الحقول المطلوب تعديلها. مسارات الحقول المتوافقة حاليًا: last_read_time عندما يكون last_read_time قبل وقت إنشاء أحدث رسالة، تظهر المساحة على أنّها غير مقروءة في واجهة المستخدم. لوضع علامة "مقروءة" على المساحة، اضبط قيمة last_read_time على أي قيمة أكبر من وقت إنشاء آخر رسالة. يتم فرض قيمة last_read_time لتتطابق مع وقت إنشاء الرسالة الأحدث. يُرجى العِلم أنّ حالة القراءة في المساحة تؤثر فقط في حالة قراءة الرسائل المرئية في المحادثة ذات المستوى الأعلى في المساحة. لا يتأثر الرد في سلاسل المحادثات بهذا الطابع الزمني، بل يعتمد على حالة قراءة سلسلة المحادثات.

UpdateSpaceRequest

طلب تعديل مساحة واحدة

الحقول
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 Workspace. لتعديل حالة سجلّ المساحة، يجب حذف جميع أقنعة الحقول الأخرى في طلبك. لا يمكن استخدام 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 باستخدام إذن الوصول كمشرف. للحصول على التفاصيل، يُرجى الاطّلاع على وصف update_mask.

المستخدم

مستخدم في Google Chat عندما يتم عرضها كنتيجة لطلب، إذا كان تطبيق Chat يصادق كمستخدم، لن يتم ملء نتيجة المورد User إلا بـ name وtype الخاصين بالمستخدم.

الحقول
name	string اسم المورد لمساحة Google Chat user التنسيق: users/{user} يمكن استخدام users/app كاسم مستعار لمستخدم تطبيق الاتصال bot. بالنسبة إلى human users، يكون {user} هو معرّف المستخدم نفسه كما يلي: id الخاص بـ Person في People API على سبيل المثال، يمثّل users/123456789 في Chat API الشخص نفسه الذي يمثّله معرّف ملف شخصي 123456789 في People API. id للمستخدم في واجهة برمجة تطبيقات دليل Admin SDK يمكن استخدام عنوان البريد الإلكتروني للمستخدم كاسم مستعار لـ {user} في طلبات واجهة برمجة التطبيقات. على سبيل المثال، إذا كان معرّف الملف الشخصي [e-mail] في People API هو 123456789، يمكنك استخدام users/[e-mail] كاسم مستعار للإشارة إلى users/123456789. سيتم عرض اسم المورد الأساسي فقط (على سبيل المثال users/123456789) من واجهة برمجة التطبيقات.
display_name	string النتائج فقط. الاسم المعروض للمستخدم.
domain_id	string المعرّف الفريد لنطاق Google Workspace الخاص بالمستخدم.
type	Type نوع المستخدم
is_anonymous	bool النتائج فقط. عند true، يتم حذف المستخدم أو لا يظهر ملفه الشخصي.

النوع

عمليات التعداد
TYPE_UNSPECIFIED	القيمة التلقائية للتعداد DO NOT USE.
HUMAN	مستخدم بشري
BOT	مستخدم تطبيق Chat

UserMentionMetadata

البيانات الوصفية الخاصة بالتعليقات التوضيحية التي تشير إلى مستخدمين (@)

الحقول
user	User المستخدم الذي تمت الإشارة إليه
type	Type نوع الإشارة إلى المستخدم.

النوع

عمليات التعداد
TYPE_UNSPECIFIED	القيمة التلقائية للتعداد لا تستخدِمها.
ADD	إضافة مستخدم إلى المساحة
MENTION	الإشارة إلى مستخدم في المساحة

WidgetMarkup

الأداة هي أحد عناصر واجهة المستخدم الذي يعرض النصوص والصور.

الحقول
buttons[]	Button قائمة بالأزرار يجب أيضًا ضبط oneof data في "الأزرار"، ويجب ضبط حقل واحد فقط من هذه الحقول.
حقل الدمج data يمكن أن يحتوي WidgetMarkup على أحد العناصر التالية فقط. يمكنك استخدام حقول WidgetMarkup متعددة لعرض المزيد من العناصر. يمكن أن تكون data إحدى القيم التالية فقط:
text_paragraph	TextParagraph لعرض فقرة نصية في هذه الأداة
image	Image عرض صورة في هذا التطبيق المصغّر
key_value	KeyValue عرض عنصر قيمة مفتاح في هذا التطبيق المصغّر

زرّ

زر يمكن أن يكون زرًا نصيًا أو زرًا مصوّرًا.

الحقول
حقل الدمج type يمكن أن تكون type إحدى القيم التالية فقط:
text_button	TextButton زر يتضمّن نصًا وإجراء onclick
image_button	ImageButton زر يتضمّن صورة وإجراء onclick

FormAction

يصف إجراء النموذج السلوك عند إرسال النموذج. على سبيل المثال، يمكنك استدعاء Apps Script للتعامل مع النموذج.

الحقول
action_method_name	string يُستخدَم اسم الطريقة لتحديد الجزء من النموذج الذي أدّى إلى إرسال النموذج. يتم إرجاع هذه المعلومات إلى تطبيق Chat كجزء من حدث النقر على البطاقة. يمكنك استخدام اسم الطريقة نفسه لعدة عناصر تؤدي إلى سلوك مشترك.
parameters[]	ActionParameter قائمة مَعلمات الإجراءات

ActionParameter

قائمة بمَعلمات السلسلة التي يجب توفيرها عند استدعاء طريقة الإجراء على سبيل المثال، يمكنك استخدام ثلاثة أزرار تأجيل: التأجيل الآن، والتأجيل ليوم واحد، والتأجيل للأسبوع التالي. يمكنك استخدام action method = snooze()، مع تمرير نوع الغفوة ووقت الغفوة في قائمة مَعلمات السلسلة.

الحقول
key	string اسم المَعلمة لبرنامج الإجراءات النصي.
value	string قيمة المَعلمة

رمز

مجموعة الرموز المتوافقة

عمليات التعداد
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 نسبة العرض إلى الارتفاع لهذه الصورة (العرض والارتفاع) يتيح لك هذا الحقل حجز الارتفاع المناسب للصورة أثناء انتظار تحميلها. ولا يُقصد بها إلغاء نسبة العرض إلى الارتفاع المضمّنة في الصورة. إذا لم يتم ضبطها، يملأها الخادم من خلال جلب الصورة مسبقًا.

ImageButton

زر صورة يتضمّن إجراء onclick

الحقول
on_click	OnClick الإجراء onclick
name	string اسم image_button هذا المستخدَم لتسهيل الاستخدام يتم توفير قيمة تلقائية إذا لم يتم تحديد هذا الاسم.
حقل الدمج icons يمكن تحديد الرمز من خلال Icon enum أو عنوان URL. يمكن أن تكون icons إحدى القيم التالية فقط:
icon	Icon الرمز المحدّد بواسطة enum الذي يشير إلى رمز توفّره Chat API.
icon_url	string الرمز المحدّد بواسطة عنوان URL

KeyValue

يحتوي عنصر واجهة المستخدم على مفتاح (تصنيف) وقيمة (محتوى). يمكن أن يحتوي هذا العنصر أيضًا على بعض الإجراءات، مثل الزر onclick.

الحقول
top_label	string تمثّل هذه السمة نص التصنيف العلوي. يتوافق مع النصوص المنسَّقة. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".
content	string نص المحتوى يجب توفير نص منسّق دائمًا. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".
content_multiline	bool تحديد ما إذا كان المحتوى يجب أن يكون متعدد الأسطر
bottom_label	string نص التصنيف السفلي يتوافق مع النصوص المنسَّقة. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".
on_click	OnClick الإجراء onclick يمكن النقر على التصنيف العلوي والتصنيف السفلي ومنطقة المحتوى فقط.
حقل الدمج icons يجب تحديد رمز واحد على الأقل من الرموز top_label وbottom_label. يمكن أن تكون icons إحدى القيم التالية فقط:
icon	Icon قيمة تعداد ثابت تستبدلها Chat 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 المطلوب فتحه

TextButton

زر يتضمّن نصًا وإجراء onclick

الحقول
text	string النص المكتوب على الزر.
on_click	OnClick تمثّل هذه السمة onclick إجراء الزر.

TextParagraph

فقرة نصية يتوافق مع النصوص المنسَّقة. لمزيد من المعلومات حول تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".

الحقول
text	string