الفهرس
ChatService(واجهة)AccessoryWidget(رسالة)ActionResponse(رسالة)ActionResponse.ResponseType(تعداد)ActionResponse.SelectionItems(رسالة)ActionResponse.UpdatedWidget(رسالة)ActionStatus(رسالة)Annotation(رسالة)AnnotationType(تعداد)AppCommandMetadata(رسالة)AppCommandMetadata.AppCommandType(تعداد)AttachedGif(رسالة)Attachment(رسالة)Attachment.Source(تعداد)AttachmentDataRef(رسالة)CalendarEventLinkData(رسالة)CardWithId(رسالة)ChatSpaceLinkData(رسالة)CompleteImportSpaceRequest(رسالة)CompleteImportSpaceResponse(رسالة)ContextualAddOnMarkup(رسالة)ContextualAddOnMarkup.Card(رسالة)ContextualAddOnMarkup.Card.CardAction(رسالة)ContextualAddOnMarkup.Card.CardHeader(رسالة)ContextualAddOnMarkup.Card.CardHeader.ImageStyle(تعداد)ContextualAddOnMarkup.Card.Section(رسالة)CreateCustomEmojiRequest(رسالة)CreateMembershipRequest(رسالة)CreateMessageNotificationOptions(رسالة)CreateMessageNotificationOptions.NotificationType(تعداد)CreateMessagePinRequest(رسالة)CreateMessageRequest(رسالة)CreateMessageRequest.MessageReplyOption(تعداد)CreateReactionRequest(رسالة)CreateSectionRequest(رسالة)CreateSpaceRequest(رسالة)CustomEmoji(رسالة)CustomEmoji.CustomEmojiPayload(رسالة)CustomEmojiMetadata(رسالة)DeleteCustomEmojiRequest(رسالة)DeleteMembershipRequest(رسالة)DeleteMessagePinRequest(رسالة)DeleteMessageRequest(رسالة)DeleteReactionRequest(رسالة)DeleteSectionRequest(رسالة)DeleteSpaceRequest(رسالة)DeletionMetadata(رسالة)DeletionMetadata.DeletionType(تعداد)Dialog(رسالة)DialogAction(رسالة)DriveDataRef(رسالة)DriveLinkData(رسالة)Emoji(رسالة)EmojiReactionSummary(رسالة)FindDirectMessageRequest(رسالة)FindGroupChatsRequest(رسالة)FindGroupChatsResponse(رسالة)ForwardedMetadata(رسالة)GetAttachmentRequest(رسالة)GetCustomEmojiRequest(رسالة)GetMembershipRequest(رسالة)GetMessageRequest(رسالة)GetSpaceEventRequest(رسالة)GetSpaceNotificationSettingRequest(رسالة)GetSpaceReadStateRequest(رسالة)GetSpaceRequest(رسالة)GetThreadReadStateRequest(رسالة)Group(رسالة)HistoryState(تعداد)ListCustomEmojisRequest(رسالة)ListCustomEmojisResponse(رسالة)ListMembershipsRequest(رسالة)ListMembershipsResponse(رسالة)ListMessagePinsRequest(رسالة)ListMessagePinsResponse(رسالة)ListMessagesRequest(رسالة)ListMessagesResponse(رسالة)ListReactionsRequest(رسالة)ListReactionsResponse(رسالة)ListSectionItemsRequest(رسالة)ListSectionItemsResponse(رسالة)ListSectionsRequest(رسالة)ListSectionsResponse(رسالة)ListSpaceEventsRequest(رسالة)ListSpaceEventsResponse(رسالة)ListSpacesRequest(رسالة)ListSpacesResponse(رسالة)MatchedUrl(رسالة)MeetSpaceLinkData(رسالة)MeetSpaceLinkData.HuddleStatus(تعداد)MeetSpaceLinkData.Type(تعداد)Membership(رسالة)Membership.MembershipRole(تعداد)Membership.MembershipState(تعداد)MembershipBatchCreatedEventData(رسالة)MembershipBatchDeletedEventData(رسالة)MembershipBatchUpdatedEventData(رسالة)MembershipCreatedEventData(رسالة)MembershipDeletedEventData(رسالة)MembershipUpdatedEventData(رسالة)Message(رسالة)MessageBatchCreatedEventData(رسالة)MessageBatchDeletedEventData(رسالة)MessageBatchUpdatedEventData(رسالة)MessageCreatedEventData(رسالة)MessageDeletedEventData(رسالة)MessagePin(رسالة)MessageUpdatedEventData(رسالة)MoveSectionItemRequest(رسالة)MoveSectionItemResponse(رسالة)PositionSectionRequest(رسالة)PositionSectionRequest.Position(تعداد)PositionSectionResponse(رسالة)QuotedMessageMetadata(رسالة)QuotedMessageMetadata.QuoteType(تعداد)QuotedMessageSnapshot(رسالة)Reaction(رسالة)ReactionBatchCreatedEventData(رسالة)ReactionBatchDeletedEventData(رسالة)ReactionCreatedEventData(رسالة)ReactionDeletedEventData(رسالة)ReplaceMessageCardsRequest(رسالة)ReplaceMessageCardsResponse(رسالة)RichLinkMetadata(رسالة)RichLinkMetadata.RichLinkType(تعداد)SearchMessageResult(رسالة)SearchMessagesRequest(رسالة)SearchMessagesRequest.SearchMessagesView(تعداد)SearchMessagesResponse(رسالة)SearchSpacesRequest(رسالة)SearchSpacesResponse(رسالة)Section(رسالة)Section.SectionType(تعداد)SectionItem(رسالة)SetUpSpaceRequest(رسالة)SlashCommand(رسالة)SlashCommandMetadata(رسالة)SlashCommandMetadata.Type(تعداد)Space(رسالة)Space.AccessSettings(رسالة)Space.AccessSettings.AccessState(تعداد)Space.MembershipCount(رسالة)Space.PermissionSetting(رسالة)Space.PermissionSettings(رسالة)Space.PredefinedPermissionSettings(تعداد)Space.SpaceDetails(رسالة)Space.SpaceThreadingState(تعداد)Space.SpaceType(تعداد)Space.Type(تعداد)SpaceBatchUpdatedEventData(رسالة)SpaceEvent(رسالة)SpaceNotificationSetting(رسالة)SpaceNotificationSetting.MuteSetting(تعداد)SpaceNotificationSetting.NotificationSetting(تعداد)SpaceReadState(رسالة)SpaceUpdatedEventData(رسالة)SpaceView(تعداد)Thread(رسالة)ThreadReadState(رسالة)UpdateMembershipRequest(رسالة)UpdateMessageRequest(رسالة)UpdateSectionRequest(رسالة)UpdateSpaceNotificationSettingRequest(رسالة)UpdateSpaceReadStateRequest(رسالة)UpdateSpaceRequest(رسالة)User(رسالة)User.Type(تعداد)UserMentionMetadata(رسالة)UserMentionMetadata.Type(تعداد)WidgetMarkup(رسالة)WidgetMarkup.Button(رسالة)WidgetMarkup.FormAction(رسالة)WidgetMarkup.FormAction.ActionParameter(رسالة)WidgetMarkup.Icon(تعداد)WidgetMarkup.Image(رسالة)WidgetMarkup.ImageButton(رسالة)WidgetMarkup.KeyValue(رسالة)WidgetMarkup.OnClick(رسالة)WidgetMarkup.OpenLink(رسالة)WidgetMarkup.TextButton(رسالة)WidgetMarkup.TextParagraph(رسالة)
ChatService
تتيح للمطوّرين إنشاء تطبيقات وعمليات دمج في Chat على "منصة Google Chat".
| CompleteImportSpace |
|---|
|
تُكمل هذه الطريقة عملية الاستيراد للمساحة المحدّدة وتتيحها للمستخدمين. يتطلّب مصادقة المستخدم والتفويض على مستوى النطاق باستخدام نطاق التفويض:
لمزيد من المعلومات، يُرجى الاطّلاع على مقالة منح تطبيقات Google Chat الإذن باستيراد البيانات.
|
| CreateCustomEmoji |
|---|
|
تنشئ هذه الطريقة رمز إيموجي مخصّصًا. لا تتوفّر رموز الإيموجي المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، يُرجى الاطّلاع على التعرّف على رموز الإيموجي المخصّصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| CreateMembership |
|---|
|
تُنشئ هذه السمة عضوية لتطبيق الاتصال في Chat أو لمستخدم أو لمجموعة Google. لا تتوفّر إمكانية إنشاء عضويات لتطبيقات Chat الأخرى. عند إنشاء عضوية، إذا كان العضو المحدّد قد أوقف سياسة القبول التلقائي، ستتم دعوته، وعليه قبول دعوة المساحة قبل الانضمام إليها. بخلاف ذلك، يؤدي إنشاء اشتراك إلى إضافة العضو مباشرةً إلى المساحة المحدّدة. يتيح الأنواع التالية من المصادقة:
مصادقة التطبيق غير متاحة لحالات الاستخدام التالية:
للاطّلاع على أمثلة على الاستخدام، يُرجى الرجوع إلى:
|
| CreateMessage |
|---|
|
تُنشئ هذه الطريقة رسالة في مساحة Chat على Google Chat. للاطّلاع على مثال، يُرجى الانتقال إلى إرسال رسالة. يتيح الأنواع التالية من المصادقة:
يحدّد Chat مرسل الرسالة بشكل مختلف استنادًا إلى نوع المصادقة الذي تستخدمه في طلبك. تعرض الصورة التالية كيف ينسب Chat رسالة عند استخدام مصادقة التطبيق. يعرض Chat تطبيق Chat كمُرسِل الرسالة. يمكن أن يتضمّن محتوى الرسالة نصًا ( تعرض الصورة التالية كيف ينسب Chat رسالة عند استخدام مصادقة المستخدم. يعرض Chat المستخدم كمُرسِل الرسالة ويشير إلى تطبيق Chat في الرسالة من خلال عرض اسمه. يمكن أن يحتوي محتوى الرسالة على نص فقط ( الحد الأقصى لحجم الرسالة، بما في ذلك محتوى الرسالة، هو 32,000 بايت. بالنسبة إلى طلبات الويب هوك، لا يحتوي الردّ على الرسالة الكاملة. تعبئ الاستجابة الحقلَين
|
| CreateMessagePin |
|---|
|
تُنشئ هذه الطريقة دبوسًا للرسالة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| CreateReaction |
|---|
|
تنشئ هذه الطريقة تفاعلاً وتضيفه إلى رسالة. للاطّلاع على مثال، راجِع المقالة إضافة تفاعل إلى رسالة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| CreateSection |
|---|
|
ينشئ هذا الإجراء قسمًا في Google Chat. تساعد الأقسام المستخدمين في تجميع المحادثات وتخصيص قائمة المساحات المعروضة في لوحة التنقّل في Chat. يمكن إنشاء أقسام من النوع يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| CreateSpace |
|---|
|
تنشئ هذه الطريقة مساحة. يمكن استخدامها لإنشاء مساحة مُسمّاة أو محادثة جماعية في يتيح الأنواع التالية من المصادقة:
عند إجراء المصادقة كتطبيق، يجب ضبط الحقل عند المصادقة كتطبيق، تتم إضافة تطبيق Chat كعضو في المساحة. ومع ذلك، على عكس المصادقة البشرية، لا تتم إضافة تطبيق Chat كمدير مساحة. بشكلٍ تلقائي، يمكن لجميع أعضاء المساحة إزالة تطبيق Chat منها. للسماح لمدراء المساحة فقط بإزالة التطبيق من مساحة، اضبط يعتمد الاشتراك في المساحة عند إنشائها على ما إذا تم إنشاؤها في
إذا تلقّيت رسالة الخطأ
|
| DeleteCustomEmoji |
|---|
|
يحذف هذا الإجراء إيموجي مخصّصًا. بشكلٍ تلقائي، يمكن للمستخدمين حذف رموز الإيموجي المخصّصة التي أنشأوها فقط. يمكن لمدراء الرموز التعبيرية الذين يعيّنهم المشرف حذف أي رمز تعبيري مخصّص في المؤسسة. اطّلِع على مقالة التعرّف على الرموز التعبيرية المخصصة في Google Chat. لا تتوفّر رموز الإيموجي المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، يُرجى الاطّلاع على التعرّف على رموز الإيموجي المخصّصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| DeleteMembership |
|---|
|
يحذف هذا الإجراء عضوية. للاطّلاع على مثال، راجِع إزالة مستخدم أو تطبيق Google Chat من مساحة. يتيح الأنواع التالية من المصادقة:
مصادقة التطبيق غير متاحة لحالات الاستخدام التالية:
لحذف عضويات مدراء المساحة، يجب أن يكون مقدّم الطلب مدير مساحة. إذا كنت تستخدم مصادقة التطبيق، يجب أن يكون تطبيق Chat هو منشئ المساحة.
|
| DeleteMessage |
|---|
|
لحذف رسالة للاطّلاع على مثال، يُرجى الانتقال إلى حذف رسالة. يتيح الأنواع التالية من المصادقة:
عند استخدام مصادقة التطبيق، يمكن للطلبات حذف الرسائل التي أنشأها تطبيق Chat الذي يجري المكالمة فقط.
|
| DeleteMessagePin |
|---|
|
لحذف دبوس رسالة يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| DeleteReaction |
|---|
|
يحذف هذا الإجراء تفاعلاً مع رسالة. للاطّلاع على مثال، يُرجى الانتقال إلى حذف تفاعل. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| DeleteSection |
|---|
|
تحذف هذه الطريقة قسمًا من النوع إذا كان القسم يحتوي على عناصر، مثل المساحات، يتم نقل العناصر إلى الأقسام التلقائية في Google Chat ولا يتم حذفها. لمعرفة التفاصيل، يُرجى الاطّلاع على إنشاء أقسام وتنظيمها في Google Chat. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| DeleteSpace |
|---|
|
تحذف هذه الطريقة مساحة مُسمّاة. يتم دائمًا تنفيذ عملية حذف متسلسلة، ما يعني أنّه يتم أيضًا حذف الموارد الفرعية للمساحة، مثل الرسائل المنشورة في المساحة والعضويات في المساحة. للاطّلاع على مثال، يُرجى الانتقال إلى حذف مساحة. يتيح الأنواع التالية من المصادقة:
|
| FindDirectMessage |
|---|
|
تعرض هذه الطريقة الرسالة المباشرة الحالية مع المستخدم المحدّد. إذا لم يتم العثور على مساحة رسالة مباشرة، تعرض الدالة الخطأ باستخدام مصادقة التطبيق، يتم عرض مساحة الرسائل المباشرة بين المستخدم المحدّد وتطبيق Chat الذي يتم الاتصال به. باستخدام مصادقة المستخدم، يتم عرض مساحة الرسائل المباشرة بين المستخدم المحدّد والمستخدم الذي تمت مصادقته. يتيح الأنواع التالية من المصادقة:
|
| FindGroupChats |
|---|
|
تعرض هذه الطريقة جميع المساحات التي تتضمّن إذا حظر المستخدم الذي يجري المكالمة بعض المستخدمين أو تم حظره من قِبلهم، ولم يتم العثور على مساحات تضم المجموعة الكاملة المحدّدة من المستخدمين، ستعرض هذه الطريقة مساحات لا تتضمّن المستخدمين المحظورين أو الذين يحظرون المستخدم. يجب أن تحتوي مجموعة المستخدمين المحدّدة على عضويات بشرية فقط (غير تابعة لتطبيقات). ولا يعرض الطلب الذي يحتوي على مستخدمين غير بشريين أي مساحات. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| GetAttachment |
|---|
|
تعرض هذه الطريقة البيانات الوصفية لمرفق رسالة. يتم جلب بيانات المرفقات باستخدام Media API. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على بيانات وصفية حول مرفق رسالة. يتطلّب مصادقة التطبيق باستخدام نطاق التفويض:
|
| GetCustomEmoji |
|---|
|
تعرض هذه الطريقة تفاصيل حول إيموجي مخصّص. لا تتوفّر رموز الإيموجي المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، يُرجى الاطّلاع على التعرّف على رموز الإيموجي المخصّصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| GetMembership |
|---|
|
تعرض هذه الطريقة تفاصيل حول عضوية. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على تفاصيل حول عضوية مستخدم أو تطبيق Google Chat. يتيح الأنواع التالية من المصادقة:
|
| GetMessage |
|---|
|
تعرض هذه الطريقة تفاصيل حول رسالة. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على تفاصيل حول رسالة. يتيح الأنواع التالية من المصادقة:
ملاحظة: قد يعرض هذا الخيار رسالة من عضو أو مساحة محظورة.
|
| GetSpace |
|---|
|
تعرض هذه الطريقة تفاصيل حول مساحة. للاطّلاع على مثال، يُرجى الانتقال إلى الاطّلاع على تفاصيل حول مساحة. يتيح الأنواع التالية من المصادقة:
تنطبق القيود التالية على مصادقة التطبيق:
|
| GetSpaceEvent |
|---|
|
تعرض هذه الطريقة حدثًا من مساحة Google Chat. يحتوي حمولة الحدث على أحدث إصدار من المورد الذي تم تغييره. على سبيل المثال، إذا طلبت حدثًا حول رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، سيعرض الخادم مورد ملاحظة: لا يتم عرض الحقل يتيح الأنواع التالية من المصادقة مع نطاق تفويض مناسب لقراءة البيانات المطلوبة:
للحصول على حدث، يجب أن يكون المتصل الذي تمّت مصادقته عضوًا في المساحة. للاطّلاع على مثال، راجِع الحصول على تفاصيل حول حدث من مساحة Chat في Google Chat.
|
| GetSpaceNotificationSetting |
|---|
|
تعرض هذه الطريقة إعدادات الإشعارات في المساحة. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على إعدادات إشعارات المساحة الخاصة بالمتصل. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| GetSpaceReadState |
|---|
|
تعرض هذه الطريقة تفاصيل حول حالة القراءة لدى المستخدم في مساحة معيّنة، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، يُرجى الرجوع إلى الحصول على تفاصيل حول حالة قراءة مساحة مستخدم. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| GetThreadReadState |
|---|
|
تعرض هذه الطريقة تفاصيل حول حالة قراءة المستخدم ضمن سلسلة محادثات، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، يُرجى الانتقال إلى الحصول على تفاصيل حول حالة قراءة سلسلة محادثات المستخدم. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| ListCustomEmojis |
|---|
|
تعرض هذه الطريقة رموز الإيموجي المخصّصة المرئية للمستخدم الذي تمّت مصادقته. لا تتوفّر رموز الإيموجي المخصّصة إلا لحسابات Google Workspace، ويجب أن يفعّلها المشرف للمؤسسة. لمزيد من المعلومات، يُرجى الاطّلاع على التعرّف على رموز الإيموجي المخصّصة في Google Chat وإدارة أذونات رموز الإيموجي المخصّصة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| ListMemberships |
|---|
|
تعرض هذه الطريقة عضويات المساحة. للاطّلاع على مثال، راجِع قائمة المستخدمين وتطبيقات Google Chat في مساحة. تعرض الاشتراكات التي تتضمّن مصادقة التطبيق الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكنها تستبعد اشتراكات تطبيق Chat، بما في ذلك اشتراكه الخاص. تعرض قائمة العضويات التي تتضمّن مصادقة المستخدم العضويات في المساحات التي يمكن للمستخدم المصادَق عليه الوصول إليها. يتيح الأنواع التالية من المصادقة:
|
| ListMessagePins |
|---|
|
تعرض هذه الطريقة قائمة بدبابيس الرسائل في مساحة. يمكن للمستخدمين تثبيت الرسائل المهمة في المساحات لتسهيل الوصول إليها. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تثبيت محادثة أو إلغاء تثبيتها في Google Chat. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| ListMessages |
|---|
|
تدرِج هذه الطريقة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء والمساحات المحظورة. لا يتم تضمين رسائل النظام، مثل الرسائل التي تعلن عن أعضاء جدد في المساحة. إذا أدرجت رسائل من مساحة لا تتضمّن أي رسائل، سيكون الردّ عبارة عن عنصر فارغ. عند استخدام واجهة REST/HTTP، تحتوي الاستجابة على عنصر JSON فارغ، يتيح الأنواع التالية من المصادقة:
|
| ListReactions |
|---|
|
تعرض هذه الطريقة قائمة بالتفاعلات مع رسالة. للحصول على مثال، اطّلِع على عرض قائمة بالتفاعلات مع رسالة. يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| ListSectionItems |
|---|
|
تعرض هذه السمة العناصر في قسم. يمكن أن تكون المساحات فقط عناصر أقسام. لمعرفة التفاصيل، يُرجى الاطّلاع على إنشاء أقسام وتنظيمها في Google Chat. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| ListSections |
|---|
|
تعرض هذه الطريقة أقسامًا متاحة لمستخدم Chat، وتساعد الأقسام المستخدمين في تجميع محادثاتهم وتخصيص قائمة المساحات المعروضة في لوحة التنقّل في Chat. لمزيد من التفاصيل، اطّلِع على إنشاء أقسام وتنظيمها في Google Chat. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| ListSpaceEvents |
|---|
|
تعرض هذه الطريقة أحداثًا من مساحة Google Chat. بالنسبة إلى كل حدث، تحتوي الحِزمة على أحدث نسخة من مرجع Chat. على سبيل المثال، إذا أدرجت أحداثًا حول أعضاء جدد في المساحة، يعرض الخادم موارد يتيح الأنواع التالية من المصادقة مع نطاق تفويض مناسب لقراءة البيانات المطلوبة:
لعرض الأحداث، يجب أن يكون المتصل الذي تمّت المصادقة عليه عضوًا في المساحة. للاطّلاع على مثال، راجِع عرض قائمة بالأحداث من مساحة Google Chat.
|
| ListSpaces |
|---|
|
تعرض هذه الطريقة المساحات التي يكون المتصل عضوًا فيها. لا يتم إدراج المحادثات الجماعية والرسائل المباشرة إلى أن يتم إرسال الرسالة الأولى. للاطّلاع على مثال، راجِع قائمة المساحات. يتيح الأنواع التالية من المصادقة:
لعرض جميع المساحات المسماة حسب مؤسسة Google Workspace، استخدِم طريقة
|
| MoveSectionItem |
|---|
|
تنقل هذه الطريقة عنصرًا من قسم إلى آخر. على سبيل المثال، إذا كان أحد الأقسام يحتوي على مساحات، يمكن استخدام هذه الطريقة لنقل مساحة إلى قسم آخر. لمزيد من التفاصيل، اطّلِع على مقالة إنشاء أقسام وتنظيمها في Google Chat. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| PositionSection |
|---|
|
تغيير نظام ترتيب قسم لمعرفة التفاصيل، يُرجى الاطّلاع على إنشاء أقسام وتنظيمها في Google Chat. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| ReplaceMessageCards |
|---|
|
لا يمكن لتطبيق Chat استبدال البطاقات في رسالة أنشأها مستخدم إلا إذا كانت الرسالة تتضمّن بطاقات أنشأها التطبيق. إذا استبدل التطبيق البطاقات بقائمة فارغة، ستتم إزالة البطاقات. بعد إزالة البطاقات، لن يتمكّن التطبيق من إضافتها مجددًا إلى الرسالة. يتطلّب مصادقة التطبيق باستخدام نطاق التفويض: -
|
| SearchMessages |
|---|
|
للبحث في جميع المساحات التي يمكن للمستخدم الوصول إليها، اضبط لا تعرض واجهة برمجة التطبيقات هذه جميع أنواع الرسائل. لا يتم تضمين أنواع الرسائل المدرَجة أدناه في الرد. استخدِم
يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| SearchSpaces |
|---|
|
تعرض هذه الطريقة قائمة بالمساحات في مؤسسة Google Workspace استنادًا إلى عملية بحث يجريها المشرف. في الطلب، اضبط قيمة يتطلب ذلك مصادقة المستخدم باستخدام امتيازات المشرف وأحد نطاقات التفويض التالية:
|
| SetUpSpace |
|---|
|
تنشئ هذه الطريقة مساحة وتضيف إليها المستخدمين المحدّدين. تتم إضافة المستخدم الذي يجري المكالمة تلقائيًا إلى المساحة، ويجب عدم تحديده كعضو في الطلب. للاطّلاع على مثال، راجِع إعداد مساحة مع أعضاء أوليين. لتحديد الأعضاء من المستخدمين الذين تريد إضافتهم، أضِف عضويات باستخدام لتحديد مجموعات Google التي تريد إضافتها، أضِف عضويات باستخدام في مساحة تحمل اسمًا أو محادثة جماعية، إذا حظر المتصل بعض الأعضاء أو تم حظره من قِبلهم أو لم يكن لديه إذن بإضافة بعض الأعضاء، لن تتم إضافة هؤلاء الأعضاء إلى المساحة التي تم إنشاؤها. لإنشاء رسالة مباشرة بين المستخدم الذي يجري المكالمة ومستخدم آخر، حدِّد عضوية واحدة فقط لتمثيل المستخدم الآخر. إذا حظر أحد المستخدمَين الآخر، سيتعذّر إرسال الطلب ولن يتم إنشاء الرسالة المباشرة. لإنشاء رسالة مباشرة بين المستخدم الذي يجري المكالمة والتطبيق الذي يجريها، اضبط قيمة إذا كانت هناك رسالة مباشرة بين مستخدمَين، حتى إذا حظر أحدهما الآخر في وقت تقديم الطلب، سيتم عرض الرسالة المباشرة الحالية. لا يمكن استخدام المساحات التي تتضمّن ردودًا في سلاسل منفصلة. إذا ظهرت لك رسالة الخطأ يتطلّب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
|
| UpdateMembership |
|---|
|
تعدّل هذه الطريقة العضوية. للحصول على مثال، يُرجى الاطّلاع على تعديل عضوية مستخدم في مساحة. يتيح الأنواع التالية من المصادقة:
|
| UpdateMessage |
|---|
|
تعدّل هذه الطريقة رسالة. هناك فرق بين الطريقتَين يتيح الأنواع التالية من المصادقة:
عند استخدام مصادقة التطبيق، يمكن للطلبات تعديل الرسائل التي أنشأها تطبيق Chat الذي يجري المكالمة فقط.
|
| UpdateSection |
|---|
|
تعدّل هذه الطريقة قسمًا، ولا يمكن تعديل سوى الأقسام من النوع يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| UpdateSpace |
|---|
|
تعدّل هذه الطريقة مساحة. للاطّلاع على مثال، يُرجى الانتقال إلى تعديل مساحة. إذا كنت تعدّل الحقل يتيح الأنواع التالية من المصادقة:
تنطبق القيود التالية على مصادقة التطبيق:
|
| UpdateSpaceNotificationSetting |
|---|
|
تعديل إعدادات الإشعارات في المساحة للاطّلاع على مثال، يُرجى الرجوع إلى تعديل إعدادات الإشعارات في مساحة المتصل. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
| UpdateSpaceReadState |
|---|
|
تعدّل هذه الطريقة حالة القراءة لدى المستخدم في مساحة معيّنة، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. للاطّلاع على مثال، راجِع تعديل حالة قراءة مساحة مستخدم. يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:
|
AccessoryWidget
عنصر واجهة مستخدم تفاعلي واحد أو أكثر يظهر في أسفل الرسالة. لمزيد من التفاصيل، اطّلِع على إضافة عناصر واجهة مستخدم تفاعلية في أسفل الرسالة.
| الحقول | |
|---|---|
حقل الربط action نوع الإجراء يمكن أن يكون التعليق action إحدى القيم التالية فقط: |
|
button_list |
تمثّل هذه السمة قائمة بالأزرار. |
ActionResponse
المَعلمات التي يمكن أن يستخدمها تطبيق Chat لتحديد طريقة نشر الرد.
| الحقول | |
|---|---|
type |
الإدخال فقط نوع رد تطبيق Chat |
url |
الإدخال فقط عنوان URL الذي يمكن للمستخدمين استخدامه للمصادقة أو الإعداد (لأنواع الردود |
dialog_action |
الإدخال فقط ردّ على حدث تفاعلي مرتبط بمربّع حوار يجب أن يكون مصحوبًا بـ |
updated_widget |
الإدخال فقط ردّ التطبيق المصغّر المعدَّل |
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. |
UpdatedWidget
بالنسبة إلى عناصر واجهة المستخدم selectionInput، تعرض هذه السمة اقتراحات الإكمال التلقائي لقائمة اختيار متعدّد.
| الحقول | |
|---|---|
widget |
معرّف التطبيق المصغّر الذي تم تعديله، ويجب أن يتطابق مع معرّف التطبيق المصغّر الذي أطلق طلب التعديل. |
حقل الربط updated_widget تم تعديل التطبيق المصغّر استجابةً لإجراء من المستخدم. يمكن أن يكون التعليق updated_widget إحدى القيم التالية فقط: |
|
suggestions |
قائمة بنتائج الإكمال التلقائي للتطبيقات المصغّرة |
ActionStatus
تمثّل هذه السمة حالة طلب استدعاء مربّع حوار أو إرساله.
| الحقول | |
|---|---|
status_code |
رمز الحالة |
user_facing_message |
الرسالة التي سيتم إرسالها إلى المستخدمين بشأن حالة طلبهم. إذا لم يتم ضبطها، سيتم إرسال رسالة عامة استنادًا إلى |
تعليق توضيحي
النتائج فقط. يمكن ربط التعليقات التوضيحية بنص الرسالة العادي أو بالشرائح التي تتضمّن روابط تؤدي إلى مراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google" مع start_index وlength بقيمة 0. لإضافة تنسيق أساسي إلى رسالة نصية، اطّلِع على تنسيق الرسائل النصية.
مثال على نص الرسالة العادي:
Hello @FooBot how are you!"
البيانات الوصفية للتعليقات التوضيحية ذات الصلة:
"annotations":[{
"type":"USER_MENTION",
"startIndex":6,
"length":7,
"userMention": {
"user": {
"name":"users/{user}",
"displayName":"FooBot",
"avatarUrl":"https://goo.gl/aeDtrS",
"type":"BOT"
},
"type":"MENTION"
}
}]
| الحقول | |
|---|---|
type |
تمثّل هذه السمة نوع التعليق التوضيحي. |
length |
طول السلسلة الفرعية في نص الرسالة العادي الذي يتوافق مع هذا التعليق التوضيحي. في حال عدم توفّرها، تشير إلى مدة 0. |
start_index |
فهرس البداية (يبدأ من 0، ويشمل القيمة) في نص الرسالة العادي الذي يتوافق مع هذا التعليق التوضيحي. |
حقل الربط metadata بيانات وصفية إضافية حول التعليق التوضيحي يمكن أن يكون التعليق metadata إحدى القيم التالية فقط: |
|
user_mention |
البيانات الوصفية لإشارة المستخدم |
slash_command |
البيانات الوصفية لأمر يبدأ بشرطة مائلة |
rich_link_metadata |
تمثّل هذه السمة البيانات الوصفية الخاصة برابط تفاعلي. |
custom_emoji_metadata |
البيانات الوصفية لرمز إيموجي مخصّص |
AnnotationType
تمثّل هذه السمة نوع التعليق التوضيحي.
| عمليات التعداد | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
USER_MENTION |
تمت الإشارة إلى مستخدم. |
SLASH_COMMAND |
يتم استدعاء أمر يبدأ بشرطة مائلة. |
RICH_LINK |
تعليق توضيحي لرابط تفاعلي |
CUSTOM_EMOJI |
تعليق توضيحي لرمز إيموجي مخصّص |
AppCommandMetadata
البيانات الوصفية حول أمر تطبيق Chat
| الحقول | |
|---|---|
app_command_id |
معرّف الأمر المحدّد في إعدادات Chat API |
app_command_type |
نوع أمر تطبيق Chat. |
AppCommandType
نوع أمر تطبيق Chat. لمزيد من التفاصيل، يُرجى الاطّلاع على أنواع أوامر تطبيقات Chat.
| عمليات التعداد | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
القيمة التلقائية غير محدد |
SLASH_COMMAND |
أمر يبدأ بشرطة مائلة يرسل المستخدم الأمر في رسالة Chat. |
QUICK_COMMAND |
طلب سريع يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسالة. |
MESSAGE_ACTION |
إجراء مقترح يختار المستخدم الأمر من قائمة السياق الخاصة بالرسالة في Chat. |
AttachedGif
صورة GIF محدّدة بعنوان URL.
| الحقول | |
|---|---|
uri |
للعرض فقط: عنوان URL الذي يستضيف صورة GIF. |
مرفق
مرفق في Google Chat
| الحقول | |
|---|---|
name |
المعرّف. اسم المرفق التنسيق: |
content_name |
النتائج فقط. اسم الملف الأصلي للمحتوى، وليس المسار الكامل |
content_type |
لإخراج البيانات فقط، يمثّل نوع المحتوى (نوع MIME) للملف. |
thumbnail_uri |
للقراءة فقط. عنوان URL الخاص بالصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق للمستخدم. يجب ألا تستخدم تطبيقات Chat عنوان URL هذا لتنزيل محتوى المرفق. |
download_uri |
يتم عرض هذا الحقل فقط. يمثّل عنوان URL للتنزيل الذي يجب استخدامه للسماح للمستخدم بتنزيل المرفق. يجب ألا تستخدم تطبيقات المحادثة عنوان URL هذا لتنزيل محتوى المرفق. |
source |
النتائج فقط. مصدر المرفق |
حقل الربط data_ref مرجع البيانات إلى المرفق. يمكن أن يكون التعليق data_ref إحدى القيم التالية فقط: |
|
attachment_data_ref |
اختياريّ. مرجع إلى بيانات المرفق. يُستخدَم هذا الحقل لإنشاء الرسائل أو تعديلها مع المرفقات، أو مع Media API لتنزيل بيانات المرفقات. |
drive_data_ref |
للقراءة فقط. مرجع إلى مرفق Google Drive. يتم استخدام هذا الحقل مع Google Drive API. |
المصدر
مصدر المرفق
| عمليات التعداد | |
|---|---|
SOURCE_UNSPECIFIED |
محجوزة |
DRIVE_FILE |
الملف هو ملف Google Drive. |
UPLOADED_CONTENT |
يتم تحميل الملف إلى Chat. |
AttachmentDataRef
مرجع إلى بيانات المرفق.
| الحقول | |
|---|---|
resource_name |
اختياريّ. اسم مصدر بيانات المرفق يُستخدَم هذا الحقل مع واجهة برمجة تطبيقات الوسائط لتنزيل بيانات المرفقات. |
attachment_upload_token |
اختياريّ. رمز مميّز غير شفاف يحتوي على مرجع إلى مرفق تم تحميله. يتم التعامل معها من قِبل العملاء كسلسلة غير شفافة، ويتم استخدامها لإنشاء رسائل Chat أو تعديلها مع المرفقات. |
CalendarEventLinkData
بيانات روابط الأحداث في "تقويم Google"
| الحقول | |
|---|---|
calendar_id |
معرّف التقويم المرتبط. |
event_id |
معرّف الحدث لحدث "تقويم Google" المرتبط |
CardWithId
بطاقة في رسالة Google Chat
يمكن لتطبيقات Chat إنشاء بطاقات تتضمّن مصادقة التطبيق. في إطار برنامج معاينة المطوّرين، إذا كان تطبيق Chat يصادق على هوية المستخدم، يمكنه إنشاء رسائل على شكل بطاقات. إذا لم يكن تطبيق Chat جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتضمّن مصادقة المستخدم.
للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، اطّلِع على إرسال رسالة.
تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات"
فتح "أداة إنشاء البطاقات"| الحقول | |
|---|---|
card_id |
يجب توفيره إذا كانت الرسالة تحتوي على بطاقات متعددة، وهو معرّف فريد لبطاقة في رسالة. |
card |
بطاقة. الحد الأقصى للحجم هو 32 كيلوبايت. |
ChatSpaceLinkData
بيانات روابط مساحة Chat
| الحقول | |
|---|---|
space |
مساحة مورد مساحة Chat المرتبطة التنسيق: |
thread |
سلسلة محادثات مورد مساحة Chat المرتبطة التنسيق: |
message |
رسالة مورد مساحة Chat المرتبطة التنسيق: |
CompleteImportSpaceRequest
طلب رسالة لإكمال عملية استيراد البيانات إلى مساحة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد لمساحة وضع الاستيراد. التنسيق: |
CompleteImportSpaceResponse
رسالة الردّ عند إكمال عملية استيراد البيانات لمساحة
| الحقول | |
|---|---|
space |
مساحة وضع الاستيراد |
ContextualAddOnMarkup
لا يتضمّن هذا النوع أي حقول.
الترميز الذي يتيح للمطوّرين تحديد محتوى AddOn السياقي
بطاقة
البطاقة هي أحد عناصر واجهة المستخدم التي يمكن أن تحتوي على أدوات واجهة المستخدم، مثل النصوص والصور.
| الحقول | |
|---|---|
header |
عنوان البطاقة، وعادةً ما يحتوي على عنوان وصورة. |
sections[] |
يتم فصل الأقسام بخط فاصل. |
card_actions[] |
تمثّل هذه السمة إجراءات البطاقة. |
name |
اسم البطاقة |
CardAction
إجراء البطاقة هو الإجراء المرتبط بالبطاقة. بالنسبة إلى بطاقة الفاتورة، يكون الإجراء النموذجي كما يلي: حذف الفاتورة أو إرسال الفاتورة عبر البريد الإلكتروني أو فتح الفاتورة في المتصفّح.
غير متاح في تطبيقات Google Chat
| الحقول | |
|---|---|
action_label |
كان يتم عرض التصنيف في عنصر قائمة الإجراءات. |
on_click |
الإجراء onclick لبند العمل هذا. |
CardHeader
| الحقول | |
|---|---|
title |
يجب تحديد العنوان، ويكون للرأس ارتفاع ثابت: إذا تم تحديد عنوان وعنوان فرعي، سيشغل كل منهما سطرًا واحدًا، أما إذا تم تحديد العنوان فقط، فسيشغل كلا السطرين. |
subtitle |
تمثّل هذه السمة العنوان الفرعي لعنوان البطاقة. |
image_style |
نوع الصورة (على سبيل المثال، حدود مربّعة أو حدود دائرية) |
image_url |
عنوان URL الخاص بالصورة في عنوان البطاقة |
ImageStyle
| عمليات التعداد | |
|---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
حدود مربّعة |
AVATAR |
حدود دائرية |
القسم
يحتوي القسم على مجموعة من الأدوات التي يتم عرضها (عموديًا) بالترتيب المحدّد. في جميع المنصات، تكون البطاقات ذات عرض ثابت ضيق، لذا لا حاجة حاليًا إلى خصائص التنسيق (مثل، float).
| الحقول | |
|---|---|
header |
عنوان القسم، ويمكن استخدام نص منسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace". |
widgets[] |
يجب أن يحتوي القسم على أداة واحدة على الأقل. |
CreateCustomEmojiRequest
طلب لإنشاء رمز إيموجي مخصّص
| الحقول | |
|---|---|
custom_emoji |
الحقل مطلوب. رمز الإيموجي المخصّص الذي تريد إنشاءه |
CreateMembershipRequest
رسالة طلب إنشاء عضوية
| الحقول | |
|---|---|
parent |
الحقل مطلوب. تمثّل هذه السمة الاسم المعرّف للمساحة التي سيتم إنشاء العضوية فيها. التنسيق: spaces/{space} |
membership |
الحقل مطلوب. تمثّل هذه السمة علاقة العضوية التي سيتم إنشاؤها. يجب أن يحتوي الحقل عندما ينشئ تطبيق Chat علاقة عضوية لمستخدم بشري، يجب أن يستخدم نطاقات تفويض معيّنة ويضبط قيمًا محدّدة لحقول معيّنة:
تتطلّب دعوة مستخدمين من خارج مؤسسة Workspace التي تملك المساحة مصادقة المستخدم. عندما ينشئ تطبيق Chat علاقة عضوية لنفسه، يجب أن يصادق على هويته كمستخدم ويستخدم النطاق |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب لا يمكن إنشاء عضويات في التطبيقات أو إنشاء عضويات للمستخدمين خارج مؤسسة Google Workspace الخاصة بالمشرف باستخدام إذن الوصول كمشرف. |
CreateMessageNotificationOptions
خيارات سلوك الإشعارات عند نشر الرسالة
| الحقول | |
|---|---|
notification_type |
نوع الإشعار للرسالة. |
NotificationType
خيارات أنواع الإشعارات للرسالة.
| عمليات التعداد | |
|---|---|
NOTIFICATION_TYPE_NONE |
السلوك التلقائي يكون سلوك الإشعارات مشابهًا للحالة التي يرسل فيها المستخدم البشري الرسالة باستخدام واجهة مستخدم Chat: لا يتم إرسال أي إشعار إلى المُرسِل البشري. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
فرض إرسال إشعارات إلى المستلمين: يؤدي هذا الخيار إلى تجاوز إعدادات إشعارات المساحة وإعدادات "عدم الإزعاج" في Chat لدى المستخدمين، ولكنّه لا يتجاوز إعدادات "عدم الإزعاج" على مستوى الجهاز. يتطلّب ذلك مصادقة التطبيق. |
NOTIFICATION_TYPE_SILENT |
كتم صوت الإشعار كما لو أنّ المستلمين فعّلوا ميزة عدم الإزعاج في Chat أو كتموا صوت المساحة يتطلّب ذلك مصادقة التطبيق. |
CreateMessagePinRequest
طلب رسالة لإنشاء دبوس رسالة
| الحقول | |
|---|---|
parent |
الحقل مطلوب. المساحة الرئيسية التي سيتم إنشاء دبوس الرسالة فيها التنسيق: spaces/{space} |
message_pin |
الحقل مطلوب. تمثّل هذه السمة MessagePin المطلوب إنشاؤه. |
CreateMessageRequest
تنشئ هذه الطريقة رسالة.
| الحقول | |
|---|---|
parent |
الحقل مطلوب. اسم المورد للمساحة التي سيتم إنشاء الرسالة فيها. التنسيق: |
message |
الحقل مطلوب. نص الرسالة |
thread_key |
اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
request_id |
اختياريّ. معرّف طلب فريد لهذه الرسالة. يؤدي تحديد رقم تعريف طلب حالي إلى عرض الرسالة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء رسالة جديدة. |
message_reply_option |
اختياريّ. تحدّد هذه السمة ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة. عند الردّ على تفاعلات المستخدمين، يتم تجاهل هذا الحقل. بالنسبة إلى التفاعلات ضمن سلسلة محادثات، يتم إنشاء الرد في سلسلة المحادثات نفسها. في الحالات الأخرى، يتم إنشاء الرد كسلسلة محادثات جديدة. |
message_id |
اختياريّ. معرّف مخصّص للرسالة. تتيح تطبيقات Lets Chat الحصول على رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين المعرّف الذي يحدّده النظام في اسم مورد الرسالة (الممثّل في حقل الرسالة يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية:
لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة. |
create_message_notification_options |
اختياريّ. تتحكّم هذه السمة في سلوك الإشعارات عند نشر الرسالة. لمزيد من المعلومات، يُرجى الاطّلاع على فرض الإشعارات أو إرسال رسائل صامتة. |
MessageReplyOption
تحدّد هذه السمة كيفية الردّ على رسالة. وقد تتم إضافة المزيد من الولايات في المستقبل.
| عمليات التعداد | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
تلقائي: يبدأ سلسلة محادثات جديدة. يؤدي استخدام هذا الخيار إلى تجاهل أي thread ID أو مضمّنة. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
تنشئ هذه الطريقة الرسالة كردّ على سلسلة المحادثات المحدّدة بواسطة thread ID أو . وفي حال تعذّر ذلك، تبدأ الرسالة سلسلة محادثات جديدة بدلاً من ذلك. |
REPLY_MESSAGE_OR_FAIL |
تنشئ هذه الطريقة الرسالة كردّ على سلسلة المحادثات المحدّدة بواسطة thread ID أو . إذا تم استخدام thread_key جديد، سيتم إنشاء سلسلة محادثات جديدة. إذا تعذّر إنشاء الرسالة، سيتم عرض الخطأ NOT_FOUND بدلاً من ذلك. |
CreateReactionRequest
إنشاء تفاعل مع رسالة
| الحقول | |
|---|---|
parent |
الحقل مطلوب. الرسالة التي تم إنشاء التفاعل فيها التنسيق: |
reaction |
الحقل مطلوب. التفاعل المطلوب إنشاؤه |
CreateSectionRequest
رسالة طلب إنشاء قسم
| الحقول | |
|---|---|
parent |
الحقل مطلوب. اسم المورد الرئيسي الذي تم إنشاء القسم فيه. التنسيق: |
section |
الحقل مطلوب. القسم المطلوب إنشاؤه |
CreateSpaceRequest
طلب إنشاء مساحة مسماة بدون أعضاء
| الحقول | |
|---|---|
space |
الحقل مطلوب. يجب ملء الحقلَين إذا ظهرت لك رسالة الخطأ يتم تحديد المساحة |
request_id |
اختياريّ. معرّف فريد لهذا الطلب. يُنصح باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد معرّف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض خطأ. |
CustomEmoji
يمثّل هذا النوع رمز إيموجي مخصّص.
| الحقول | |
|---|---|
name |
المعرّف. اسم مصدر الإيموجي المخصّص، الذي يحدّده الخادم التنسيق: |
uid |
النتائج فقط. مفتاح فريد لمصدر رموز الإيموجي المخصّصة. |
emoji_name |
اختياريّ. غير قابل للتغيير اسم الإيموجي المخصّص الذي يقدّمه المستخدم، وهو اسم فريد داخل المؤسسة. مطلوب عند إنشاء رمز الإيموجي المخصّص، ويتم عرض الناتج فقط في الحالات الأخرى. يجب أن تبدأ أسماء رموز الإيموجي وتنتهي بعلامة النقطتين، ويجب أن تكون بأحرف صغيرة ويمكن أن تحتوي فقط على أحرف أبجدية رقمية وواصلات وشرطات سفلية. يجب استخدام الواصلات والشرطات السفلية لفصل الكلمات ولا يمكن استخدامها بشكل متتابع. مثلاً: |
temporary_image_uri |
النتائج فقط. عنوان URL مؤقت للصورة الخاصة برمز الإيموجي المخصّص، ويكون صالحًا لمدة 10 دقائق على الأقل. يُرجى العِلم أنّه لا تتم تعبئة هذا الحقل في الردّ عند إنشاء رمز الإيموجي المخصّص. |
payload |
اختياريّ. الإدخال فقط بيانات الحمولة مطلوب عند إنشاء رمز الإيموجي المخصّص. |
CustomEmojiPayload
بيانات الحمولة لرمز الإيموجي المخصّص
| الحقول | |
|---|---|
file_content |
الحقل مطلوب. الإدخال فقط الصورة المستخدَمة لرمز الإيموجي المخصّص يجب أن يكون حجم الحمولة أقل من 256 كيلوبايت وأن يكون حجم الصورة مربعًا ويتراوح بين 64 و500 بكسل. هذه القيود قابلة للتغيير. |
filename |
الحقل مطلوب. الإدخال فقط اسم ملف الصورة امتدادات الملفات المتوافقة: |
CustomEmojiMetadata
البيانات الوصفية الخاصة بالتعليقات التوضيحية لرموز الإيموجي المخصّصة
| الحقول | |
|---|---|
custom_emoji |
رمز الإيموجي المخصّص |
DeleteCustomEmojiRequest
طلب حذف إيموجي مخصّص
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد الخاص بالإيموجي المخصّص المطلوب حذفه. التنسيق: يمكنك استخدام اسم الإيموجي كاسم مستعار لـ |
DeleteMembershipRequest
طلب حذف عضوية في مساحة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الاشتراك المطلوب حذفه. يمكن لتطبيقات المحادثة حذف عضويات المستخدمين أو عضوياتها. لا يمكن لتطبيقات المحادثة حذف عضويات التطبيقات الأخرى. عند حذف عضوية مستخدم، يجب استخدام النطاق عند حذف عضوية في تطبيق، يجب استخدام النطاق التنسيق: |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب لا يمكن حذف اشتراكات التطبيقات في مساحة باستخدام إذن الوصول كمشرف. |
DeleteMessagePinRequest
طلب رسالة لحذف تثبيت رسالة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد تثبيت الرسالة المطلوب إزالته. التنسيق: spaces/{space}/messagePins/{message_pin} |
DeleteMessageRequest
طلب حذف رسالة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الرسالة التنسيق: إذا كنت قد ضبطت معرّفًا مخصّصًا لرسالتك، يمكنك استخدام القيمة من الحقل |
force |
اختياريّ. عند لا ينطبق هذا الإعداد إلا عند المصادقة كمستخدم. ليس له أي تأثير عند المصادقة كتطبيق Chat. |
DeleteReactionRequest
يحذف هذا الإجراء تفاعلاً مع رسالة.
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم التفاعل المطلوب حذفه التنسيق: |
DeleteSectionRequest
رسالة الطلب لحذف قسم
| الحقول | |
|---|---|
name |
الحقل مطلوب. تمثّل هذه السمة اسم القسم المطلوب حذفه. التنسيق: |
DeleteSpaceRequest
طلب حذف مساحة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد للمساحة المطلوب حذفها. التنسيق: |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب |
DeletionMetadata
معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط delete_time.
| الحقول | |
|---|---|
deletion_type |
تشير إلى المستخدم الذي حذف الرسالة. |
DeletionType
مَن حذف الرسالة وكيف تم حذفها قد تتم إضافة المزيد من القيم في المستقبل. اطّلِع على مقالة تعديل رسالة أو حذفها في Google Chat للحصول على تفاصيل حول الحالات التي يمكن فيها حذف الرسائل.
| عمليات التعداد | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
هذه القيمة غير مستخدَمة. |
CREATOR |
حذف المستخدم رسالته. |
SPACE_OWNER |
حذف مالك أو مدير الرسالة. |
ADMIN |
حذف مشرف حسابات Google Workspace الرسالة. يمكن للمشرفين حذف أي رسالة في المساحة، بما في ذلك الرسائل المرسَلة من أي عضو في المساحة أو تطبيق Chat. |
APP_MESSAGE_EXPIRY |
حذف تطبيق Chat رسالته الخاصة عند انتهاء صلاحيتها. |
CREATOR_VIA_APP |
حذف تطبيق Chat الرسالة نيابةً عن المنشئ (باستخدام مصادقة المستخدم). |
SPACE_OWNER_VIA_APP |
حذف تطبيق Chat الرسالة نيابةً عن مدير المساحة (باستخدام مصادقة المستخدم). |
SPACE_MEMBER |
حذف أحد أعضاء المساحة الرسالة، ويمكن للمستخدمين حذف الرسائل التي ترسلها التطبيقات. |
مربّع حوار
حاوية حول نص بطاقة مربّع الحوار
| الحقول | |
|---|---|
body |
الإدخال فقط نص مربع الحوار الذي يتم عرضه في نافذة مشروطة لا تتوافق تطبيقات Google Chat مع عناصر البطاقات التالية: |
DialogAction
يحتوي على مربّع حوار ورمز حالة الطلب.
| الحقول | |
|---|---|
action_status |
الإدخال فقط حالة طلب استدعاء مربّع حوار أو إرساله تعرِض هذه السمة حالة ورسالة للمستخدمين، إذا لزم الأمر. على سبيل المثال، في حال حدوث خطأ أو نجاح. |
حقل الربط action الإجراء المطلوب تنفيذه يمكن أن يكون التعليق action إحدى القيم التالية فقط: |
|
dialog |
الإدخال فقط مربّع الحوار الخاص بالطلب |
DriveDataRef
مرجع إلى بيانات مرفق في Drive
| الحقول | |
|---|---|
drive_file_id |
معرّف ملف Drive الاستخدام مع Drive API |
DriveLinkData
بيانات روابط Google Drive
| الحقول | |
|---|---|
drive_data_ref |
DriveDataRef يشير إلى ملف في Google Drive |
mime_type |
نوع MIME الخاص بالملف المرتبط في Google Drive. |
رموز الإيموجي
إيموجي يُستخدم للتفاعل مع رسالة
| الحقول | |
|---|---|
حقل الربط content الحقل مطلوب. محتوى الإيموجي يمكن أن يكون التعليق content إحدى القيم التالية فقط: |
|
unicode |
اختياريّ. إيموجي أساسي ممثّل بسلسلة يونيكود |
custom_emoji |
رمز إيموجي مخصّص |
EmojiReactionSummary
عدد المستخدمين الذين تفاعلوا مع رسالة باستخدام إيموجي معيّن
| الحقول | |
|---|---|
emoji |
النتائج فقط. الإيموجي المرتبط بالتفاعلات |
reaction_count |
النتائج فقط. تمثّل هذه السمة إجمالي عدد التفاعلات باستخدام الإيموجي المرتبط. |
FindDirectMessageRequest
طلب للحصول على مساحة رسالة مباشرة استنادًا إلى مورد المستخدم
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد الخاص بالمستخدم الذي تريد العثور على رسالة مباشرة معه. التنسيق: |
FindGroupChatsRequest
طلب للحصول على مساحات المحادثات الجماعية استنادًا إلى موارد المستخدم.
| الحقول | |
|---|---|
users[] |
اختياريّ. أسماء الموارد لجميع المستخدمين من البشر في محادثة جماعية مع المستخدم الذي يجري المكالمة لا يمكن تضمين تطبيقات المحادثات في الطلب. الحدّ الأقصى لعدد المستخدمين الذين يمكن تحديدهم في طلب واحد هو التنسيق: |
page_size |
اختياريّ. الحد الأقصى لعدد المساحات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 10 مساحات على الأكثر. الحد الأقصى للقيمة هو 30. إذا استخدمت قيمة أكبر من 30، سيتم تغييرها تلقائيًا إلى 30. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب سابق للعثور على محادثات جماعية قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم الرمز المميّز. قد يؤدي تمرير قيم مختلفة إلى نتائج غير متوقّعة. |
space_view |
نوع عرض المساحة المطلوب إذا لم يتم ضبطها، يتم ضبط القيمة التلقائية على |
FindGroupChatsResponse
استجابة تحتوي على مساحات محادثة جماعية تضم المستخدم الذي يجري المكالمة والمستخدمين المطلوبين فقط
| الحقول | |
|---|---|
spaces[] |
قائمة المساحات في الصفحة المطلوبة (أو الصفحة الأولى) |
next_page_token |
رمز مميّز يمكنك إرساله كـ |
ForwardedMetadata
بيانات وصفية حول المساحة المصدر التي تمّت إعادة توجيه الرسالة منها.
| الحقول | |
|---|---|
space |
النتائج فقط. اسم المورد الخاص بالمساحة المصدر التنسيق: spaces/{space} |
space_display_name |
هذه السمة مخصّصة للإخراج فقط. وهي تمثّل الاسم المعروض للمساحة المصدر أو الرسالة المباشرة في وقت إعادة التوجيه. بالنسبة إلى |
GetAttachmentRequest
طلب الحصول على مرفق
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مصدر المرفق، بالتنسيق |
GetCustomEmojiRequest
طلب لعرض رمز إيموجي مخصّص واحد
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الإيموجي المخصّص التنسيق: يمكنك استخدام اسم الإيموجي كاسم مستعار لـ |
GetMembershipRequest
طلب الحصول على عضوية في مساحة
| الحقول | |
|---|---|
name |
الحقل مطلوب. تمثّل هذه السمة اسم المورد الخاص بالاشتراك المطلوب استرداده. للحصول على عضوية التطبيق باستخدام مصادقة المستخدم، يمكنك اختياريًا استخدام التنسيق: يمكنك استخدام عنوان البريد الإلكتروني للمستخدم كاسم مستعار لـ |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب لا تتوفّر إمكانية الحصول على اشتراكات في التطبيقات في مساحة عند استخدام إذن الوصول كمشرف. |
GetMessageRequest
طلب تلقّي رسالة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الرسالة التنسيق: إذا كنت قد ضبطت معرّفًا مخصّصًا لرسالتك، يمكنك استخدام القيمة من الحقل |
GetSpaceEventRequest
طلب رسالة للحصول على حدث في مساحة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد لحدث المساحة التنسيق: |
GetSpaceNotificationSettingRequest
طلب رسالة للحصول على إعدادات إشعارات المساحة يتيح هذا الإجراء الحصول على إعدادات الإشعارات للمستخدم الذي يجري المكالمة فقط.
| الحقول | |
|---|---|
name |
الحقل مطلوب. التنسيق: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
رسالة الطلب لواجهة برمجة التطبيقات GetSpaceReadState
| الحقول | |
|---|---|
name |
الحقل مطلوب. تمثّل هذه السمة اسم المورد لحالة القراءة في المساحة التي سيتم استردادها. يتيح هذا الإذن الحصول على حالة القراءة للمستخدم الذي يجري المكالمة فقط. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارَين التاليَين:
التنسيق: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
طلب إرجاع مساحة واحدة
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد الخاص بالمساحة، بالصيغة التنسيق: |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب |
GetThreadReadStateRequest
رسالة الطلب لواجهة برمجة التطبيقات GetThreadReadStateRequest
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مصدر حالة قراءة سلسلة المحادثات المطلوب استردادها. يتيح هذا الإذن الحصول على حالة القراءة للمستخدم الذي يجري المكالمة فقط. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارَين التاليَين:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
مجموعة
مجموعة Google في Google Chat
| الحقول | |
|---|---|
name |
اسم المورد لمجموعة Google تمثّل هذه السمة مجموعة في Cloud Identity Groups API. التنسيق: groups/{group} |
HistoryState
حالة السجلّ للرسائل والمساحات تحدّد هذه السمة مدة الاحتفاظ بالرسائل وسلاسل المحادثات بعد إنشائها.
| عمليات التعداد | |
|---|---|
HISTORY_STATE_UNSPECIFIED |
القيمة التلقائية لا تستخدم هذه السمة. |
HISTORY_OFF |
السجلّ غير مفعَّل. يتم الاحتفاظ بالرسائل وسلاسل المحادثات لمدة 24 ساعة. |
HISTORY_ON |
السجلّ مفعّل: تحدّد قواعد الاحتفاظ بالبيانات في Vault في المؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات. |
ListCustomEmojisRequest
طلب لعرض قائمة برموز إيموجي مخصّصة
| الحقول | |
|---|---|
page_size |
اختياريّ. الحد الأقصى لعدد رموز الإيموجي المخصّصة التي يتم عرضها يمكن أن تعرض الخدمة عددًا أقل من رموز الإيموجي المخصّصة مقارنةً بهذه القيمة. إذا لم يتم تحديد قيمة، ستكون القيمة التلقائية 25. الحدّ الأقصى للقيمة هو 200، ويتم تغيير القيم التي تزيد عن 200 إلى 200. |
page_token |
اختياريّ. (في حال استئناف البحث من طلب بحث سابق) رمز مميّز للصفحة تم استلامه من طلب سابق لعرض قائمة برموز إيموجي مخصّصة. يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم رمز الصفحة، لأنّ تمرير قيمة مختلفة قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث يتيح الفلترة حسب صانع المحتوى. للفلترة حسب صانع المحتوى، يجب تحديد قيمة صالحة. لا يتم حاليًا قبول سوى على سبيل المثال، يعرض طلب البحث التالي رموز إيموجي مخصّصة أنشأها المتصل: يتم رفض طلبات البحث غير الصالحة مع ظهور الخطأ |
ListCustomEmojisResponse
ردّ لعرض رموز الإيموجي المخصّصة
| الحقول | |
|---|---|
custom_emojis[] |
قائمة بدون ترتيب قائمة برموز الإيموجي المخصّصة |
next_page_token |
رمز مميّز يمكنك إرساله كـ |
ListMembershipsRequest
رسالة الطلب لعرض الاشتراكات
| الحقول | |
|---|---|
parent |
الحقل مطلوب. اسم المورد الخاص بالمساحة التي سيتم استرداد قائمة الأعضاء منها. التنسيق: spaces/{space} |
page_size |
اختياريّ. الحد الأقصى لعدد العضويات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 100 عضوية كحدّ أقصى. الحدّ الأقصى للقيمة هو 1000. وإذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميّز للصفحة تم تلقّيه من طلب سابق لعرض قائمة بالعضويات قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث يمكنك فلترة العضويات حسب دور العضو ( للفلترة حسب الدور، اضبط للفلترة حسب النوع، اضبط للتصفية حسب كل من الدور والنوع، استخدِم عامل التشغيل يجب توفُّر على سبيل المثال، الاستعلامات التالية صالحة: طلبات البحث التالية غير صالحة: يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ |
show_groups |
اختياريّ. عندما تكون القيمة |
show_invited |
اختياريّ. عندما تكون القيمة يتطلّب حاليًا مصادقة المستخدم. |
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يجب توفير نطاق OAuth 2.0 لا تتوفّر إمكانية إدراج عضويات التطبيقات في مساحة عند استخدام إذن الوصول كمشرف. |
ListMembershipsResponse
ردّ على طلب عرض عضويات المساحة
| الحقول | |
|---|---|
memberships[] |
قائمة غير مرتّبة تتضمّن العضويات في الصفحة المطلوبة (أو الصفحة الأولى) |
next_page_token |
رمز مميّز يمكنك إرساله كـ |
ListMessagePinsRequest
طلب رسالة لعرض دبابيس الرسائل في البطاقة
| الحقول | |
|---|---|
parent |
الحقل مطلوب. المساحة الرئيسية التي تملك مجموعة العناصر المثبّتة. التنسيق: |
page_size |
اختياريّ. الحد الأقصى لعدد الرسائل المثبّتة التي يتم عرضها قد تُرجع الخدمة عددًا من الرسائل أقل من هذه القيمة. الحد الأقصى للقيمة هو 100. إذا استخدمت قيمة أكبر من 100، سيتم تغييرها تلقائيًا إلى 100. إذا لم يتم تحديدها، سيتم عرض 100 رسالة مثبّتة كحد أقصى. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميز للصفحة تم استلامه من رسالة قائمة سابقة تثبّت مكالمة. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
ListMessagePinsResponse
رسالة الردّ على طلب عرض دبابيس الرسائل في البطاقة
| الحقول | |
|---|---|
message_pins[] |
الرسائل المثبّتة من المساحة المحدّدة |
next_page_token |
يمكنك إرسال رمز مميّز كـ |
ListMessagesRequest
تعرض هذه الطريقة الرسائل في المساحة المحدّدة التي يكون المستخدم عضوًا فيها.
| الحقول | |
|---|---|
parent |
الحقل مطلوب. تمثّل هذه السمة اسم المورد للمساحة التي سيتم عرض الرسائل منها. التنسيق: |
page_size |
اختياريّ. الحد الأقصى لعدد الرسائل التي يتم عرضها قد تُرجع الخدمة عددًا من الرسائل أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 25 نتيجة على الأكثر. الحدّ الأقصى للقيمة هو 1000. وإذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميز للصفحة تم استلامه من طلب سابق لعرض قائمة بالرسائل. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث يمكنك فلترة الرسائل حسب التاريخ ( لفلترة الرسائل حسب تاريخ إنشائها، حدِّد للفلترة حسب سلسلة المحادثات، حدِّد للفلترة حسب كل من السلسلة والتاريخ، استخدِم عامل التشغيل على سبيل المثال، الاستعلامات التالية صالحة: يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ |
order_by |
اختياريّ. كيفية ترتيب قائمة الرسائل تحديد قيمة للترتيب حسب عملية ترتيب في ما يلي قيم عملية الترتيب الصالحة:
الترتيب التلقائي هو |
show_deleted |
اختياريّ. تحديد ما إذا كان سيتم تضمين الرسائل المحذوفة تتضمّن الرسائل المحذوفة وقت الحذف والبيانات الوصفية المتعلقة به، ولكن لا يتوفّر محتوى الرسائل. |
ListMessagesResponse
رسالة الردّ لعرض الرسائل
| الحقول | |
|---|---|
messages[] |
قائمة الرسائل |
next_page_token |
يمكنك إرسال رمز مميّز كـ |
ListReactionsRequest
تعرض هذه السمة قائمة بردود الأفعال على رسالة.
| الحقول | |
|---|---|
parent |
الحقل مطلوب. الرسالة التي تفاعل معها المستخدمون التنسيق: |
page_size |
اختياريّ. الحدّ الأقصى لعدد التفاعلات التي يتم عرضها يمكن أن تعرض الخدمة عددًا أقل من التفاعلات مقارنةً بهذه القيمة. إذا لم يتم تحديد قيمة، ستكون القيمة التلقائية 25. الحدّ الأقصى للقيمة هو 200، ويتم تغيير القيم التي تزيد عن 200 إلى 200. |
page_token |
اختياريّ. (في حال استئناف البحث من طلب بحث سابق) رمز مميّز للصفحة تم استلامه من طلب سابق لعرض قائمة التفاعلات. يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم رمز الصفحة، لأنّ تمرير قيمة مختلفة قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث يمكنك فلترة التفاعلات حسب الإيموجي ( لفلترة التفاعلات لعدة رموز إيموجي أو مستخدمين، ادمج الحقول المتشابهة مع عامل التشغيل لفلترة التفاعلات حسب الإيموجي والمستخدم، استخدِم عامل التشغيل إذا كان طلب البحث يستخدم كلاً من على سبيل المثال، الاستعلامات التالية صالحة: طلبات البحث التالية غير صالحة: يتم رفض طلبات البحث غير الصالحة مع ظهور الخطأ |
ListReactionsResponse
ردّ على طلب عرض قائمة بالتفاعلات
| الحقول | |
|---|---|
reactions[] |
قائمة بالتفاعلات في الصفحة المطلوبة (أو الصفحة الأولى) |
next_page_token |
رمز مميز للمتابعة لاسترداد الصفحة التالية من النتائج، ويكون فارغًا لآخر صفحة من النتائج. |
ListSectionItemsRequest
رسالة الطلب لعناصر قسم بيانات المؤسسة
| الحقول | |
|---|---|
parent |
الحقل مطلوب. تمثّل هذه السمة القسم الرئيسي، أي اسم مورد القسم الذي يملك هذه المجموعة من عناصر القسم. لا يتيح سوى عرض عناصر قسم القوائم للمستخدم الذي يجري المكالمة. عند الفلترة حسب المساحة، استخدِم حرف البدل التنسيق: |
page_size |
اختياريّ. الحدّ الأقصى لعدد عناصر الأقسام المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 10 عناصر من الأقسام كحدّ أقصى. الحدّ الأقصى للقيمة هو 100. وفي حال استخدام قيمة أكبر من 100، سيتم تغييرها تلقائيًا إلى 100. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميّز للصفحة تم استلامه من طلب سابق لعناصر قسم القائمة يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث لا تتوفّر حاليًا سوى إمكانية الفلترة حسب المساحة. مثلاً: يتم رفض طلبات البحث غير الصالحة مع ظهور الخطأ |
ListSectionItemsResponse
رسالة الردّ على عناصر قسم البطاقة
| الحقول | |
|---|---|
section_items[] |
عناصر القسم من القسم المحدّد |
next_page_token |
رمز مميّز يمكن إرساله كـ |
ListSectionsRequest
طلب رسالة لأقسام بيانات الفنادق
| الحقول | |
|---|---|
parent |
الحقل مطلوب. العنصر الرئيسي، وهو اسم مورد المستخدم الذي يملك هذه المجموعة من الأقسام. يتيح فقط إدراج أقسام للمستخدم الذي يجري المكالمة. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارَين التاليَين:
التنسيق: |
page_size |
اختياريّ. الحد الأقصى لعدد الأقسام المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديد عدد، سيتم عرض 10 أقسام كحد أقصى. الحدّ الأقصى للقيمة هو 100. وفي حال استخدام قيمة أكبر من 100، سيتم تغييرها تلقائيًا إلى 100. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميّز للصفحة تم استلامه من طلب سابق لعرض أقسام القائمة يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
ListSectionsResponse
رسالة الرد لأقسام بيانات الفنادق
| الحقول | |
|---|---|
sections[] |
الأقسام من المستخدم المحدّد |
next_page_token |
رمز مميّز يمكن إرساله كـ |
ListSpaceEventsRequest
رسالة طلب لإدراج أحداث المساحات
| الحقول | |
|---|---|
parent |
الحقل مطلوب. اسم المورد لمساحة Google Chat التي وقعت فيها الأحداث. التنسيق: |
page_size |
اختياريّ. تمثّل هذه السمة الحدّ الأقصى لعدد أحداث المساحة التي يتم عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميّز للصفحة تم استلامه من طلب سابق لعرض أحداث المساحة. يجب تقديم هذا الرمز لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة لأحداث مساحة العرض مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
filter |
الحقل مطلوب. فلتر طلب البحث يجب تحديد نوع حدث واحد على الأقل ( يمكنك أيضًا فلترة البيانات حسب وقت البدء (
لتحديد وقت البدء أو الانتهاء، استخدِم عامل التشغيل يساوي على سبيل المثال، الاستعلامات التالية صالحة: طلبات البحث التالية غير صالحة: يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ |
ListSpaceEventsResponse
رسالة الردّ لعرض أحداث المساحة
| الحقول | |
|---|---|
space_events[] |
يتم عرض النتائج بترتيب زمني (الحدث الأقدم أولاً). ملاحظة: لا يتم عرض الحقل |
next_page_token |
رمز مميّز للمتابعة يُستخدَم لجلب المزيد من الأحداث. إذا تم حذف هذا الحقل، لن تكون هناك صفحات لاحقة. |
ListSpacesRequest
طلب لإدراج المساحات التي يكون المتصل عضوًا فيها
| الحقول | |
|---|---|
page_size |
اختياريّ. الحد الأقصى لعدد المساحات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 100 مساحة على الأكثر. الحدّ الأقصى للقيمة هو 1000. وإذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة الخطأ |
page_token |
اختياريّ. رمز مميّز للصفحة تم استلامه من طلب سابق لعرض قائمة بالمساحات. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم رمز الصفحة، لأنّ إدخال قيمة مختلفة قد يؤدي إلى نتائج غير متوقّعة. |
filter |
اختياريّ. فلتر طلب البحث يمكنك فلترة المساحات حسب نوع المساحة ( للفلترة حسب نوع المساحة، يجب تحديد قيمة تعداد صالحة، مثل على سبيل المثال، الاستعلامات التالية صالحة: يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ |
ListSpacesResponse
الردّ على طلب الحصول على قائمة بالمساحات
| الحقول | |
|---|---|
spaces[] |
قائمة بالمساحات في الصفحة المطلوبة (أو الصفحة الأولى). ملاحظة: لا يتم عرض الحقل |
next_page_token |
يمكنك إرسال رمز مميّز كـ |
MatchedUrl
عنوان URL مطابق في رسالة Chat يمكن لتطبيقات المحادثة معاينة عناوين URL المطابقة. لمزيد من المعلومات، يُرجى الاطّلاع على المقالة معاينة الروابط.
| الحقول | |
|---|---|
url |
النتائج فقط. عنوان URL الذي تمت مطابقته. |
MeetSpaceLinkData
بيانات روابط مساحات Meet
| الحقول | |
|---|---|
meeting_code |
رمز اجتماع مساحة Meet المرتبطة. |
type |
تشير هذه السمة إلى نوع مساحة Meet. |
huddle_status |
اختياريّ. النتائج فقط. إذا كان الاجتماع السريع عبارة عن اجتماع سريع، يشير هذا الحقل إلى حالة الاجتماع. وفي حال عدم توفّرها، يكون هذا الحقل غير مضبوط. |
HuddleStatus
حالة الاجتماع السريع
| عمليات التعداد | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
STARTED |
بدأ الاجتماع السريع. |
ENDED |
انتهى الاجتماع السريع. وفي هذه الحالة، لن يكون معرّف الموارد المنتظم (URI) ومعرّفات مساحة Meet صالحَين. |
MISSED |
لم يتم الانضمام إلى الاجتماع السريع، وفي هذه الحالة لن يكون معرّف الموارد الموحّد (URI) والمعرّفات لمساحة Meet صالحَين. |
النوع
نوع مساحة Meet.
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
MEETING |
مساحة Meet هي اجتماع. |
HUDDLE |
مساحة Meet هي اجتماع سريع. |
العضوية
تمثّل هذه السمة علاقة العضوية في Google Chat، مثل ما إذا تمت دعوة مستخدم أو تطبيق Chat إلى مساحة أو كان جزءًا منها أو غير متوفّر فيها.
| الحقول | |
|---|---|
name |
المعرّف. تمثّل هذه السمة اسم المورد الخاص بالاشتراك، والذي يحدّده الخادم. التنسيق: |
state |
النتائج فقط. تمثّل هذه السمة حالة الاشتراك. |
role |
اختياريّ. دور المستخدم في مساحة Chat، والذي يحدّد الإجراءات المسموح له بتنفيذها في المساحة لا يمكن استخدام هذا الحقل كإدخال إلا في |
create_time |
اختياريّ. غير قابل للتغيير وقت إنشاء العضوية، مثل وقت انضمام عضو إلى مساحة أو تلقّيه دعوة للانضمام إليها هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه لاستيراد العضويات السابقة في مساحات وضع الاستيراد. |
delete_time |
اختياريّ. غير قابل للتغيير وقت حذف العضوية، مثلاً عندما غادر عضو مساحة أو تمت إزالته منها هذا الحقل مخصّص للإخراج فقط، باستثناء الحالات التي يُستخدم فيها لاستيراد العضويات السابقة في مساحات وضع الاستيراد. |
حقل الربط memberType تمثّل هذه السمة العضو المرتبط بهذه العضوية. قد تتم إتاحة أنواع أخرى من الأعضاء في المستقبل. يمكن أن يكون التعليق memberType إحدى القيم التالية فقط: |
|
member |
اختياريّ. مستخدم Google Chat أو تطبيق Google Chat الذي يتوافق معه الاشتراك إذا كان تطبيق Chat يصادق كمستخدم، ستملأ النتيجة المستخدم |
group_member |
اختياريّ. مجموعة Google التي تتوافق مع العضوية تتطلّب قراءة العضويات في "مجموعات Google" أو تعديلها مصادقة المستخدم. |
MembershipRole
تمثّل هذه السمة الإجراءات المسموح بها للمستخدم في مساحة Chat. قد تتم إضافة المزيد من قيم التعداد في المستقبل.
| عمليات التعداد | |
|---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
القيمة التلقائية بالنسبة إلى users: هذا المستخدم ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى Google Groups: يتم دائمًا تعيين هذا الدور لهم (قد يتم استخدام قيم تعداد أخرى في المستقبل). |
ROLE_MEMBER |
عضو في المساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "عضو". يملك المستخدم أذونات أساسية، مثل إرسال الرسائل إلى المساحة. يمكن للمدراء والمالكين منح الأعضاء أذونات إضافية في مساحة، بما في ذلك:
في الرسائل المباشرة والمحادثات الجماعية بدون اسم، يتم منح هذا الدور لجميع المشاركين. |
ROLE_MANAGER |
مالك مساحة في واجهة مستخدم "المحادثة"، يُطلق على هذا الدور اسم "المالك". لدى المستخدم مجموعة كاملة من أذونات المساحة لإدارتها، بما في ذلك:
لا تتوفّر هذه الميزة إلا في لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مزيد من المعلومات عن دور مالك المساحة أو مديرها. |
ROLE_ASSISTANT_MANAGER |
مدير مساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "مدير". يملك المستخدم جميع الأذونات الأساسية في
تتضمّن أذونات المدراء تلقائيًا ما يلي، على سبيل المثال لا الحصر:
لا تتوفّر هذه الميزة إلا في لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إدارة إعدادات المساحة. |
MembershipState
تحدّد هذه السمة علاقة العضو بالمساحة، وقد يتم توفير حالات عضوية أخرى في المستقبل.
| عمليات التعداد | |
|---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
القيمة التلقائية لا تستخدِمها. |
JOINED |
تتم إضافة المستخدم إلى المساحة، ويمكنه المشاركة فيها. |
INVITED |
تمت دعوة المستخدم للانضمام إلى المساحة، ولكنّه لم ينضم إليها. |
NOT_A_MEMBER |
لا ينتمي المستخدم إلى المساحة وليس لديه دعوة معلّقة للانضمام إليها. |
MembershipBatchCreatedEventData
حمولة الحدث الخاصة بالاشتراكات الجديدة المتعددة
نوع الحدث: google.workspace.chat.membership.v1.batchCreated
| الحقول | |
|---|---|
memberships[] |
قائمة بالعضويات الجديدة |
MembershipBatchDeletedEventData
حمولة الحدث للعضويات المتعددة المحذوفة
نوع الحدث: google.workspace.chat.membership.v1.batchDeleted
| الحقول | |
|---|---|
memberships[] |
قائمة بالعضويات المحذوفة |
MembershipBatchUpdatedEventData
حمولة الحدث لعدة اشتراكات معدَّلة
نوع الحدث: google.workspace.chat.membership.v1.batchUpdated
| الحقول | |
|---|---|
memberships[] |
قائمة بالاشتراكات المعدَّلة |
MembershipCreatedEventData
حمولة الحدث لاشتراك جديد
نوع الحدث: google.workspace.chat.membership.v1.created
| الحقول | |
|---|---|
membership |
الاشتراك الجديد |
MembershipDeletedEventData
حمولة الحدث لعضوية محذوفة
نوع الحدث: google.workspace.chat.membership.v1.deleted
| الحقول | |
|---|---|
membership |
تمثّل هذه السمة العضوية المحذوفة، ويتم ملء الحقلَين |
MembershipUpdatedEventData
حمولة الحدث لعضوية معدَّلة
نوع الحدث: google.workspace.chat.membership.v1.updated
| الحقول | |
|---|---|
membership |
العضوية المعدَّلة |
رسالة
رسالة في مساحة Google Chat
| الحقول | |
|---|---|
name |
المعرّف. اسم مورد الرسالة التنسيق: حيث إذا ضبطت معرّفًا مخصّصًا عند إنشاء رسالة، يمكنك استخدام هذا المعرّف لتحديد الرسالة في طلب من خلال استبدال |
sender |
للقراءة فقط. المستخدم الذي أنشأ الرسالة. إذا كان تطبيق Chat يصادق على المستخدم، ستتم تعبئة الحقلين user |
create_time |
اختياريّ. غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يشير هذا الحقل إلى وقت إنشاء الرسالة. هذا الحقل مخصّص للإخراج فقط، باستثناء الحالات التي يتم فيها استخدامه في مساحات وضع الاستيراد. بالنسبة إلى المساحات في وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني السابق الذي تم فيه إنشاء الرسالة في المصدر من أجل الحفاظ على وقت الإنشاء الأصلي. |
last_update_time |
حقل إخراج فقط. يشير إلى الوقت الذي عدّل فيه المستخدم الرسالة آخر مرة. إذا لم يتم تعديل الرسالة مطلقًا، يكون هذا الحقل فارغًا. |
delete_time |
للعرض فقط: الوقت الذي تم فيه حذف الرسالة في Google Chat. إذا لم يتم حذف الرسالة مطلقًا، يكون هذا الحقل فارغًا. |
text |
اختياريّ. نص الرسالة العادي يؤدي الرابط الأول إلى صورة أو فيديو أو صفحة ويب إلى إنشاء شريحة معاينة. يمكنك أيضًا الإشارة إلى مستخدم Google Chat أو إلى جميع المستخدمين في المساحة. لمعرفة المزيد عن إنشاء الرسائل النصية، اطّلِع على إرسال رسالة. |
formatted_text |
يحتوي على الرسالة
لمزيد من المعلومات، يُرجى الاطّلاع على عرض تنسيق النص المُرسَل في رسالة. |
cards[] |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة بطاقات منسَّقة وتفاعلية وغنية بالمعلومات يمكنك استخدامها لعرض عناصر واجهة المستخدم، مثل النصوص المنسَّقة والأزرار والصور القابلة للنقر يتم عادةً عرض البطاقات أسفل نص الرسالة العادي. يمكن أن يصل حجم |
cards_v2[] |
اختياريّ. صفيف من البطاقات يمكن لتطبيقات Chat إنشاء بطاقات تتضمّن مصادقة التطبيق. في إطار برنامج معاينة المطوّرين، إذا كان تطبيق Chat يصادق على هوية المستخدم، يمكنه إنشاء رسائل على شكل بطاقات. إذا لم يكن تطبيق Chat جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتضمّن مصادقة المستخدم. للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، اطّلِع على إرسال رسالة. تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات" فتح "أداة إنشاء البطاقات" |
annotations[] |
النتائج فقط. يمكن ربط التعليقات التوضيحية بنص الرسالة العادي أو بالشرائح التي تتضمّن روابط تؤدي إلى مراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google" مع |
thread |
سلسلة المحادثات التي تنتمي إليها الرسالة للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها. |
space |
النتائج فقط. إذا كان تطبيق Chat يصادق على المستخدم، لن يتم ملء الإخراج إلا في المساحة |
fallback_text |
اختياريّ. وصف بنص عادي لبطاقات الرسالة، ويُستخدم عندما يتعذّر عرض البطاقات الفعلية، مثل الإشعارات على الأجهزة الجوّالة. |
action_response |
الإدخال فقط المَعلمات التي يمكن أن يستخدمها تطبيق Chat لتحديد طريقة نشر الرد. |
argument_text |
النتائج فقط. النص العادي للرسالة مع إزالة جميع الإشارات إلى تطبيق Chat |
slash_command |
النتائج فقط. معلومات عن الأمر الذي يبدأ بشرطة مائلة، إذا كان ذلك منطبقًا |
attachment[] |
اختياريّ. مرفق حمّله المستخدم |
matched_url |
النتائج فقط. عنوان URL في حقل |
thread_reply |
النتائج فقط. عندما تكون القيمة إذا كانت المساحة لا تتيح الردود في سلاسل محادثات، تكون قيمة هذا الحقل دائمًا |
silent |
النتائج فقط. تحدّد ما إذا كانت هذه رسالة صامتة. الرسائل الصامتة هي الرسائل التي يتجاهل فيها Chat الإشعارات الفورية للمستلِمين. |
client_assigned_message_id |
اختياريّ. معرّف مخصّص للرسالة. يمكنك استخدام الحقل لتحديد رسالة أو للحصول على رسالة أو حذفها أو تعديلها. لضبط معرّف مخصّص، حدِّد الحقل |
emoji_reaction_summaries[] |
للقراءة فقط: قائمة بملخّصات التفاعلات باستخدام رموز الإيموجي على الرسالة. |
private_message_viewer |
اختياريّ. غير قابل للتغيير يُستخدم لإدخال البيانات لإنشاء رسالة، وإلا سيتم عرض الناتج فقط. المستخدم الذي يمكنه الاطّلاع على الرسالة عند ضبط هذا الحقل، تكون الرسالة خاصة ولا يراها سوى المستخدم المحدّد وتطبيق Chat. لتضمين هذا الحقل في طلبك، يجب طلب بيانات من Chat API باستخدام مصادقة التطبيق وحذف ما يلي: لمزيد من التفاصيل، يُرجى الاطّلاع على إرسال رسالة بشكل خاص. |
deletion_metadata |
للعرض فقط: معلومات عن رسالة محذوفة. يتم حذف الرسالة عند ضبط |
quoted_message_metadata |
اختياريّ. معلومات حول رسالة تقتبس منها رسالة أخرى عند إنشاء رسالة، يمكنك اقتباس رسائل ضمن سلسلة المحادثات نفسها، أو اقتباس رسالة أصلية لإنشاء رسالة أصلية جديدة، ولكن لا يمكنك اقتباس ردّ على رسالة من سلسلة محادثات مختلفة. عند تعديل رسالة، لا يمكنك إضافة الحقل للاطّلاع على مثال على الاستخدام، يُرجى الانتقال إلى اقتباس رسالة أخرى. |
attached_gifs[] |
النتائج فقط. صور GIF المرفقة بالرسالة |
accessory_widgets[] |
اختياريّ. عنصر تفاعلي واحد أو أكثر يظهر في أسفل الرسالة. يمكنك إضافة أدوات مصغّرة خاصة بالملحقات إلى الرسائل التي تحتوي على نص أو بطاقات أو كليهما. غير متاح للرسائل التي تحتوي على مربّعات حوار. لمزيد من التفاصيل، يُرجى الاطّلاع على إضافة أدوات تفاعلية في أسفل الرسالة. يتطلّب إنشاء رسالة باستخدام أدوات ملحقة مصادقة التطبيق. |
MessageBatchCreatedEventData
حمولة الحدث لرسائل جديدة متعددة
نوع الحدث: google.workspace.chat.message.v1.batchCreated
| الحقول | |
|---|---|
messages[] |
قائمة بالرسائل الجديدة |
MessageBatchDeletedEventData
حمولة الحدث لرسائل متعدّدة تم حذفها
نوع الحدث: google.workspace.chat.message.v1.batchDeleted
| الحقول | |
|---|---|
messages[] |
قائمة بالرسائل المحذوفة |
MessageBatchUpdatedEventData
حمولة الحدث لعدة رسائل معدَّلة
نوع الحدث: google.workspace.chat.message.v1.batchUpdated
| الحقول | |
|---|---|
messages[] |
قائمة بالرسائل المعدَّلة |
MessageCreatedEventData
حمولة الحدث لرسالة جديدة
نوع الحدث: google.workspace.chat.message.v1.created
| الحقول | |
|---|---|
message |
الرسالة الجديدة |
MessageDeletedEventData
حمولة الحدث لرسالة محذوفة
نوع الحدث: google.workspace.chat.message.v1.deleted
| الحقول | |
|---|---|
message |
الرسالة المحذوفة يتم ملء الحقول |
MessagePin
رسالة مثبّتة في Chat لمزيد من المعلومات، يُرجى الاطّلاع على تثبيت رسالة.
| الحقول | |
|---|---|
name |
المعرّف. اسم مورد تثبيت الرسالة التنسيق: |
message |
الحقل مطلوب. غير قابل للتغيير اسم المورد للرسالة المثبّتة. التنسيق: |
MessageUpdatedEventData
حمولة الحدث لرسالة معدَّلة
نوع الحدث: google.workspace.chat.message.v1.updated
| الحقول | |
|---|---|
message |
الرسالة المعدَّلة |
MoveSectionItemRequest
رسالة الطلب لنقل عنصر قسم إلى أقسام أخرى
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مصدر عنصر القسم المطلوب نقله. التنسيق: |
target_section |
الحقل مطلوب. اسم مصدر القسم الذي سيتم نقل عنصر القسم إليه. التنسيق: |
MoveSectionItemResponse
رسالة الردّ لنقل عنصر قسم
| الحقول | |
|---|---|
section_item |
عنصر القسم المعدَّل |
PositionSectionRequest
رسالة الطلب لتحديد موضع قسم
| الحقول | |
|---|---|
name |
الحقل مطلوب. تمثّل هذه السمة اسم مصدر القسم المطلوب تحديد موضعه. التنسيق: |
حقل الربط position الحقل مطلوب. الموضع الجديد للقسم يمكن أن يكون التعليق position إحدى القيم التالية فقط: |
|
sort_order |
اختياريّ. تمثّل هذه السمة الموضع المطلق للقسم في قائمة الأقسام. يجب أن يكون الموضع أكبر من 0. إذا كان الموضع أكبر من عدد الأقسام، سيتم إلحاق القسم بنهاية القائمة. تُدرِج هذه العملية القسم في الموضع المحدّد وتنقل القسم الأصلي في هذا الموضع والأقسام التي تليه إلى الموضع التالي. |
relative_position |
اختياريّ. تمثّل هذه السمة الموضع النسبي للقسم في قائمة الأقسام. |
الموضع
تمثّل هذه السمة موضع القسم.
| عمليات التعداد | |
|---|---|
POSITION_UNSPECIFIED |
موضع غير محدّد |
START |
تمثّل هذه السمة بداية قائمة الأقسام. |
END |
نهاية قائمة الأقسام |
PositionSectionResponse
رسالة الردّ لتحديد موضع قسم
| الحقول | |
|---|---|
section |
القسم المعدَّل |
QuotedMessageMetadata
معلومات حول رسالة تقتبس منها رسالة أخرى
عند تعديل رسالة، لا يمكنك إضافة الحقل quotedMessageMetadata أو استبداله، ولكن يمكنك إزالته.
للاطّلاع على مثال على الاستخدام، يُرجى الانتقال إلى اقتباس رسالة أخرى.
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مصدر الرسالة التي تم اقتباسها التنسيق: |
last_update_time |
الحقل مطلوب. الطابع الزمني لوقت إنشاء الرسالة المقتبسة أو آخر تعديل لها إذا تم تعديل الرسالة، استخدِم هذا الحقل: إذا لم يكن |
quote_type |
اختياريّ. تحدّد هذه السمة نوع الاقتباس. إذا لم يتم ضبط هذه السمة، سيتم تلقائيًا ضبطها على REPLY في مسار القراءة/الكتابة للرسالة من أجل التوافق مع الإصدارات القديمة. |
quoted_message_snapshot |
النتائج فقط. لقطة من محتوى الرسالة المقتبسة |
forwarded_metadata |
النتائج فقط. بيانات وصفية حول المساحة المصدر للرسالة المقتبسة تتم تعبئة هذا الحقل لنوع الاقتباس FORWARD فقط. |
QuoteType
نوع الاقتباس للرسالة المقتبسة.
| عمليات التعداد | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
محجوزة هذه القيمة غير مستخدَمة. |
REPLY |
عندما تكون قيمة
|
FORWARD |
عندما تكون قيمة
|
QuotedMessageSnapshot
تقدّم هذه السمة لقطة للمحتوى المقتبَس من الرسالة في وقت الاقتباس أو إعادة التوجيه.
| الحقول | |
|---|---|
sender |
حقل للقراءة فقط، يمثّل اسم مؤلف الرسالة المقتبسة، ويتم ملؤه لنوعَي الاقتباس REPLY وFORWARD. |
text |
النتائج فقط. لقطة شاشة للمحتوى النصي للرسالة المقتبسة |
formatted_text |
حقل للنتائج فقط. يحتوي على الرسالة المقتبسة |
annotations[] |
النتائج فقط. التعليقات التوضيحية التي تم تحليلها من نص الرسالة المقتبسة تتم تعبئة هذا الحقل لنوع الاقتباس FORWARD فقط. |
attachments[] |
النتائج فقط. المرفقات التي كانت جزءًا من الرسالة المقتبسة هذه هي نُسخ من بيانات وصفية لمرفقات الرسالة المقتبَسة. تتم تعبئة هذا الحقل لنوع الاقتباس FORWARD فقط. |
فيديو يعرض ردود فعل
تفاعل مع رسالة
| الحقول | |
|---|---|
name |
المعرّف. تمثّل هذه السمة اسم مصدر التفاعل. التنسيق: |
user |
النتائج فقط. المستخدم الذي أنشأ التفاعل |
emoji |
الحقل مطلوب. تمثّل هذه السمة الإيموجي المستخدَم في التفاعل. |
ReactionBatchCreatedEventData
حمولة الحدث لعدّة تفاعلات جديدة
نوع الحدث: google.workspace.chat.reaction.v1.batchCreated
| الحقول | |
|---|---|
reactions[] |
قائمة بالتفاعلات الجديدة |
ReactionBatchDeletedEventData
حمولة الحدث لعدة تفاعلات محذوفة
نوع الحدث: google.workspace.chat.reaction.v1.batchDeleted
| الحقول | |
|---|---|
reactions[] |
قائمة بالتفاعلات المحذوفة |
ReactionCreatedEventData
حمولة الحدث لتفاعل جديد
نوع الحدث: google.workspace.chat.reaction.v1.created
| الحقول | |
|---|---|
reaction |
التفاعل الجديد |
ReactionDeletedEventData
حمولة الحدث لتفاعل محذوف
النوع: google.workspace.chat.reaction.v1.deleted
| الحقول | |
|---|---|
reaction |
التفاعل المحذوف |
ReplaceMessageCardsRequest
رسالة الطلب لطريقة ReplaceMessageCards API
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الرسالة التنسيق: |
cards_v2[] |
اختياريّ. مصفوفة بطاقات سيتم تضمينها في الرسالة. ستحلّ هذه البطاقات محلّ البطاقات الحالية للرسالة. في حال كان الحقل فارغًا، ستتم إزالة البطاقات الأصلية المضمّنة في الرسالة. |
ReplaceMessageCardsResponse
لا يتضمّن هذا النوع أي حقول.
رسالة الردّ لواجهة برمجة التطبيقات ReplaceMessageCards API
RichLinkMetadata
رابط غني بصريًا يؤدي إلى مرجع يمكن ربط الروابط المنسّقة بنص الرسالة العادي أو تمثيلها على شكل شرائح مرتبطة بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google" مع start_index وlength بقيمة 0.
| الحقول | |
|---|---|
uri |
معرّف الموارد المنتظم (URI) لهذا الرابط. |
rich_link_type |
تمثّل هذه السمة نوع الرابط الغني بصريًا. |
حقل الربط data بيانات المرجع المرتبط يمكن أن يكون التعليق data إحدى القيم التالية فقط: |
|
drive_link_data |
بيانات رابط في Drive |
chat_space_link_data |
بيانات رابط مساحة محادثة |
meet_space_link_data |
بيانات رابط مساحة Meet |
calendar_event_link_data |
تمثّل هذه السمة بيانات رابط حدث في "تقويم Google". |
RichLinkType
نوع الرابط المنسّق، وقد تتم إضافة المزيد من الأنواع في المستقبل.
| عمليات التعداد | |
|---|---|
RICH_LINK_TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
DRIVE_FILE |
نوع رابط غني في Google Drive |
CHAT_SPACE |
نوع رابط غني لمساحة Chat، مثل شريحة ذكية لمساحة |
GMAIL_MESSAGE |
نوع رابط غني لرسالة Gmail، وتحديدًا شريحة Gmail من المشاركة في Chat. لا تتيح واجهة برمجة التطبيقات سوى قراءة الرسائل التي تتضمّن روابط غنية من النوع GMAIL_MESSAGE. |
MEET_SPACE |
نوع رابط منسّق لرسالة Meet، مثل شريحة Meet |
CALENDAR_EVENT |
نوع رابط غني لرسالة في "تقويم Google" على سبيل المثال، شريحة "تقويم Google". |
SearchMessageResult
عنصر نتيجة واحد من عملية البحث عن الرسائل
| الحقول | |
|---|---|
message |
الرسالة المطابِقة |
space_mute_setting |
إعداد كتم صوت المستخدم الذي يجري المكالمة في المساحة التي تم نشر الرسالة فيها. يمكن لتطبيق المتصل استخدام هذه المعلومات لتحديد كيفية معالجة الرسالة استنادًا إلى ما إذا كان صوت المساحة مكتومًا للمستخدم أم لا. يتم عرض هذا الحقل فقط إذا كانت طريقة عرض الطلب هي
|
read |
تشير إلى ما إذا كان المستخدم المتصل قد قرأ الرسالة المطابِقة. يتم عرض هذا الحقل فقط إذا كانت طريقة عرض الطلب هي
|
SearchMessagesRequest
طلب رسالة للبحث عن الرسائل
| الحقول | |
|---|---|
parent |
الحقل مطلوب. اسم المورد للمساحة المطلوب البحث فيها. للبحث في جميع المساحات التي يمكن للمستخدم الوصول إليها، اضبط هذا الحقل على لتقصر البحث على مساحة واحدة أو أكثر، استخدِم |
filter |
الحقل مطلوب. طلب بحث يمكن أن يحدّد طلب البحث كلمة رئيسية واحدة أو أكثر تُستخدَم لفلترة النتائج. يمكنك أيضًا فلترة النتائج باستخدام حقول الرسائل التالية:
للفلترة المتقدّمة، تتوفّر أيضًا الوظائف التالية:
يتطلّب استخدام الفلتر
يتطلّب استخدام الفلتر
في الحقول المختلفة، لا يُسمح إلا بعوامل التشغيل ضمن الحقل نفسه:
يجب استخدام الأقواس لتوضيح أولوية عوامل التشغيل عند الجمع بين عاملَي التشغيل طلبات البحث التالية صالحة: الحد الأقصى لطول طلب البحث هو 1,000 حرف. يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ |
page_size |
اختياريّ. تعرض هذه المَعلمة أكبر عدد ممكن من النتائج. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 25 نتيجة على الأكثر. الحدّ الأقصى للقيمة هو 100. وفي حال استخدام قيمة أكبر من 100، سيتم تغييرها تلقائيًا إلى 100. |
page_token |
اختياريّ. رمز مميز تم تلقّيه من مكالمة رسائل البحث السابقة قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
order_by |
اختياريّ. تحدّد هذه السمة ترتيب قائمة النتائج. في ما يلي السمات المتوافقة التي يمكن ترتيب النتائج حسبها:
الترتيب التلقائي هو |
view |
اختياريّ. تحدّد هذه السمة نوع عرض نتائج البحث المطلوب إرجاعه. القيمة التلقائية هي |
SearchMessagesView
أنواع العرض المتوافقة مع نتائج البحث الجزئية
| عمليات التعداد | |
|---|---|
SEARCH_MESSAGES_VIEW_UNSPECIFIED |
القيمة التلقائية أو غير المضبوطة ستستخدِم واجهة برمجة التطبيقات تلقائيًا طريقة العرض BASIC. |
SEARCH_MESSAGES_VIEW_BASIC |
تتضمّن النتائج الرسائل المطابِقة فقط، ولكن بدون أي بيانات وصفية إضافية. هذه هي القيمة الافتراضية. |
SEARCH_MESSAGES_VIEW_FULL |
يتضمّن كل ما في النتائج: الرسائل المطابِقة والبيانات الوصفية الإضافية. |
SearchMessagesResponse
رسالة الردّ عند البحث عن الرسائل
| الحقول | |
|---|---|
results[] |
قائمة بنتائج البحث التي تطابقت مع طلب البحث |
next_page_token |
رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، لا توجد صفحات لاحقة. |
SearchSpacesRequest
طلب البحث عن قائمة بالمساحات استنادًا إلى طلب بحث
| الحقول | |
|---|---|
use_admin_access |
عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يجب توفير نطاق OAuth 2.0 لا تتيح هذه الطريقة حاليًا سوى الوصول الإداري، وبالتالي لا يتم قبول سوى |
page_size |
الحد الأقصى لعدد المسافات المطلوب إرجاعها، علمًا بأنّ الخدمة قد تعرض عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 100 مساحة على الأكثر. الحدّ الأقصى للقيمة هو 1000. وإذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. |
page_token |
رمز مميّز تم استلامه من طلب مساحات البحث السابق قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز، لأنّ تمرير قيم مختلفة إلى المَعلمات الأخرى قد يؤدي إلى نتائج غير متوقّعة. |
query |
الحقل مطلوب. طلب بحث يمكنك البحث باستخدام المَعلمات التالية:
تقبل السمتان
لا يقبل يقبل لا يقبل المتغيّر السمة في الحقول المختلفة، لا يُسمح إلا بعوامل التشغيل في الحقل نفسه، لا يتيح طلبات البحث التالية صالحة: |
order_by |
اختياريّ. كيفية ترتيب قائمة المساحات في ما يلي السمات المتوافقة التي يمكن ترتيب النتائج حسبها:
في ما يلي قيم عملية الترتيب الصالحة:
بناء الجملة المتوافق هو:
|
SearchSpacesResponse
ردّ يتضمّن قائمة بالمساحات التي تتطابق مع طلب البحث عن المساحات
| الحقول | |
|---|---|
spaces[] |
صفحة المساحات المطلوبة |
next_page_token |
رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، لا توجد صفحات لاحقة. |
total_size |
إجمالي عدد المساحات التي تطابق طلب البحث، على مستوى جميع الصفحات إذا كانت النتيجة تتجاوز 10,000 مساحة، تكون هذه القيمة تقديرية. |
القسم
تمثّل قسمًا في Google Chat، وتساعد الأقسام المستخدمين في تنظيم مساحاتهم. هناك نوعان من الأقسام:
أقسام النظام: هي أقسام محدّدة مسبقًا يديرها Google Chat. أسماء الموارد ثابتة، ولا يمكن إنشاؤها أو حذفها أو تعديل
display_name. تشمل الأمثلة ما يلي:users/{user}/sections/default-direct-messagesusers/{user}/sections/default-spacesusers/{user}/sections/default-apps
الأقسام المخصّصة: هي أقسام ينشئها المستخدم ويديرها. يتطلّب إنشاء قسم مخصّص باستخدام
CreateSectiondisplay_name. يمكن تعديل الأقسام المخصّصة باستخدامUpdateSectionوحذفها باستخدامDeleteSection.
| الحقول | |
|---|---|
name |
المعرّف. اسم مورد القسم. بالنسبة إلى أقسام النظام، يكون معرّف القسم عبارة عن سلسلة ثابتة:
التنسيق: |
display_name |
اختياريّ. تمثّل هذه السمة الاسم المعروض للقسم. تتم تعبئة هذا الحقل لأقسام من النوع |
sort_order |
هذه السمة مخصّصة للإخراج فقط، وهي تشير إلى ترتيب القسم بالنسبة إلى الأقسام الأخرى، إذ تظهر الأقسام التي تتضمّن قيمة |
type |
الحقل مطلوب. تمثّل هذه السمة نوع القسم. |
SectionType
أنواع الأقسام
| عمليات التعداد | |
|---|---|
SECTION_TYPE_UNSPECIFIED |
نوع القسم غير محدَّد. |
CUSTOM_SECTION |
قسم مخصّص |
DEFAULT_DIRECT_MESSAGES |
القسم التلقائي الذي يحتوي على DIRECT_MESSAGE بين مستخدمَين بشريَين أو مساحات GROUP_CHAT التي لا تنتمي إلى أي قسم مخصّص |
DEFAULT_SPACES |
المساحات التلقائية التي لا تنتمي إلى أي قسم مخصّص |
DEFAULT_APPS |
القسم التلقائي الذي يحتوي على التطبيقات المثبَّتة على جهاز المستخدم |
SectionItem
عنصر قسم يحدّده المستخدم، ويُستخدم لتمثيل عناصر القسم، مثل المساحات، المجمّعة ضمن قسم.
| الحقول | |
|---|---|
name |
المعرّف. اسم مصدر عنصر القسم. التنسيق: |
حقل الربط item الحقل مطلوب. تمثّل هذه السمة عنصر القسم. يمكن أن يكون التعليق item إحدى القيم التالية فقط: |
|
space |
اختياريّ. اسم مورد المساحة. التنسيق: |
SetUpSpaceRequest
طلب إنشاء مساحة وإضافة مستخدمين محدّدين إليها
| الحقول | |
|---|---|
space |
الحقل مطلوب. يجب ملء حقل لإنشاء مساحة، اضبط لإنشاء محادثة جماعية، اضبط لإنشاء محادثة فردية بين مستخدمَين، اضبط قيمة لإنشاء محادثة فردية بين مستخدم بشري وتطبيق Chat الذي يجري المكالمة، اضبط قيمة إذا كانت مساحة |
request_id |
اختياريّ. معرّف فريد لهذا الطلب. يُنصح باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد معرّف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض خطأ. |
memberships[] |
اختياريّ. مستخدمو Google Chat أو المجموعات التي تريد دعوتها للانضمام إلى المساحة لا تُدرِج المستخدم الذي يجري المكالمة، لأنّه تتم إضافته تلقائيًا. تسمح المجموعة حاليًا بما يصل إلى 49 عضوًا (بالإضافة إلى المتصل). بالنسبة إلى عضوية المستخدمين، يجب أن يحتوي الحقل بالنسبة إلى انتساب في المجموعة في Google، يجب أن يحتوي الحقل اختيارية عند ضبط هذه السمة مطلوبة عند ضبط قيمة يجب توفيرها عند ضبط يجب أن يكون هذا الحقل فارغًا عند إنشاء محادثة فردية بين مستخدم بشري وتطبيق Chat للمكالمات (عند ضبط |
SlashCommand
البيانات الوصفية حول أمر يبدأ بشَرطة مائلة في Google Chat
| الحقول | |
|---|---|
command_id |
معرّف الأمر الذي يبدأ بشرطة مائلة |
SlashCommandMetadata
البيانات الوصفية للتعليقات التوضيحية للأوامر التي تبدأ بشرطة مائلة (/).
| الحقول | |
|---|---|
bot |
تطبيق Chat الذي تم استدعاء الأمر منه |
type |
نوع الأمر الذي يبدأ بشرطة مائلة |
command_name |
اسم أمر الشرطة المائلة الذي تم استدعاؤه. |
command_id |
معرّف الأمر الذي تم استدعاؤه. |
triggers_dialog |
يشير إلى ما إذا كان الأمر الذي يبدأ بشرطة مائلة مخصّصًا لمربّع حوار. |
النوع
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
ADD |
أضِف تطبيق Chat إلى المساحة. |
INVOKE |
استدعاء أمر يبدأ بشرطة مائلة في مساحة |
مسافة
مساحة في Google Chat المساحات هي محادثات بين مستخدمَين أو أكثر أو رسائل مباشرة بين مستخدم وتطبيق Chat.
| الحقول | |
|---|---|
name |
المعرّف. اسم المورد الخاص بالمساحة التنسيق: حيث يمثّل |
type |
لإخراج البيانات فقط. تم إيقافها نهائيًا: استخدِم |
space_type |
اختياريّ. نوع المساحة مطلوب عند إنشاء مساحة أو تعديل نوعها. النتائج فقط للاستخدامات الأخرى |
single_user_bot_dm |
اختياريّ. تُستخدَم لتحديد ما إذا كانت المساحة عبارة عن رسالة مباشرة بين تطبيق Chat ومستخدم واحد. |
threaded |
النتائج فقط. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
display_name |
اختياريّ. الاسم المعروض لمساحة العمل. مطلوب عند إنشاء مساحة باستخدام بالنسبة إلى الرسائل المباشرة، قد يكون هذا الحقل فارغًا. يمكن أن يتضمّن ما يصل إلى 128 حرفًا. |
external_user_allowed |
اختياريّ. غير قابل للتغيير تحدّد ما إذا كانت هذه المساحة تسمح لأي مستخدم في Google Chat بأن يكون عضوًا فيها. المدخلات عند إنشاء مساحة في مؤسسة Google Workspace يجب حذف هذا الحقل عند إنشاء مساحات في الحالات التالية:
بالنسبة إلى المساحات الحالية، هذا الحقل هو حقل للنتائج فقط. |
space_threading_state |
النتائج فقط: حالة سلاسل المحادثات في مساحة Chat. |
space_details |
اختياريّ. تفاصيل حول المساحة، بما في ذلك الوصف والقواعد |
space_history_state |
اختياريّ. حالة سجلّ الرسائل والردود في هذه المساحة |
import_mode |
اختياريّ. ما إذا تم إنشاء هذه المساحة في يتطلّب إنشاء مساحة في |
create_time |
اختياريّ. غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يظهر وقت إنشاء المساحة. هذا الحقل مخصّص للإخراج فقط، باستثناء الحالات التي يتم فيها استخدامه في مساحات وضع الاستيراد. بالنسبة إلى المساحات في وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني السابق الذي تم إنشاء المساحة فيه في المصدر من أجل الاحتفاظ بوقت الإنشاء الأصلي. تتم تعبئة هذا الحقل في الناتج فقط عندما تكون قيمة |
last_active_time |
النتائج فقط. الطابع الزمني لآخر رسالة في المساحة |
admin_installed |
النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة التي تتضمّن تطبيقًا في Chat، ما إذا كان مشرف حسابات Google Workspace قد أنشأ المساحة يمكن للمشرفين تثبيت تطبيق Chat وإعداد رسالة مباشرة معه نيابةً عن المستخدمين في مؤسستهم. يجب أن تتضمّن إضافة Chat ميزة الرسائل المباشرة لتتمكّن من تثبيتها من خلال المشرف. |
membership_count |
هذا الحقل مخصّص للناتج فقط. وهو يعرض عدد العضويات التي تم الانضمام إليها، ويتم تجميعها حسب نوع العضو. تتم تعبئة هذا الحقل عندما تكون قيمة |
access_settings |
اختياريّ. تحدّد هذه السمة إعدادات الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة |
space_uri |
النتائج فقط: معرّف الموارد المنتظم (URI) الذي يتيح للمستخدم الوصول إلى المساحة. |
import_mode_expire_time |
النتائج فقط. الوقت الذي سيحذف فيه النظام المساحة تلقائيًا إذا بقيت في وضع الاستيراد يجب الخروج من وضع الاستيراد لكل مساحة تم إنشاؤها في هذا الوضع قبل انتهاء وقت الصلاحية باستخدام تتم تعبئة هذا الحقل فقط للمساحات التي تم إنشاؤها باستخدام وضع الاستيراد. |
customer |
اختياريّ. غير قابل للتغيير رقم تعريف العميل الخاص بنطاق المساحة. يجب ضبط هذه السمة فقط عند إنشاء مساحة باستخدام مصادقة التطبيق وكانت قيمة بالتنسيق لا تتم تعبئة هذا الحقل للرسائل المباشرة أو عندما ينشئ المساحة مستخدمون لا يستخدمون Google Workspace. |
حقل الربط space_permission_settings تمثّل هذه السمة إعدادات الأذونات الخاصة بمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. يمكن أن يكون التعليق space_permission_settings إحدى القيم التالية فقط: |
|
predefined_permission_settings |
اختياريّ. الإدخال فقط إعدادات أذونات المساحة المحدّدة مسبقًا، يتم إدخالها فقط عند إنشاء مساحة في حال عدم ضبط الحقل، يتم إنشاء مساحة تعاون. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل يتيح ضبط إعدادات الأذونات المحدّدة مسبقًا ما يلي:
|
permission_settings |
اختياريّ. إعدادات أذونات المساحة للمساحات الحالية إدخال لتعديل إعدادات أذونات المساحة المحدّدة، حيث يتم استبدال إعدادات الأذونات الحالية. تعرض هذه السمة إعدادات الأذونات الحالية للقوائم. تتيح قراءة إعدادات الأذونات وتعديلها ما يلي:
|
AccessSettings
تمثّل هذه السمة إعدادات الوصول إلى المساحة.
| الحقول | |
|---|---|
access_state |
النتائج فقط. تشير هذه السمة إلى حالة الوصول إلى المساحة. |
audience |
اختياريّ. اسم المورد للجمهور المستهدف الذي يمكنه اكتشاف المساحة والانضمام إليها ومعاينة الرسائل فيها. في حال عدم ضبط هذا الخيار، لن يتمكّن من الوصول إلى المساحة سوى المستخدمين أو "مجموعات Google" الذين تمت دعوتهم أو إضافتهم إليها بشكل فردي. لمزيد من التفاصيل، يُرجى الاطّلاع على إتاحة مساحة لجمهور مستهدف. التنسيق: لاستخدام الجمهور المستهدف التلقائي لمؤسسة Google Workspace، اضبط القيمة على تتيح قراءة الجمهور المستهدَف ما يلي:
لا يتم ملء هذا الحقل عند استخدام النطاق يتطلّب ضبط الجمهور المستهدف مصادقة المستخدم. |
AccessState
تمثّل هذه السمة حالة الوصول إلى المساحة.
| عمليات التعداد | |
|---|---|
ACCESS_STATE_UNSPECIFIED |
حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه. |
PRIVATE |
يمكن فقط للمستخدمين أو "مجموعات Google" الذين تمت إضافتهم أو دعوتهم بشكل فردي من قِبل مستخدمين آخرين أو مشرفي Google Workspace العثور على المساحة والوصول إليها. |
DISCOVERABLE |
منح مدير مساحة إذن الوصول إلى المساحة لجمهور مستهدَف، ويمكن للمستخدمين أو "مجموعات Google" الذين تمت إضافتهم أو دعوتهم بشكل فردي إلى المساحة أيضًا العثور على المساحة والوصول إليها. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة إتاحة مساحة لمستخدمين محدّدين. يتطلّب إنشاء مساحات قابلة للاكتشاف مصادقة المستخدم. |
MembershipCount
تمثّل هذه السمة عدد عضويات المساحة، ويتم تجميعها في فئات.
| الحقول | |
|---|---|
joined_direct_human_user_count |
للقراءة فقط. عدد المستخدمين من البشر الذين انضموا مباشرةً إلى المساحة، بدون احتساب المستخدمين الذين انضموا من خلال عضويتهم في مجموعة منضمّة. |
joined_group_count |
النتائج فقط. عدد جميع المجموعات التي انضمّت مباشرةً إلى المساحة |
PermissionSetting
تمثّل هذه السمة إعدادات أذونات المساحة.
| الحقول | |
|---|---|
managers_allowed |
اختياريّ. تُستخدَم لتحديد ما إذا كان مالكو المساحات ( |
members_allowed |
اختياريّ. تحدّد ما إذا كان أعضاء المساحة الأساسيون ( |
assistant_managers_allowed |
اختياريّ. ما إذا كان مديرو المساحة |
PermissionSettings
إعدادات الأذونات التي يمكنك تحديدها عند تعديل مساحة حالية تحمل اسمًا
لضبط إعدادات الأذونات عند إنشاء مساحة، حدِّد الحقل PredefinedPermissionSettings في طلبك.
| الحقول | |
|---|---|
manage_members_and_groups |
اختياريّ. إعدادات إدارة الأعضاء والمجموعات في مساحة |
modify_space_details |
اختياريّ. إعداد لتعديل اسم المساحة وصورتها الرمزية ووصفها وإرشاداتها |
toggle_history |
اختياريّ. إعداد للتبديل بين تفعيل سجلّ المساحة وإيقافه |
use_at_mention_all |
اختياريّ. إعداد استخدام @all في مساحة |
manage_apps |
اختياريّ. إعداد لإدارة التطبيقات في مساحة |
manage_webhooks |
اختياريّ. إعداد لإدارة الويب هوك في مساحة |
post_messages |
النتائج فقط. إعداد لنشر الرسائل في مساحة |
reply_messages |
اختياريّ. إعداد للردّ على الرسائل في مساحة |
PredefinedPermissionSettings
إعدادات الأذونات المحدّدة مسبقًا التي يمكنك تحديدها فقط عند إنشاء مساحة تحمل اسمًا قد تتم إضافة المزيد من الإعدادات في المستقبل. للحصول على تفاصيل حول إعدادات الأذونات للمساحات التي تحمل أسماء، يُرجى الاطّلاع على التعرّف على المساحات.
| عمليات التعداد | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
غير محدد لا تستخدِمها. |
COLLABORATION_SPACE |
إعداد لجعل المساحة مساحة تعاون يمكن لجميع الأعضاء نشر الرسائل فيها |
ANNOUNCEMENT_SPACE |
إعداد لجعل المساحة مخصّصة للإشعارات حيث يمكن لمدراء المساحة فقط نشر الرسائل |
SpaceDetails
تفاصيل حول المساحة، بما في ذلك الوصف والقواعد
| الحقول | |
|---|---|
description |
اختياريّ. تمثّل هذه السمة وصفًا للمساحة. على سبيل المثال، يمكنك وصف موضوع المناقشة في المساحة أو الغرض الوظيفي منها أو المشاركين فيها. يمكن أن يتضمّن ما يصل إلى 150 حرفًا. |
guidelines |
اختياريّ. قواعد المساحة وتوقعاتها وآدابها يمكن أن تتضمّن ما يصل إلى 5,000 حرف. |
SpaceThreadingState
تحدّد هذه السمة نوع حالة سلاسل المحادثات في مساحة Chat.
| عمليات التعداد | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
محجوزة |
THREADED_MESSAGES |
المساحات التي تتيح سلاسل المحادثات: عندما يردّ المستخدمون على رسالة، يمكنهم الردّ في سلسلة المحادثات، ما يحافظ على سياق الردّ ضمن الرسالة الأصلية. |
GROUPED_MESSAGES |
مساحات تحمل أسماءً ويتم فيها تنظيم المحادثة حسب الموضوع، وتكون المواضيع وردودها مجمّعة معًا |
UNTHREADED_MESSAGES |
المساحات التي لا تتيح سلاسل الرسائل لا يتم استخدام حالة ربط المساحة هذه إلا في حالات خاصة، بما في ذلك:
|
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[] |
قائمة بمساحات العمل المعدَّلة |
SpaceEvent
حدث يمثّل تغييرًا أو نشاطًا في مساحة Google Chat. لمزيد من المعلومات، راجِع العمل مع الأحداث من Google Chat.
| الحقول | |
|---|---|
name |
اسم المورد لحدث المساحة التنسيق: |
event_time |
الوقت الذي وقع فيه الحدث |
event_type |
نوع حدث المساحة يحتوي كل نوع حدث على إصدار مجمّع يمثّل عدة مثيلات من نوع الحدث تحدث في فترة زمنية قصيرة. بالنسبة إلى طلبات أنواع الأحداث المتوافقة مع الرسائل:
أنواع الأحداث المتوافقة مع العضويات:
أنواع الأحداث المتوافقة مع التفاعلات:
أنواع الأحداث المتوافقة بشأن المساحة:
|
حقل الربط يمكن أن يكون التعليق |
|
message_created_event_data |
حمولة الحدث لرسالة جديدة نوع الحدث: |
message_updated_event_data |
حمولة الحدث لرسالة معدَّلة نوع الحدث: |
message_deleted_event_data |
حمولة الحدث لرسالة محذوفة نوع الحدث: |
message_batch_created_event_data |
حمولة الحدث لرسائل جديدة متعددة نوع الحدث: |
message_batch_updated_event_data |
حمولة الحدث لعدة رسائل معدَّلة نوع الحدث: |
message_batch_deleted_event_data |
حمولة الحدث لرسائل متعدّدة تم حذفها نوع الحدث: |
space_updated_event_data |
حمولة الحدث لتعديل مساحة نوع الحدث: |
space_batch_updated_event_data |
حمولة الحدث لعدة تعديلات على مساحة نوع الحدث: |
membership_created_event_data |
حمولة الحدث لاشتراك جديد نوع الحدث: |
membership_updated_event_data |
حمولة الحدث لعضوية معدَّلة نوع الحدث: |
membership_deleted_event_data |
حمولة الحدث لعضوية محذوفة نوع الحدث: |
membership_batch_created_event_data |
حمولة الحدث الخاصة بالاشتراكات الجديدة المتعددة نوع الحدث: |
membership_batch_updated_event_data |
حمولة الحدث لعدة اشتراكات معدَّلة نوع الحدث: |
membership_batch_deleted_event_data |
حمولة الحدث للعضويات المتعددة المحذوفة نوع الحدث: |
reaction_created_event_data |
حمولة الحدث لتفاعل جديد نوع الحدث: |
reaction_deleted_event_data |
حمولة الحدث لتفاعل محذوف نوع الحدث: |
reaction_batch_created_event_data |
حمولة الحدث لعدّة تفاعلات جديدة نوع الحدث: |
reaction_batch_deleted_event_data |
حمولة الحدث لعدة تفاعلات محذوفة نوع الحدث: |
SpaceNotificationSetting
إعدادات الإشعارات لدى المستخدم في مساحة
| الحقول | |
|---|---|
name |
المعرّف. تمثّل هذه السمة اسم مورد إعدادات إشعارات المساحة. التنسيق: |
notification_setting |
إعدادات الإشعارات |
mute_setting |
إعداد كتم صوت الإشعارات في المساحة |
MuteSetting
أنواع إعدادات كتم إشعارات المساحة
| عمليات التعداد | |
|---|---|
MUTE_SETTING_UNSPECIFIED |
محجوزة |
UNMUTED |
سيتلقّى المستخدم إشعارات بشأن المساحة استنادًا إلى إعدادات الإشعارات. |
MUTED |
لن يتلقّى المستخدم أي إشعارات للمساحة، بغض النظر عن إعدادات الإشعارات. |
NotificationSetting
أنواع إعدادات الإشعارات قد يتم توفير أنواع أخرى في المستقبل.
| عمليات التعداد | |
|---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
محجوزة |
ALL |
يتم تشغيل الإشعارات عند الإشارة إلى شخص باستخدام @، أو في سلاسل المحادثات التي تتم متابعتها، أو عند إرسال أول رسالة في سلاسل المحادثات الجديدة. تتم متابعة جميع سلاسل المحادثات الجديدة تلقائيًا، ما لم يلغِ المستخدم متابعتها يدويًا. |
MAIN_CONVERSATIONS |
يتم تشغيل الإشعار عند الإشارة باستخدام @أو في سلاسل المحادثات التي تتم متابعتها أو عند إرسال أول رسالة في سلاسل المحادثات الجديدة، ولا يتوفّر للرسائل المباشرة بين شخصين. |
FOR_YOU |
يتم تشغيل الإشعار عند الإشارة إليك باستخدام @أو في سلاسل المحادثات التي تتابعها. لا تتوفّر للرسائل المباشرة بين شخصين. |
OFF |
الإشعار غير مفعّل. |
SpaceReadState
حالة القراءة الخاصة بالمستخدم في مساحة، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة
| الحقول | |
|---|---|
name |
اسم المورد لحالة القراءة في المساحة التنسيق: |
last_read_time |
اختياريّ. الوقت الذي تم فيه تعديل حالة قراءة المستخدم للمساحة عادةً ما يتطابق هذا مع الطابع الزمني لآخر رسالة تمت قراءتها، أو طابع زمني يحدّده المستخدم لوضع علامة على آخر موضع تمت قراءته في مساحة. |
SpaceUpdatedEventData
حمولة الحدث لمساحة تم تعديلها
نوع الحدث: google.workspace.chat.space.v1.updated
| الحقول | |
|---|---|
space |
المساحة المعدَّلة |
SpaceView
طريقة عرض تحدّد الحقول التي يجب ملؤها في مورد Space. لضمان التوافق مع الإصدارات المستقبلية، ننصح بأن يراعي رمزك القيم الإضافية.
| عمليات التعداد | |
|---|---|
SPACE_VIEW_UNSPECIFIED |
القيمة التلقائية أو غير المضبوطة |
SPACE_VIEW_RESOURCE_NAME_ONLY |
يتم ملء اسم مورد المساحة فقط. |
SPACE_VIEW_EXPANDED |
تعبئة حقول مورد "المساحة". ملاحظة: لن تتم تعبئة الحقل permissionSettings. يجب أن تتضمّن الطلبات التي تحدّد SPACE_VIEW_EXPANDED نطاقات تسمح بقراءة بيانات المساحة، مثل https://www.googleapis.com/auth/chat.spaces أو https://www.googleapis.com/auth/chat.spaces.readonly. |
Thread
سلسلة محادثات في مساحة Chat في Google Chat للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها.
إذا حدّدت سلسلة محادثات عند إنشاء رسالة، يمكنك ضبط الحقل messageReplyOption لتحديد ما يحدث في حال عدم العثور على سلسلة محادثات مطابقة.
| الحقول | |
|---|---|
name |
المعرّف. اسم المرجع الخاص بالسلسلة مثلاً: |
thread_key |
اختياريّ. إدخال لإنشاء سلسلة محادثات أو تعديلها وبخلاف ذلك، النتائج فقط. معرّف سلسلة المحادثات يمكن أن يتضمّن ما يصل إلى 4,000 حرف. هذا المعرّف فريد لتطبيق Chat الذي يضبطه. على سبيل المثال، إذا أنشأت تطبيقات Chat متعددة رسالة باستخدام مفتاح سلسلة المحادثات نفسه، سيتم نشر الرسائل في سلاسل محادثات مختلفة. للرد في سلسلة محادثات أنشأها مستخدم أو تطبيق Chat آخر، حدِّد حقل |
ThreadReadState
حالة القراءة الخاصة بالمستخدم ضمن سلسلة محادثات، تُستخدَم لتحديد الرسائل المقروءة وغير المقروءة.
| الحقول | |
|---|---|
name |
اسم مورد حالة قراءة سلسلة المحادثات التنسيق: |
last_read_time |
الوقت الذي تم فيه تعديل حالة قراءة سلسلة المحادثات للمستخدم يتطابق هذا الحقل عادةً مع الطابع الزمني لآخر رسالة تمت قراءتها في سلسلة محادثات. |
UpdateMembershipRequest
رسالة طلب تعديل اشتراك
| الحقول | |
|---|---|
membership |
الحقل مطلوب. الاشتراك المطلوب تعديله. يتم تعديل الحقول المحدّدة بواسطة |
update_mask |
الحقل مطلوب. مسارات الحقول التي سيتم تعديلها. افصل بين القيم المتعددة بفواصل أو استخدِم مسارات الحقول المتوافقة حاليًا:
|
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب |
UpdateMessageRequest
طلب تعديل رسالة
| الحقول | |
|---|---|
message |
الحقل مطلوب. رسالة تحتوي على حقول معدَّلة |
update_mask |
الحقل مطلوب. مسارات الحقول التي سيتم تعديلها. افصل بين القيم المتعددة بفواصل أو استخدِم مسارات الحقول المتوافقة حاليًا:
|
allow_missing |
اختياريّ. إذا لم يتم العثور على الرسالة التي تتضمّن |
UpdateSectionRequest
رسالة طلب تعديل قسم
| الحقول | |
|---|---|
section |
الحقل مطلوب. القسم المطلوب تعديله. |
update_mask |
الحقل مطلوب. القناع لتحديد الحقول التي سيتم تعديلها. مسارات الحقول المتوافقة حاليًا:
|
UpdateSpaceNotificationSettingRequest
طلب تعديل إعدادات الإشعارات في المساحة يتيح هذا الإجراء تعديل إعدادات الإشعارات للمستخدم الذي يجري المكالمة فقط.
| الحقول | |
|---|---|
space_notification_setting |
الحقل مطلوب. يجب ملء اسم المورد لإعدادات إشعارات المساحة بالتنسيق |
update_mask |
الحقل مطلوب. مسارات الحقول المتوافقة:
|
UpdateSpaceReadStateRequest
رسالة الطلب لواجهة برمجة التطبيقات UpdateSpaceReadState
| الحقول | |
|---|---|
space_read_state |
الحقل مطلوب. حالة القراءة في المساحة والحقول التي سيتم تعديلها يتيح هذا الإجراء تعديل حالة القراءة للمستخدم الذي يجري المكالمة فقط. للإشارة إلى المستخدم الذي يجري المكالمة، اضبط أحد الخيارَين التاليَين:
التنسيق: users/{user}/spaces/{space}/spaceReadState |
update_mask |
الحقل مطلوب. مسارات الحقول التي سيتم تعديلها. مسارات الحقول المتوافقة حاليًا:
عندما يكون لوضع علامة "مقروءة" على المساحة، اضبط |
UpdateSpaceRequest
طلب تعديل مساحة واحدة
| الحقول | |
|---|---|
space |
الحقل مطلوب. مساحة تتضمّن الحقول التي سيتم تعديلها يجب ملء السمة |
update_mask |
الحقل مطلوب. مسارات الحقول المعدَّلة، مفصولة بفواصل إذا كانت متعددة يمكنك تعديل الحقول التالية لمساحة:
|
use_admin_access |
اختياريّ. عند يجب أن يكون المستخدم الذي يجري المكالمة مشرف حسابات Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب لا يمكن استخدام بعض قيم |
المستخدم
مستخدم في Google Chat عندما يتم عرضها كنتيجة لطلب، إذا كان تطبيق Chat يصادق كمستخدم، لن يتم ملء نتيجة المورد User إلا بـ name وtype الخاصين بالمستخدم.
| الحقول | |
|---|---|
name |
اسم المورد التنسيق: بالنسبة إلى
|
display_name |
النتائج فقط. الاسم المعروض للمستخدم. |
domain_id |
المعرّف الفريد لنطاق Google Workspace الخاص بالمستخدم. |
type |
نوع المستخدم |
is_anonymous |
النتائج فقط. عندما تكون القيمة |
النوع
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد DO NOT USE. |
HUMAN |
مستخدم بشري |
BOT |
مستخدم تطبيق Chat |
UserMentionMetadata
البيانات الوصفية الخاصة بالتعليقات التوضيحية التي تشير إلى مستخدمين (@)
| الحقول | |
|---|---|
user |
المستخدم الذي تمت الإشارة إليه |
type |
نوع الإشارة إلى المستخدم. |
النوع
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد لا تستخدِمها. |
ADD |
إضافة مستخدم إلى المساحة |
MENTION |
الإشارة إلى مستخدم في المساحة |
WidgetMarkup
الأداة هي عنصر في واجهة المستخدم يعرض النصوص والصور.
| الحقول | |
|---|---|
buttons[] |
قائمة بالأزرار، ويجب ضبط حقل واحد فقط من هذه الحقول. |
حقل الربط data لا يمكن أن يحتوي WidgetMarkup إلا على أحد العناصر التالية. يمكنك استخدام حقول WidgetMarkup متعددة لعرض المزيد من العناصر. يمكن أن يكون التعليق data إحدى القيم التالية فقط: |
|
text_paragraph |
لعرض فقرة نصية في هذه الأداة |
image |
عرض صورة في هذا التطبيق المصغّر |
key_value |
عرض عنصر قيمة مفتاح في هذا التطبيق المصغّر |
زرّ
زر يمكن أن يكون زرًا نصيًا أو زرًا مصوّرًا.
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
text_button |
زر يتضمّن نصًا وإجراء |
image_button |
زر يتضمّن صورة وإجراء |
FormAction
يصف إجراء النموذج السلوك عند إرسال النموذج. على سبيل المثال، يمكنك استدعاء Apps Script للتعامل مع النموذج.
| الحقول | |
|---|---|
action_method_name |
يُستخدَم اسم الطريقة لتحديد الجزء من النموذج الذي أدّى إلى إرسال النموذج. يتم عرض هذه المعلومات مرة أخرى في تطبيق Chat كجزء من حدث ناتج عن النقر على البطاقة. يمكنك استخدام اسم الطريقة نفسه لعدة عناصر تؤدي إلى سلوك مشترك. |
parameters[] |
قائمة مَعلمات الإجراءات |
ActionParameter
قائمة بمَعلمات السلسلة التي يجب توفيرها عند استدعاء طريقة الإجراء على سبيل المثال، فكِّر في ثلاثة أزرار تأجيل: التأجيل الآن، والتأجيل ليوم واحد، والتأجيل للأسبوع التالي. يمكنك استخدام action method = snooze()، مع تمرير نوع الغفوة ووقت الغفوة في قائمة مَعلمات السلسلة.
| الحقول | |
|---|---|
key |
اسم المَعلمة لبرنامج الإجراءات النصي |
value |
قيمة المَعلمة |
الرمز
مجموعة الرموز المتوافقة
| عمليات التعداد | |
|---|---|
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 |
عنوان URL للصورة |
on_click |
الإجراء |
aspect_ratio |
نسبة العرض إلى الارتفاع لهذه الصورة (العرض والارتفاع) يتيح لك هذا الحقل حجز الارتفاع المناسب للصورة أثناء انتظار تحميلها. ولا يُفترض أن تتجاوز هذه السمة نسبة العرض إلى الارتفاع المضمّنة في الصورة. إذا لم يتم ضبطها، يملأها الخادم من خلال جلب الصورة مسبقًا. |
ImageButton
زر صورة يتضمّن إجراء onclick
| الحقول | |
|---|---|
on_click |
الإجراء |
name |
اسم |
حقل الربط icons يمكن تحديد الرمز من خلال Icon enum أو عنوان URL. يمكن أن يكون التعليق icons إحدى القيم التالية فقط: |
|
icon |
الرمز المحدّد بواسطة |
icon_url |
الرمز المحدّد بواسطة عنوان URL |
KeyValue
يحتوي عنصر في واجهة المستخدم على مفتاح (تصنيف) وقيمة (محتوى)، ويمكن أن يحتوي أيضًا على بعض الإجراءات، مثل الزر onclick.
| الحقول | |
|---|---|
top_label |
نص التصنيف العلوي، مع إمكانية استخدام نص منسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace. |
content |
نص المحتوى يجب توفير نص منسّق دائمًا. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace". |
content_multiline |
تُستخدَم لتحديد ما إذا كان المحتوى يجب أن يكون متعدد الأسطر. |
bottom_label |
نص التصنيف السفلي يتوافق مع النصوص المنسَّقة. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace". |
on_click |
الإجراء |
حقل الربط icons يجب تحديد رمز واحد على الأقل من الرموز top_label وbottom_label. يمكن أن يكون التعليق icons إحدى القيم التالية فقط: |
|
icon |
قيمة تعداد يتم استبدالها بواسطة Chat API بصورة الرمز المقابل. |
icon_url |
الرمز المحدّد بواسطة عنوان URL |
حقل الربط control تطبيق مصغّر للتحكّم يمكنك ضبط button أو switch_widget، ولكن ليس كليهما. يمكن أن يكون التعليق control إحدى القيم التالية فقط: |
|
button |
زرّ يمكن النقر عليه لتنفيذ إجراء |
OnClick
إجراء onclick (على سبيل المثال، فتح رابط)
| الحقول | |
|---|---|
حقل الربط يمكن أن يكون التعليق |
|
action |
يتم تشغيل إجراء نموذج من خلال إجراء |
open_link |
يؤدي إجراء |
OpenLink
رابط يفتح نافذة جديدة
| الحقول | |
|---|---|
url |
عنوان URL المطلوب فتحه |
TextButton
زر يتضمّن نصًا وإجراء onclick
| الحقول | |
|---|---|
text |
النص المكتوب على الزر. |
on_click |
|
TextParagraph
فقرة من النص يتوافق مع النصوص المنسَّقة. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على تنسيق النص في تطبيقات Google Chat وتنسيق النص في "إضافات Google Workspace".
| الحقول | |
|---|---|
text |
|