Package google.chat.v1

الفهرس

• ChatService (واجهة)
• AccessoryWidget (رسالة)
• ActionResponse (رسالة)
• ActionResponse.ResponseType (تعداد)
• ActionResponse.SelectionItems (رسالة)
• ActionResponse.UpdatedWidget (رسالة)
• ActionStatus (رسالة)
• Annotation (رسالة)
• AnnotationType (تعداد)
• AttachedGif (رسالة)
• Attachment (رسالة)
• Attachment.Source (تعداد)
• AttachmentDataRef (رسالة)
• CardWithId (رسالة)
• ChatSpaceLinkData (رسالة)
• CompleteImportSpaceRequest (رسالة)
• CompleteImportSpaceResponse (رسالة)
• ContextualAddOnMarkup (رسالة)
• ContextualAddOnMarkup.Card (رسالة)
• ContextualAddOnMarkup.Card.CardAction (رسالة)
• ContextualAddOnMarkup.Card.CardHeader (رسالة)
• ContextualAddOnMarkup.Card.CardHeader.ImageStyle (تعداد)
• ContextualAddOnMarkup.Card.Section (رسالة)
• CreateMembershipRequest (رسالة)
• CreateMessageRequest (رسالة)
• CreateMessageRequest.MessageReplyOption (تعداد)
• CreateReactionRequest (رسالة)
• CreateSpaceRequest (رسالة)
• CustomEmoji (رسالة)
• DeleteMembershipRequest (رسالة)
• DeleteMessageRequest (رسالة)
• DeleteReactionRequest (رسالة)
• DeleteSpaceRequest (رسالة)
• DeletionMetadata (رسالة)
• DeletionMetadata.DeletionType (تعداد)
• Dialog (رسالة)
• DialogAction (رسالة)
• DriveDataRef (رسالة)
• DriveLinkData (رسالة)
• Emoji (رسالة)
• EmojiReactionSummary (رسالة)
• FindDirectMessageRequest (رسالة)
• GetAttachmentRequest (رسالة)
• GetMembershipRequest (رسالة)
• GetMessageRequest (رسالة)
• GetSpaceEventRequest (رسالة)
• GetSpaceReadStateRequest (رسالة)
• GetSpaceRequest (رسالة)
• GetThreadReadStateRequest (رسالة)
• Group (رسالة)
• HistoryState (تعداد)
• ListMembershipsRequest (رسالة)
• ListMembershipsResponse (رسالة)
• ListMessagesRequest (رسالة)
• ListMessagesResponse (رسالة)
• ListReactionsRequest (رسالة)
• ListReactionsResponse (رسالة)
• ListSpaceEventsRequest (رسالة)
• ListSpaceEventsResponse (رسالة)
• ListSpacesRequest (رسالة)
• ListSpacesResponse (رسالة)
• MatchedUrl (رسالة)
• Membership (رسالة)
• Membership.MembershipRole (تعداد)
• Membership.MembershipState (تعداد)
• MembershipBatchCreatedEventData (رسالة)
• MembershipBatchDeletedEventData (رسالة)
• MembershipBatchUpdatedEventData (رسالة)
• MembershipCreatedEventData (رسالة)
• MembershipDeletedEventData (رسالة)
• MembershipUpdatedEventData (رسالة)
• Message (رسالة)
• MessageBatchCreatedEventData (رسالة)
• MessageBatchDeletedEventData (رسالة)
• MessageBatchUpdatedEventData (رسالة)
• MessageCreatedEventData (رسالة)
• MessageDeletedEventData (رسالة)
• MessageUpdatedEventData (رسالة)
• QuotedMessageMetadata (رسالة)
• Reaction (رسالة)
• ReactionBatchCreatedEventData (رسالة)
• ReactionBatchDeletedEventData (رسالة)
• ReactionCreatedEventData (رسالة)
• ReactionDeletedEventData (رسالة)
• RichLinkMetadata (رسالة)
• RichLinkMetadata.RichLinkType (تعداد)
• 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 (رسالة)
• SpaceReadState (رسالة)
• SpaceUpdatedEventData (رسالة)
• Thread (رسالة)
• ThreadReadState (رسالة)
• UpdateMembershipRequest (رسالة)
• UpdateMessageRequest (رسالة)
• 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) تُكمل عملية الاستيراد للمساحة المحدَّدة وتجعلها مرئية للمستخدمين. تتطلب المصادقة على التطبيق والتفويض على مستوى النطاق. لمزيد من المعلومات، اطّلِع على تفويض تطبيقات Google Chat لاستيراد البيانات. نطاقات الأذونات يجب توفير نطاق OAuth التالي: https://www.googleapis.com/auth/chat.import لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.

CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership) إنشاء اشتراك بشري أو اشتراك في تطبيق خاص بتطبيق الاتصال لا يمكنك إنشاء ميزة "العضوية في القنوات" لتطبيقات أخرى. مثلاً، راجِع دعوة مستخدم أو تطبيق Google Chat إلى مساحة أو إضافتهما إلى مساحة. عند إنشاء عضوية، إذا تم إيقاف سياسة القبول التلقائي لدى العضو المحدّد، تتم دعوته وعليه قبول دعوة المساحة قبل الانضمام. بخلاف ذلك، يؤدي إنشاء عضوية إلى إضافة العضو مباشرةً إلى المساحة المحددة. يتطلب مصادقة المستخدم. لتحديد العضو الذي تريد إضافته، اضبط السمة membership.member.name للعضو أو لعضو التطبيق، أو اضبط السمة membership.group_member.name للعضو في المجموعة. لإضافة تطبيق الاتصال إلى مساحة أو رسالة مباشرة بين مستخدمَين، استخدِم users/app. تتعذّر إضافة تطبيقات أخرى إلى المساحة. لإضافة مستخدم فعلي، استخدِم users/{user}، حيث يمكن أن يكون {user} عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن تكون السمة {user} هي id للمستخدم من People API، أو id للمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم في People API في [e-mail] هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/[e-mail] أو users/123456789. لإضافة مجموعة Google أو دعوتها في مساحة مُسَمّاة، يمكنك استخدام groups/{group}، حيث يكون {group} هو id للمجموعة من Cloud Identity Groups API. مثلاً، يمكنك استخدام Cloud Identity Groups lookup API لاسترداد المعرّف 123456789 لعنوان البريد الإلكتروني للمجموعة [e-mail]، ثم إضافة المجموعة أو دعوتها إلى مساحة مُعنوَنة من خلال ضبط membership.group_member.name على groups/123456789. البريد الإلكتروني للمجموعة غير متاح ولا يمكن إضافة "مجموعات Google" إلا كأعضاء في المساحات المُعنونة. نطاقات الأذونات يتطلب هذا الإعداد أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.admin.memberships https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.memberships https://www.googleapis.com/auth/chat.memberships.app لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.

CreateMessage

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

CreateReaction

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

CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space) يتم إنشاء مساحة مُعنوَنة. المساحات المجمَّعة حسب المواضيع غير متاحة. على سبيل المثال، راجِع إنشاء مساحة. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة، جرِّب استخدام displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض. يتطلب مصادقة المستخدم. نطاقات الأذونات يتطلب هذا الإعداد أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces https://www.googleapis.com/auth/chat.spaces.create لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.

DeleteMembership

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

DeleteMessage

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

DeleteSpace

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

FindDirectMessage

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

GetMembership

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

GetMessage

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

GetSpace

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

GetSpaceEvent

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

GetSpaceReadState

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

GetThreadReadState

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

ListMemberships

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

ListMessages

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

ListReactions

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

ListSpaceEvents

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

SetUpSpace

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

UpdateMembership

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

UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message) تعديل رسالة هناك فرق بين طريقة patch وupdate. تستخدم الطريقة patch طلب patch بينما تستخدم الطريقة update طلب put. ننصح باستخدام الطريقة patch. على سبيل المثال، راجِع تعديل رسالة. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم. عند استخدام مصادقة التطبيقات، لا يمكن للطلبات تعديل إلا الرسائل التي تم إنشاؤها من خلال تطبيق 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 هذا الاسم المعروض. يتطلب مصادقة المستخدم. نطاقات الأذونات يتطلب هذا الإعداد أحد نطاقات OAuth التالية: https://www.googleapis.com/auth/chat.admin.spaces https://www.googleapis.com/auth/chat.import https://www.googleapis.com/auth/chat.spaces لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.

UpdateSpaceReadState

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

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

تمثّل هذه السمة استجابة التطبيق المصغّر. يُستخدَم لتوفير خيارات الإكمال التلقائي لأداة ما.

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

ActionStatus

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

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

تعليق توضيحي

النتائج فقط. التعليقات التوضيحية المرتبطة بالنص العادي للرسالة. لإضافة تنسيق أساسي إلى رسالة نصية، راجِع تنسيق الرسائل النصية.

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

Hello @FooBot how are you!"

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

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

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

AnnotationType

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

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

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 للصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق لمستخدم حقيقي. يجب ألا تستخدم التطبيقات في Chat عنوان URL هذا لتنزيل محتوى المرفقات.
download_uri	string النتائج فقط. تمثّل هذه السمة عنوان URL للتنزيل الذي يجب استخدامه للسماح للمستخدم بتنزيل المرفق. يجب ألا تستخدم التطبيقات في Chat عنوان 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 اسم المورد لبيانات المرفق. يُستخدم هذا الحقل مع Media API لتنزيل بيانات المرفقات.
attachment_upload_token	string رمز مميّز معتم يحتوي على مرجع إلى مرفق تم تحميله. يتعامل معها العملاء كسلسلة مبهمة وتُستخدَم لإنشاء رسائل Chat التي تتضمن مرفقات أو تعديلها.

CardWithId

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

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

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

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

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

ChatSpaceLinkData

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

معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

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

لا يحتوي هذا النوع على أي حقول.

الترميز المخصّص للمطوّرين لتحديد محتوى إضافة سياقية

بطاقة

البطاقة هي عنصر في واجهة المستخدم يمكن أن يحتوي على أدوات واجهة المستخدم مثل النصوص والصور.

الحقول
header	CardHeader عنوان البطاقة عادةً ما يحتوي العنوان على عنوان وصورة.
sections[]	Section يتم فصل الأقسام بمقسم خط.
card_actions[]	CardAction إجراءات هذه البطاقة.
name	string اسم البطاقة

CardAction

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

غير متاح في تطبيقات Google Chat.

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

CardHeader

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

ImageStyle

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

القسم

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

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

CreateMembershipRequest

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

الحقول
parent	string مطلوب. اسم مورد المساحة المطلوب إنشاء العضوية فيها. التنسيق: Spaces/{space}
membership	Membership مطلوب. علاقة العضوية المراد إنشاؤها. يجب أن يحتوي الحقل memberType على مستخدِم تمت تعبئة الحقلَين user.name وuser.type فيه. سيعيّن الخادم اسم مورد ويستبدل أي شيء محدد. عندما ينشئ تطبيق في Chat علاقة عضوية لمستخدم فعلي، يجب أن يستخدم نطاق chat.memberships، مع ضبط user.type على HUMAN، وضبط user.name مع التنسيق users/{user}، حيث يمكن أن يكون {user} عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن يكون {user} أيضًا هو id للمستخدم من People API، أو id للمستخدم في واجهة برمجة تطبيقات الدليل. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم في People API في [e-mail] هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/[e-mail] أو users/123456789. عندما ينشئ تطبيق Chat علاقة عضوية لنفسه، يجب استخدام نطاق chat.memberships.app، وضبط user.type على BOT، وضبط user.name على users/app.
use_admin_access	bool معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 chat.admin.memberships. لا تتوفّر إمكانية إنشاء اشتراكات في التطبيقات أو إنشاء اشتراكات للمستخدمين خارج مؤسسة المشرف في 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 اختياريّ. معرّف مخصّص لرسالة معيّنة يسمح هذا الإذن للتطبيقات في 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 فقط. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب استخدام displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض. يتم تخصيص المسافة name على الخادم، لذا سيتم تجاهل أي عنصر محدَّد في هذا الحقل.
request_id	string اختياريّ. معرّف فريد لهذا الطلب ننصحك باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد رقم تعريف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض رسالة خطأ.

CustomEmoji

يمثل رمزًا تعبيريًا مخصصًا.

الحقول
uid	string النتائج فقط. مفتاح فريد لمورد الرموز التعبيرية المخصّصة.

DeleteMembershipRequest

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

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

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 معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 chat.admin.delete.

DeletionMetadata

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

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

DeletionType

المستخدم الذي حذف الرسالة وكيفية حذفها.

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

مربّع حوار

ملفوف حول نص البطاقة في مربّع الحوار

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

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

GetMessageRequest

يمكنك طلب تلقّي رسالة.

الحقول
name	string مطلوب. اسم مورد الرسالة تنسيق الملف: spaces/{space}/messages/{message} في حال ضبط معرّف مخصّص لرسالتك، يمكنك استخدام القيمة من الحقل clientAssignedMessageId لـ {message}. للحصول على التفاصيل، يُرجى الاطِّلاع على تسمية رسالة.

GetSpaceEventRequest

يمكنك طلب تلقّي رسالة لتلقّي حدث في المساحة.

الحقول
name	string مطلوب. اسم المورد لحدث المساحة تنسيق الملف: spaces/{space}/spaceEvents/{spaceEvent}

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 معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب هذا الإعداد توفُّر نطاقَي OAuth 2.0 أو chat.admin.spaces أو chat.admin.spaces.readonly.

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 التنسيق: 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 للمؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات.

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 معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق 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) باستخدام عامل التشغيل :. للفلترة حسب أنواع أحداث متعدّدة، استخدِم عامل التشغيل 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 يتم عرض النتائج بترتيب زمني (الحدث الأقدم أولاً).
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 قائمة المساحات في الصفحة المطلوبة (أو الأولى)
next_page_token	string يمكنك إرسال رمز مميّز كـ pageToken لاسترداد الصفحة التالية من النتائج. وإذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة.

MatchedUrl

هناك عنوان URL مطابق في رسالة Chat. يمكن لتطبيقات Chat معاينة عناوين URL المطابقة. لمزيد من المعلومات، يُرجى الاطّلاع على روابط المعاينة.

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

العضوية

تمثّل هذه السمة علاقة العضوية في 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 الذي تتوافق معه العضوية. في حال تمت المصادقة كمستخدم في تطبيق Chat، ستتم تعبئة المستخدم name وtype.
group_member	Group "مجموعة 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:. لا ينطبق ذلك على رموز يونيكود التعبيرية، مثل U+1F600 للرمز التعبيري للوجه المبتسم. للمزيد من المعلومات، يُرجى الاطّلاع على مقالة عرض تنسيق النص المُرسَل في رسالة.
cards[] (deprecated)	Card تم إيقاف هذا العنصر نهائيًا. متوقّفة نهائيًا: استخدِم cards_v2 بدلاً منها. بطاقات تفاعلية ومنسّقة وتفاعلية يمكنك استخدامها لعرض عناصر واجهة المستخدم، مثل النصوص المنسّقة والأزرار والصور القابلة للنقر. يتم عرض البطاقات عادةً أسفل النص العادي للرسالة. يمكن أن يصل الحد الأقصى لحجم الملفَين cards وcards_v2 إلى 32 كيلوبايت.
cards_v2[]	CardWithId مصفوفة من البطاقات. يمكن لتطبيقات Chat فقط إنشاء البطاقات. في حال تمت المصادقة كمستخدم في تطبيق Chat، لا يمكن أن تحتوي الرسائل على بطاقات. للاطّلاع على البطاقات وكيفية إنشائها، راجِع إرسال رسائل البطاقات. تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات". فتح "أداة إنشاء البطاقات"
annotations[]	Annotation النتائج فقط. التعليقات التوضيحية المرتبطة بـ text في هذه الرسالة
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 فقط إرسال رسائل خاصة. في حال تمت المصادقة كمستخدم لتطبيق Chat، لا يمكن أن تكون الرسالة خاصة ويجب حذف هذا الحقل. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة إرسال رسائل خاصة إلى مستخدمي Google Chat.
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

تمثّل هذه السمة رابطًا منسّقًا يؤدي إلى مرجع.

الحقول
uri	string معرّف الموارد المنتظم (URI) لهذا الرابط.
rich_link_type	RichLinkType نوع الرابط المنسّق.
حقل الاتحاد data. بيانات المرجع المرتبط يمكن أن يكون data واحدًا فقط مما يلي:
drive_link_data	DriveLinkData بيانات رابط Drive.
chat_space_link_data	ChatSpaceLinkData بيانات رابط مساحة Chat معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

RichLinkType

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

عمليات التعداد
RICH_LINK_TYPE_UNSPECIFIED	القيمة التلقائية للتعداد يُرجى عدم استخدامها.
DRIVE_FILE	نوع من الروابط المنسّقة في Google Drive.
CHAT_SPACE	نوع من الروابط الغنية بصريًا لمساحات Chat. على سبيل المثال، شريحة ذكية للمسافة. معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

SearchSpacesRequest

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

الحقول
use_admin_access	bool عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق 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 المطلوب دعوتهم للانضمام إلى المساحة. احذف اسم المستخدم المتصل لأنّه تتم إضافته تلقائيًا. تتيح هذه الميزة حاليًا إضافة ما يصل إلى 20 عضوية (بالإضافة إلى المتصل). بالنسبة إلى عضوية المستخدمين، يجب أن يحتوي الحقل 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}
type (deprecated)	Type تم إيقاف هذا العنصر نهائيًا. النتائج فقط. متوقّفة نهائيًا: استخدِم space_type بدلاً منها. نوع المساحة.
space_type	SpaceType نوع المساحة. مطلوبة عند إنشاء مساحة أو تعديل نوع المساحة الناتج فقط للاستخدامات الأخرى.
single_user_bot_dm	bool اختياريّ. ما إذا كانت المساحة عبارة عن رسالة مباشرة بين تطبيق Chat وشخص واحد
threaded (deprecated)	bool تم إيقاف هذا العنصر نهائيًا. النتائج فقط. متوقّفة نهائيًا: استخدِم spaceThreadingState بدلاً منها. ما إذا كانت الرسائل سلسلة محادثات في هذه المساحة
display_name	string الاسم المعروض للمساحة. هذا الحقل مطلوب عند إنشاء مساحة. إذا ظهرت لك رسالة الخطأ 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. أثناء استيراد المساحات، لن تظهر للمستخدمين إلى أن تكتمل عملية الاستيراد.
create_time	Timestamp اختياريّ. غير قابل للتغيير. هو الوقت الذي تم فيه إنشاء المساحة في المساحات التي تم إنشاؤها في Chat. هذا الحقل هو الناتج فقط، إلا عند استخدامه في مساحات وضع الاستيراد. بالنسبة إلى مساحات وضع الاستيراد، يجب ضبط هذا الحقل على الطابع الزمني السابق الذي تم إنشاء المساحة فيه في المصدر للحفاظ على وقت الإنشاء الأصلي. تتم تعبئة هذا الحقل في الإخراج فقط عندما تكون قيمة spaceType هي GROUP_CHAT أو SPACE.
last_active_time	Timestamp النتائج فقط. الطابع الزمني لآخر رسالة في المساحة معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.
admin_installed	bool النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة (DM) التي تتضمّن تطبيق Chat، سواء أنشأ مشرف Google Workspace المساحة أم لا. يمكن للمشرفين تثبيت رسالة مباشرة وإعدادها باستخدام تطبيق في Chat نيابةً عن المستخدمين في مؤسستهم. لإتاحة التثبيت من خلال المشرف، يجب أن يتضمّن تطبيق Chat ميزة الرسائل المباشرة.
membership_count	MembershipCount النتائج فقط. يشير هذا المقياس إلى عدد العضويات في القناة مجمّعة حسب نوع العضوية. تتم تعبئة هذا الحقل عند ضبط space_type على SPACE أو DIRECT_MESSAGE أو GROUP_CHAT. معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.
access_settings	AccessSettings اختياريّ. تُحدِّد إعدادات الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE.
space_uri	string النتائج فقط. معرّف الموارد المنتظم (URI) الخاص بالمستخدم للوصول إلى المساحة
حقل الاتحاد space_permission_settings. يمثّل هذا الإعداد إعدادات الأذونات للمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. يمكن أن يكون space_permission_settings واحدًا فقط مما يلي:
predefined_permission_settings	PredefinedPermissionSettings اختياريّ. الإدخال فقط. إعدادات أذونات المساحة حقل إدخال لإنشاء مساحة، يتم إنشاء مساحة تعاون في حال عدم ضبط هذا الحقل. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل PermissionSettings. معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.
permission_settings	PermissionSettings اختياريّ. إعدادات الأذونات الدقيقة التي يمكن ضبطها لتعديل المساحة حقل إدخال لتعديل المساحة في الحالات الأخرى، يتم عرض الناتج فقط. لإنشاء مساحة، استخدِم predefined_permission_settings بدلاً من ذلك. معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

AccessSettings

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

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

AccessState

يمثل حالة الوصول إلى المساحة.

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

MembershipCount

معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

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

الحقول
joined_direct_human_user_count	int32 عدد المستخدمين الذين انضموا مباشرةً إلى المساحة، ولا يتم احتساب عدد المستخدمين الذين انضموا من خلال العضوية في مجموعة
joined_group_count	int32 عدد جميع المجموعات التي انضمت مباشرةً إلى المساحة

PermissionSetting

يمثّل هذا الإعداد إعدادًا لإذن المساحة.

معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

الحقول
managers_allowed	bool ما إذا كان مدراء المساحات لديهم هذا الإذن
members_allowed	bool ما إذا كان الأعضاء غير الإداريين لديهم هذا الإذن أم لا.

PermissionSettings

إعدادات الأذونات لمساحة مُعنوَنة لضبط إعدادات الأذونات عند إنشاء مساحة، حدِّد الحقل PredefinedPermissionSettings في طلبك.

معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

الحقول
manage_members_and_groups	PermissionSetting إعداد لإدارة الأعضاء والمجموعات في المساحة.
modify_space_details	PermissionSetting إعداد لتعديل اسم المساحة وصورتها الرمزية ووصفها وإرشاداتها
toggle_history	PermissionSetting إعداد للتبديل بين تفعيل سجلّ المساحات وإيقافه.
use_at_mention_all	PermissionSetting إعداد استخدام @الكل في مساحة
manage_apps	PermissionSetting إعداد لإدارة التطبيقات في مساحة
manage_webhooks	PermissionSetting إعداد لإدارة الردود التلقائية على الويب في مساحة
post_messages	PermissionSetting النتائج فقط. خيار لنشر الرسائل في مساحة
reply_messages	PermissionSetting إعداد للرد على الرسائل في مساحة

PredefinedPermissionSettings

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

معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها.

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

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

UpdateMessageRequest

طلب تعديل رسالة

الحقول
message	Message مطلوب. تم تعديل رسالة تحتوي على حقول.
update_mask	FieldMask مطلوب. مسارات الحقول المطلوب تعديلها. افصل بين القيم المتعدّدة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول. مسارات الحقول المتوافقة حاليًا: text attachment cards (يتطلب ذلك مصادقة التطبيق.) cards_v2 (يتطلب ذلك مصادقة التطبيق.) accessory_widgets (يتطلب ذلك مصادقة التطبيق.)
allow_missing	bool اختياريّ. في حال عدم العثور على true والرسالة، يتم إنشاء رسالة جديدة ويتم تجاهل updateMask. يجب أن يكون معرّف الرسالة المحدّد من العميل وإلا سيتعذّر تنفيذ الطلب.

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 display_name: لا يمكن تعديل الاسم المعروض إلا للمساحات التي يكون فيها الحقل spaceType SPACE. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب قيمة مختلفة. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض. space_type: لا يمكن تغيير سوى نوع المساحة "GROUP_CHAT" إلى "SPACE". يُرجى تضمين display_name مع space_type في قناع التحديث والتأكّد من أنّ المساحة المحدّدة لها اسم معروض غير فارغ ونوع المساحة SPACE. إنّ تضمين القناع space_type والنوع SPACE في المساحة المحدّدة عند تعديل الاسم المعروض هو إجراء اختياري إذا كانت المساحة الحالية من النوع SPACE. تؤدي محاولة تعديل نوع المساحة بطرق أخرى إلى ظهور خطأ وسيطة غير صالح. لا يملك space_type الإذن بالوصول الإداري. space_history_state: لتعديل إعدادات سجلّ المساحات عن طريق تفعيل السجلّ أو إيقافه للمساحة. لا يتوفّر هذا الخيار إلا إذا كانت إعدادات السجلّ مفعَّلة لمؤسسة Google Workspace. لتعديل حالة سجلّ المساحات، عليك حذف جميع أقنعة الحقول الأخرى في طلبك. لا يملك space_history_state الإذن بالوصول الإداري. access_settings.audience: يعدِّل إعدادات الوصول للمستخدمين الذين يمكنهم اكتشاف المساحة والانضمام إلى المساحة ومعاينة الرسائل في المساحة المُعنوَنة حيث يكون الحقل spaceType SPACE. إذا كانت المساحة الحالية تضم جمهورًا مستهدفًا، يمكنك إزالة الجمهور وتقييد الوصول إلى المساحة من خلال حذف قيمة لقناع الحقل هذا. لتعديل إعدادات الوصول إلى مساحة، يجب أن يكون المستخدم المصادق مدير مساحة وأن يحذف جميع أقنعة الحقول الأخرى في طلبك. لا يمكنك تعديل هذا الحقل إذا كانت المساحة في وضع الاستيراد. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة جعل مساحة قابلة للاكتشاف من مستخدمين محدّدين. لا يملك access_settings.audience الإذن بالوصول الإداري. معاينة المطوّر: تتيح تغيير إعدادات الأذونات الخاصة بالمساحة. تتضمّن مسارات الحقول المتاحة ما يلي: permission_settings.manage_members_and_groups وpermission_settings.modify_space_details وpermission_settings.toggle_history وpermission_settings.use_at_mention_all وpermission_settings.manage_apps وpermission_settings.manage_webhooks وpermission_settings.reply_messages (تحذير: لا يمكن استخدام هذه المسارات مع جميع المسارات الأخرى التي لا تسمح بإعدادات الأذونات). لا يملك permission_settings الإذن بالوصول الإداري.
use_admin_access	bool معاينة المطوِّر: متاحة في إطار برنامج معاينة المطوّر على Google Workspace الذي يمنح إمكانية استخدام ميزات معيّنة قبل إطلاقها. عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم. يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 chat.admin.spaces. بعض قيم FieldMask غير متاحة عند استخدام إذن وصول إداري. لمعرفة التفاصيل، يُرجى الاطّلاع على وصف "update_mask".

مستخدم

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

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

النوع

عمليات التعداد
TYPE_UNSPECIFIED	القيمة التلقائية للتعداد يُرجى عدم استخدامها.
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

يصف إجراء النموذج السلوك الذي يتم عند إرساله. على سبيل المثال، يمكنك استدعاء "برمجة تطبيقات Google" للتعامل مع النموذج.

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