الفهرس
ChatService
(واجهة)AccessoryWidget
(رسالة)ActionResponse
(رسالة)ActionResponse.ResponseType
(تعداد)ActionResponse.SelectionItems
(رسالة)ActionResponse.UpdatedWidget
(رسالة)ActionStatus
(رسالة)Annotation
(رسالة)AnnotationType
(تعداد)AttachedGif
(رسالة)Attachment
(رسالة)Attachment.Source
(تعداد)AttachmentDataRef
(رسالة)CardWithId
(رسالة)ChatSpaceLinkData
(رسالة)CompleteImportSpaceRequest
(رسالة)CompleteImportSpaceResponse
(رسالة)ContextualAddOnMarkup
(رسالة)ContextualAddOnMarkup.Card
(رسالة)ContextualAddOnMarkup.Card.CardAction
(رسالة)ContextualAddOnMarkup.Card.CardHeader
(رسالة)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(تعداد)ContextualAddOnMarkup.Card.Section
(رسالة)CreateMembershipRequest
(رسالة)CreateMessageRequest
(رسالة)CreateMessageRequest.MessageReplyOption
(تعداد)CreateReactionRequest
(رسالة)CreateSpaceRequest
(رسالة)CustomEmoji
(رسالة)DeleteMembershipRequest
(رسالة)DeleteMessageRequest
(رسالة)DeleteReactionRequest
(رسالة)DeleteSpaceRequest
(رسالة)DeletionMetadata
(رسالة)DeletionMetadata.DeletionType
(تعداد)Dialog
(رسالة)DialogAction
(رسالة)DriveDataRef
(رسالة)DriveLinkData
(رسالة)Emoji
(رسالة)EmojiReactionSummary
(رسالة)FindDirectMessageRequest
(رسالة)GetAttachmentRequest
(رسالة)GetMembershipRequest
(رسالة)GetMessageRequest
(رسالة)GetSpaceEventRequest
(رسالة)GetSpaceReadStateRequest
(رسالة)GetSpaceRequest
(رسالة)GetThreadReadStateRequest
(رسالة)Group
(رسالة)HistoryState
(تعداد)ListMembershipsRequest
(رسالة)ListMembershipsResponse
(رسالة)ListMessagesRequest
(رسالة)ListMessagesResponse
(رسالة)ListReactionsRequest
(رسالة)ListReactionsResponse
(رسالة)ListSpaceEventsRequest
(رسالة)ListSpaceEventsResponse
(رسالة)ListSpacesRequest
(رسالة)ListSpacesResponse
(رسالة)MatchedUrl
(رسالة)Membership
(رسالة)Membership.MembershipRole
(تعداد)Membership.MembershipState
(تعداد)MembershipBatchCreatedEventData
(رسالة)MembershipBatchDeletedEventData
(رسالة)MembershipBatchUpdatedEventData
(رسالة)MembershipCreatedEventData
(رسالة)MembershipDeletedEventData
(رسالة)MembershipUpdatedEventData
(رسالة)Message
(رسالة)MessageBatchCreatedEventData
(رسالة)MessageBatchDeletedEventData
(رسالة)MessageBatchUpdatedEventData
(رسالة)MessageCreatedEventData
(رسالة)MessageDeletedEventData
(رسالة)MessageUpdatedEventData
(رسالة)QuotedMessageMetadata
(رسالة)Reaction
(رسالة)ReactionBatchCreatedEventData
(رسالة)ReactionBatchDeletedEventData
(رسالة)ReactionCreatedEventData
(رسالة)ReactionDeletedEventData
(رسالة)RichLinkMetadata
(رسالة)RichLinkMetadata.RichLinkType
(تعداد)SearchSpacesRequest
(رسالة)SearchSpacesResponse
(رسالة)SetUpSpaceRequest
(رسالة)SlashCommand
(رسالة)SlashCommandMetadata
(رسالة)SlashCommandMetadata.Type
(تعداد)Space
(رسالة)Space.AccessSettings
(رسالة)Space.AccessSettings.AccessState
(تعداد)Space.MembershipCount
(رسالة)Space.PermissionSetting
(رسالة)Space.PermissionSettings
(رسالة)Space.PredefinedPermissionSettings
(تعداد)Space.SpaceDetails
(رسالة)Space.SpaceThreadingState
(تعداد)Space.SpaceType
(تعداد)Space.Type
(تعداد)SpaceBatchUpdatedEventData
(رسالة)SpaceEvent
(رسالة)SpaceReadState
(رسالة)SpaceUpdatedEventData
(رسالة)Thread
(رسالة)ThreadReadState
(رسالة)UpdateMembershipRequest
(رسالة)UpdateMessageRequest
(رسالة)UpdateSpaceReadStateRequest
(رسالة)UpdateSpaceRequest
(رسالة)User
(رسالة)User.Type
(تعداد)UserMentionMetadata
(رسالة)UserMentionMetadata.Type
(تعداد)WidgetMarkup
(رسالة)WidgetMarkup.Button
(رسالة)WidgetMarkup.FormAction
(رسالة)WidgetMarkup.FormAction.ActionParameter
(رسالة)WidgetMarkup.Icon
(تعداد)WidgetMarkup.Image
(رسالة)WidgetMarkup.ImageButton
(رسالة)WidgetMarkup.KeyValue
(رسالة)WidgetMarkup.OnClick
(رسالة)WidgetMarkup.OpenLink
(رسالة)WidgetMarkup.TextButton
(رسالة)WidgetMarkup.TextParagraph
(رسالة)
ChatService
يمكّن المطوّرين من إنشاء تطبيقات وعمليات دمج في Chat على نظام Google Chat الأساسي.
CompleteImportSpace |
---|
تُكمل عملية الاستيراد للمساحة المحدَّدة وتجعلها مرئية للمستخدمين. تتطلب المصادقة على التطبيق والتفويض على مستوى النطاق. لمزيد من المعلومات، اطّلِع على تفويض تطبيقات Google Chat لاستيراد البيانات.
|
CreateMembership |
---|
إنشاء اشتراك بشري أو اشتراك في تطبيق خاص بتطبيق الاتصال لا يمكنك إنشاء ميزة "العضوية في القنوات" لتطبيقات أخرى. مثلاً، راجِع دعوة مستخدم أو تطبيق Google Chat إلى مساحة أو إضافتهما إلى مساحة. عند إنشاء عضوية، إذا تم إيقاف سياسة القبول التلقائي لدى العضو المحدّد، تتم دعوته وعليه قبول دعوة المساحة قبل الانضمام. بخلاف ذلك، يؤدي إنشاء عضوية إلى إضافة العضو مباشرةً إلى المساحة المحددة. يتطلب مصادقة المستخدم. لتحديد العضو الذي تريد إضافته، اضبط السمة
|
CreateMessage |
---|
إنشاء رسالة في مساحة Google Chat الحد الأقصى لحجم الرسالة، بما في ذلك النص والبطاقات، هو 32000 بايت. مثلاً، راجِع إرسال رسالة. يتطلّب استدعاء هذه الطريقة المصادقة، ويتوافق مع أنواع المصادقة التالية:
|
CreateReaction |
---|
إنشاء تفاعل وإضافته إلى رسالة يمكن استخدام الرموز التعبيرية بترميز يونيكود فقط. على سبيل المثال، راجِع المقالة إضافة تفاعل إلى رسالة. يتطلب مصادقة المستخدم.
|
CreateSpace |
---|
يتم إنشاء مساحة مُعنوَنة. المساحات المجمَّعة حسب المواضيع غير متاحة. على سبيل المثال، راجِع إنشاء مساحة. إذا ظهرت لك رسالة الخطأ يتطلب مصادقة المستخدم.
|
DeleteMembership |
---|
يؤدي هذا الإجراء إلى حذف الاشتراك. على سبيل المثال، راجِع إزالة مستخدم أو تطبيق Google Chat من مساحة. يتطلب مصادقة المستخدم.
|
DeleteMessage |
---|
حذف رسالة على سبيل المثال، راجِع حذف رسالة. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم. عند استخدام مصادقة التطبيقات، لا يمكن للطلبات حذف سوى الرسائل التي تم إنشاؤها من خلال تطبيق Chat الذي يتم الاتصال به.
|
DeleteReaction |
---|
حذف تفاعل مع رسالة يمكن استخدام الرموز التعبيرية بترميز يونيكود فقط. على سبيل المثال، راجِع المقالة حذف تفاعل. يتطلب مصادقة المستخدم.
|
DeleteSpace |
---|
حذف مساحة مُعنوَنة يتم دائمًا إجراء حذف متتالي، ما يعني أنّه يتم أيضًا حذف الموارد الفرعية للمساحة، مثل الرسائل المنشورة في المساحة والاشتراكات فيها. على سبيل المثال، راجِع حذف مساحة. تتطلب مصادقة المستخدم من مستخدم لديه الإذن لحذف المساحة.
|
FindDirectMessage |
---|
لعرض الرسالة المباشرة الحالية مع المستخدم المحدّد. إذا لم يتم العثور على مساحة رسائل مباشرة، سيتم عرض خطأ من خلال مصادقة المستخدم، يتم عرض مساحة الرسالة المباشرة بين المستخدم المحدّد والمستخدم الذي تمت مصادقته. من خلال مصادقة التطبيق، يتم عرض مساحة الرسالة المباشرة بين المستخدم المحدّد وتطبيق Chat الذي يجري الاتصال. يتطلب ذلك مصادقة المستخدم أو مصادقة التطبيق.
|
GetAttachment |
---|
الحصول على البيانات الوصفية لمرفق رسالة يتم استرجاع بيانات المرفقات باستخدام media API. على سبيل المثال، يُرجى الاطّلاع على الحصول على بيانات وصفية حول مرفق رسالة. يتطلب مصادقة التطبيق.
|
GetMembership |
---|
عرض تفاصيل حول اشتراك على سبيل المثال، راجِع الحصول على تفاصيل حول اشتراك المستخدم أو اشتراك تطبيق Google Chat. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم.
|
GetMessage |
---|
عرض تفاصيل حول رسالة مثلاً، راجِع الحصول على تفاصيل حول رسالة. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم. ملاحظة: قد يعرض رسالة من عضو محظور أو مساحة.
|
GetSpace |
---|
لعرض تفاصيل حول مساحة على سبيل المثال، يُرجى الاطّلاع على الحصول على تفاصيل حول مساحة. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم.
|
GetSpaceEvent |
---|
عرض حدث من مساحة Google Chat تحتوي حمولة الحدث على أحدث إصدار من المورد الذي تم تغييره. على سبيل المثال، إذا طلبت حدثًا حول رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، يعرض الخادم مورد يتطلب مصادقة المستخدم. للحصول على حدث، يجب أن يكون المستخدم الذي تمت مصادقته عضوًا في المساحة. على سبيل المثال، راجِع الحصول على تفاصيل حول حدث من مساحة في Google Chat.
|
GetSpaceReadState |
---|
تعرض تفاصيل حول حالة قراءة المستخدم داخل مساحة، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. على سبيل المثال، يمكنك الاطّلاع على الحصول على تفاصيل حول حالة قراءة مساحة المستخدم. يتطلب مصادقة المستخدم.
|
GetThreadReadState |
---|
تعرض تفاصيل حول حالة قراءة المستخدم في سلسلة محادثات، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة. على سبيل المثال، يمكنك الاطّلاع على الحصول على تفاصيل حول حالة قراءة سلسلة محادثات للمستخدم. يتطلب مصادقة المستخدم.
|
ListMemberships |
---|
يسرد العضوية في مساحة. على سبيل المثال، راجِع إنشاء قائمة بالمستخدمين وتطبيقات Google Chat في مساحة. تعرض بطاقة بيانات المتجر التي تستخدم ميزة المصادقة على التطبيق الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكنها تستبعد الاشتراكات في التطبيقات في Chat، بما فيها المساحات الخاصة. تحتوي بطاقة بيانات المتجر باستخدام ميزة مصادقة المستخدم على إدراج الاشتراكات في المساحات التي يمكن للمستخدم الذي تمت مصادقته الوصول إليها. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم.
|
ListMessages |
---|
يسرد الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء المحظورين والمساحات. على سبيل المثال، راجِع قائمة الرسائل. يتطلب مصادقة المستخدم.
|
ListReactions |
---|
يسرد التفاعلات مع رسالة. على سبيل المثال، اطّلِع على المقالة سرد التفاعلات مع رسالة. يتطلب مصادقة المستخدم.
|
ListSpaceEvents |
---|
يسرد الأحداث من مساحة Google Chat. بالنسبة إلى كل حدث، تحتوي الحمولة على أحدث إصدار من مرجع Chat. مثلاً، في حال إدراج أحداث عن أعضاء المساحة الجدد، يعرض الخادم موارد يتطلب مصادقة المستخدم. لإدراج الأحداث، يجب أن يكون المستخدم الذي تمت مصادقته عضوًا في المساحة. على سبيل المثال، راجِع إنشاء قائمة بالأحداث من مساحة Google Chat.
|
ListSpaces |
---|
يسرد المساحات التي ينتمي إليها المتصل. لا يتم إدراج المحادثات الجماعية والرسائل المباشرة حتى يتم إرسال الرسالة الأولى. للحصول على مثال، يُرجى الاطّلاع على إدراج المساحات. تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم. يسرد المساحات المرئية للمتصل أو المستخدم الذي تمت مصادقته. لا يتم إدراج المحادثات الجماعية والرسائل المباشرة حتى يتم إرسال الرسالة الأولى. لإدراج جميع المساحات المُسمّاة حسب مؤسسة Google Workspace، استخدِم الطريقة
|
SearchSpaces |
---|
use_admin_access على true .
|
SetUpSpace |
---|
يتم إنشاء مساحة وإضافة مستخدمين محدّدين إليها. تتم إضافة المستخدم المتصل تلقائيًا إلى المساحة، ويجب عدم تحديده كعضوية في الطلب. على سبيل المثال، يُرجى الاطّلاع على إعداد مساحة تتضمن الأعضاء الأوليين. لتحديد الأعضاء المطلوب إضافتهم، أضِف العضويات باستخدام السمة لتحديد مجموعات Google المطلوب إضافتها، أضِف العضويات باستخدام السمة في المساحة المُعنوَنة أو المحادثة الجماعية، إذا حظر المتصل أو بعض الأعضاء، أو لم يكن لديه الإذن بإضافة بعض الأعضاء، لن تتم إضافة هؤلاء الأعضاء إلى المساحة التي تم إنشاؤها. لإنشاء رسالة مباشرة بين المستخدم المتصل ومستخدم آخر، حدِّد عضوية واحدة بالضبط لتمثيل المستخدم. إذا حظر أحد المستخدمين الآخر، لن يتمكّن المستخدم من الطلب ولا يتم إنشاء الرسالة المباشرة. لإنشاء رسالة مباشرة بين المستخدم المتصل وتطبيق الاتصال، يُرجى ضبط إذا كانت هناك رسالة مباشرة بين مستخدمَين، حتى عندما يحظر أحد المستخدمين الآخر عند تقديم الطلب، سيتم عرض الرسالة المباشرة الحالية. المساحات التي تحتوي على ردود ضمن سلاسل غير متاحة. إذا ظهرت لك رسالة الخطأ يتطلب مصادقة المستخدم.
|
UpdateMembership |
---|
تعديل اشتراك على سبيل المثال، يمكنك الاطّلاع على مقالة تعديل عضوية مستخدم في مساحة. يتطلب مصادقة المستخدم.
|
UpdateMessage |
---|
يتم تعديل رسالة. هناك فرق بين طريقة تتطلب المصادقة. يتيح هذا الإجراء مصادقة التطبيقات ومصادقة المستخدم. عند استخدام مصادقة التطبيقات، لا يمكن للطلبات تعديل إلا الرسائل التي تم إنشاؤها من خلال تطبيق Chat للاتصال.
|
UpdateSpace |
---|
يتم تعديل مساحة. على سبيل المثال، راجِع المقالة تعديل مساحة. في حال تعديل الحقل يتطلب مصادقة المستخدم.
|
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
تمثّل هذه السمة استجابة التطبيق المصغّر. يُستخدَم لتوفير خيارات الإكمال التلقائي لأداة ما.
الحقول | |
---|---|
widget |
رقم تعريف التطبيق المصغّر المُعدَّل يجب أن يتطابق رقم التعريف مع رقم التعريف للتطبيق المصغّر الذي أدّى إلى طلب التعديل. |
حقل الاتحاد updated_widget . تم تعديل الأداة استجابةً لإجراء المستخدم. يمكن أن يكون updated_widget واحدًا فقط مما يلي: |
|
suggestions |
قائمة بنتائج الإكمال التلقائي للأداة |
ActionStatus
تُمثل حالة طلب استدعاء أو إرسال مربع حوار.
الحقول | |
---|---|
status_code |
رمز الحالة. |
user_facing_message |
الرسالة التي يتم إرسالها إلى المستخدمين بشأن حالة طلبهم. وفي حال ترك هذه السياسة بدون ضبط، يتم إرسال رسالة عامة تستند إلى |
تعليق توضيحي
النتائج فقط. التعليقات التوضيحية المرتبطة بالنص العادي للرسالة. لإضافة تنسيق أساسي إلى رسالة نصية، راجِع تنسيق الرسائل النصية.
مثال على نص رسالة بنص عادي:
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 |
طول السلسلة الفرعية في نص رسالة النص العادي الذي يتوافق معه هذا التعليق التوضيحي. |
start_index |
بدء الفهرس (قائم على 0، شامل) في النص الأساسي لرسالة النص العادي الذي يتوافق مع هذا التعليق التوضيحي. |
حقل الاتحاد metadata . بيانات وصفية إضافية حول التعليق التوضيحي. يمكن أن يكون metadata واحدًا فقط مما يلي: |
|
user_mention |
البيانات الوصفية التي يشير إليها المستخدم |
slash_command |
البيانات الوصفية لأمر الشرطة المائلة. |
rich_link_metadata |
البيانات الوصفية لرابط منسّق. |
AnnotationType
نوع التعليق التوضيحي.
عمليات التعداد | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يُرجى عدم استخدامها. |
USER_MENTION |
تمت الإشارة إلى مستخدم. |
SLASH_COMMAND |
تم استدعاء أمر شرطة مائلة. |
RICH_LINK |
تعليق توضيحي للرابط المنسّق. |
AttachedGif
صورة GIF يتم تحديدها من خلال عنوان URL.
الحقول | |
---|---|
uri |
النتائج فقط. عنوان URL الذي يستضيف صورة GIF |
مرفق
مرفق في Google Chat
الحقول | |
---|---|
name |
اسم المورد للمرفق، بالتنسيق |
content_name |
النتائج فقط. اسم الملف الأصلي للمحتوى، وليس المسار الكامل. |
content_type |
النتائج فقط. نوع محتوى الملف (نوع MIME) |
thumbnail_uri |
النتائج فقط. تمثّل هذه السمة عنوان URL للصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق لمستخدم حقيقي. يجب ألا تستخدم التطبيقات في Chat عنوان URL هذا لتنزيل محتوى المرفقات. |
download_uri |
النتائج فقط. تمثّل هذه السمة عنوان URL للتنزيل الذي يجب استخدامه للسماح للمستخدم بتنزيل المرفق. يجب ألا تستخدم التطبيقات في Chat عنوان 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 |
اسم المورد لبيانات المرفق. يُستخدم هذا الحقل مع Media API لتنزيل بيانات المرفقات. |
attachment_upload_token |
رمز مميّز معتم يحتوي على مرجع إلى مرفق تم تحميله. يتعامل معها العملاء كسلسلة مبهمة وتُستخدَم لإنشاء رسائل Chat التي تتضمن مرفقات أو تعديلها. |
CardWithId
بطاقة في رسالة Google Chat
يمكن لتطبيقات Chat فقط إنشاء البطاقات. في حال تمت المصادقة كمستخدم في تطبيق Chat، لا يمكن أن تحتوي الرسالة على بطاقات.
تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات".
فتح "أداة إنشاء البطاقات"الحقول | |
---|---|
card_id |
هذا الخيار مطلوب إذا كانت الرسالة تحتوي على بطاقات متعددة. معرّف فريد لبطاقة في رسالة |
card |
بطاقة. الحد الأقصى للحجم هو 32 كيلوبايت. |
ChatSpaceLinkData
بيانات روابط مساحات Chat
الحقول | |
---|---|
space |
مساحة مرجع "مساحة Chat" المرتبط تنسيق الملف: |
thread |
سلسلة محادثات مرجع مساحة Chat المرتبطة تنسيق الملف: |
message |
رسالة مرجع مساحة Chat المرتبط. تنسيق الملف: |
CompleteImportSpaceRequest
طلب رسالة لإكمال عملية الاستيراد للمساحة
الحقول | |
---|---|
name |
مطلوب. اسم المورد لمساحة وضع الاستيراد تنسيق الملف: |
CompleteImportSpaceResponse
رسالة ردّ لإكمال عملية الاستيراد لمساحة
الحقول | |
---|---|
space |
مساحة وضع الاستيراد. |
ContextualAddOnMarkup
لا يحتوي هذا النوع على أي حقول.
الترميز المخصّص للمطوّرين لتحديد محتوى إضافة سياقية
بطاقة
البطاقة هي عنصر في واجهة المستخدم يمكن أن يحتوي على أدوات واجهة المستخدم مثل النصوص والصور.
الحقول | |
---|---|
header |
عنوان البطاقة عادةً ما يحتوي العنوان على عنوان وصورة. |
sections[] |
يتم فصل الأقسام بمقسم خط. |
card_actions[] |
إجراءات هذه البطاقة. |
name |
اسم البطاقة |
CardAction
الإجراء المرتبط بالبطاقة هو الإجراء المرتبط بالبطاقة. بالنسبة إلى بطاقة فواتير، يكون الإجراء النموذجي هو: حذف الفاتورة، أو البريد الإلكتروني، أو فتح الفاتورة في المتصفح.
غير متاح في تطبيقات Google Chat.
الحقول | |
---|---|
action_label |
التصنيف الذي كان معروضًا في عنصر قائمة الإجراءات |
on_click |
إجراء JSON لبند العمل هذا. |
CardHeader
الحقول | |
---|---|
title |
يجب تحديد العنوان. العنوان له ارتفاع ثابت: إذا تم تحديد كل من العنوان والعنوان الفرعي، فيتم تشغل كل منهما سطرًا واحدًا. إذا تم تحديد العنوان فقط، سيشغل كلا السطرين. |
subtitle |
العنوان الفرعي لرأس البطاقة |
image_style |
نوع الصورة (على سبيل المثال، حدود مربّعة أو حدود دائرية). |
image_url |
عنوان URL للصورة في عنوان البطاقة |
ImageStyle
عمليات التعداد | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
حد مربّع |
AVATAR |
حد دائري |
القسم
يحتوي القسم على مجموعة من الأدوات التي يتم عرضها (عموديًا) بالترتيب الذي تم تحديدها به. على جميع الأنظمة الأساسية، يكون عرض البطاقات ضيّقًا وثابتًا، لذلك ليست هناك حاجة حاليًا إلى خصائص التنسيق (على سبيل المثال، العدد العائم).
الحقول | |
---|---|
header |
تمثّل هذه السمة عنوان القسم. يمكن استخدام النص المنسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على المقالتَين تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace. |
widgets[] |
يجب أن يحتوي القسم على أداة واحدة على الأقل. |
CreateMembershipRequest
طلب رسالة لإنشاء عضوية
الحقول | |
---|---|
parent |
مطلوب. اسم مورد المساحة المطلوب إنشاء العضوية فيها. التنسيق: Spaces/{space} |
membership |
مطلوب. علاقة العضوية المراد إنشاؤها. يجب أن يحتوي الحقل |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 لا تتوفّر إمكانية إنشاء اشتراكات في التطبيقات أو إنشاء اشتراكات للمستخدمين خارج مؤسسة المشرف في Google Workspace باستخدام إذن وصول المشرف. |
CreateMessageRequest
ينشئ رسالة
الحقول | |
---|---|
parent |
مطلوب. اسم مورد المساحة التي سيتم إنشاء رسالة فيها تنسيق الملف: |
message |
مطلوب. نص الرسالة. |
thread_key |
اختياريّ. متوقّفة نهائيًا: استخدِم |
request_id |
اختياريّ. معرّف طلب فريد لهذه الرسالة. يؤدي تحديد معرّف طلب حالي إلى عرض الرسالة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء رسالة جديدة. |
message_reply_option |
اختياريّ. يحدِّد هذا الإعداد ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا يمكن تنفيذ هذا الإجراء إلا في المساحات المُعنونة. |
message_id |
اختياريّ. معرّف مخصّص لرسالة معيّنة يسمح هذا الإذن للتطبيقات في Chat بتلقّي رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين رقم التعريف الذي يعيّنه النظام في اسم مورد الرسالة (المتمثل في حقل الرسالة يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية:
للحصول على التفاصيل، يُرجى الاطِّلاع على تسمية رسالة. |
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 |
مطلوب. التفاعل المطلوب إنشائه. |
CreateSpaceRequest
طلب لإنشاء مساحة مُعنوَنة
الحقول | |
---|---|
space |
مطلوب. يجب تعبئة الحقلَين إذا ظهرت لك رسالة الخطأ يتم تخصيص المسافة |
request_id |
اختياريّ. معرّف فريد لهذا الطلب ننصحك باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد رقم تعريف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض رسالة خطأ. |
CustomEmoji
يمثل رمزًا تعبيريًا مخصصًا.
الحقول | |
---|---|
uid |
النتائج فقط. مفتاح فريد لمورد الرموز التعبيرية المخصّصة. |
DeleteMembershipRequest
طلب حذف عضوية في مساحة
الحقول | |
---|---|
name |
مطلوب. اسم مورد العضوية المطلوب حذفه. يمكن للتطبيقات في Chat حذف حسابات المستخدمين أو اشتراكاتهم الخاصة. لا يمكن للتطبيقات في Chat أن تحذف التطبيقات الأخرى. العضوية في القناة. عند حذف عضوية بشري، يجب استخدام نطاق عند حذف اشتراك في تطبيق، يجب استخدام نطاق التنسيق: |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 لا يمكنك حذف الاشتراكات الداعمة للتطبيقات في مساحة باستخدام إذن وصول المشرف. |
DeleteMessageRequest
طلب حذف رسالة
الحقول | |
---|---|
name |
مطلوب. اسم مورد الرسالة تنسيق الملف: في حال ضبط معرّف مخصّص لرسالتك، يمكنك استخدام القيمة من الحقل |
force |
عندما لا تنطبق إلا عند المصادقة كمستخدم. لا يحدث أي تأثير عند المصادقة كتطبيق Chat. |
DeleteReactionRequest
حذف تفاعل مع رسالة
الحقول | |
---|---|
name |
مطلوب. اسم التفاعل المطلوب حذفه تنسيق الملف: |
DeleteSpaceRequest
طلب لحذف مساحة
الحقول | |
---|---|
name |
مطلوب. اسم مورد المساحة المطلوب حذفها تنسيق الملف: |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 |
DeletionMetadata
معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط delete_time
.
الحقول | |
---|---|
deletion_type |
يشير إلى الشخص الذي حذف الرسالة. |
DeletionType
المستخدم الذي حذف الرسالة وكيفية حذفها.
عمليات التعداد | |
---|---|
DELETION_TYPE_UNSPECIFIED |
هذه القيمة غير مستخدمة. |
CREATOR |
حذَف المستخدم رسالته الخاصة. |
SPACE_OWNER |
حذف مالك المساحة الرسالة. |
ADMIN |
حذف مشرف Google Workspace الرسالة. |
APP_MESSAGE_EXPIRY |
حذف تطبيق Chat رسالته عند انتهاء صلاحيتها. |
CREATOR_VIA_APP |
حذَف تطبيق Chat الرسالة نيابةً عن المستخدم. |
SPACE_OWNER_VIA_APP |
حذَف تطبيق Chat الرسالة نيابةً عن مالك المساحة. |
مربّع حوار
ملفوف حول نص البطاقة في مربّع الحوار
الحقول | |
---|---|
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 |
مطلوب. اسم المورد للمستخدم الذي تريد العثور على رسالة مباشرة به التنسيق: |
GetAttachmentRequest
طلب الحصول على مرفق
الحقول | |
---|---|
name |
مطلوب. اسم المورد للمرفق، بالتنسيق |
GetMembershipRequest
طلب الانضمام إلى مساحة
الحقول | |
---|---|
name |
مطلوب. اسم مورد العضوية المطلوب استرداده. للحصول على الاشتراك في التطبيق من خلال مصادقة المستخدم، يمكنك استخدام التنسيق: عند المصادقة كمستخدم، يمكنك استخدام البريد الإلكتروني للمستخدم كعنوان بديل للبريد الإلكتروني في |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب هذا الإعداد توفُّر نطاقَي OAuth 2.0 أو لا يمكن تفعيل ميزة "العضوية في التطبيقات" في مساحة عند استخدام إذن وصول المشرف. |
GetMessageRequest
يمكنك طلب تلقّي رسالة.
الحقول | |
---|---|
name |
مطلوب. اسم مورد الرسالة تنسيق الملف: في حال ضبط معرّف مخصّص لرسالتك، يمكنك استخدام القيمة من الحقل |
GetSpaceEventRequest
يمكنك طلب تلقّي رسالة لتلقّي حدث في المساحة.
الحقول | |
---|---|
name |
مطلوب. اسم المورد لحدث المساحة تنسيق الملف: |
GetSpaceReadStateRequest
طلب رسالة لواجهة برمجة تطبيقات GetSpaceReadState.
الحقول | |
---|---|
name |
مطلوب. اسم المورد لحالة قراءة المساحة المطلوب استردادها لا تتوافق هذه الميزة إلا مع الحصول على حالة القراءة للمستخدم المتصل. للإشارة إلى المستخدم الذي يتصل بتطبيقك، عليك ضبط أحد الخيارات التالية:
التنسيق: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
طلب لعرض مساحة واحدة
الحقول | |
---|---|
name |
مطلوب. اسم مورد المساحة، بالتنسيق تنسيق الملف: |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب هذا الإعداد توفُّر نطاقَي OAuth 2.0 أو |
GetThreadReadStateRequest
طلب رسالة لواجهة برمجة تطبيقات GetThreadReadStateRequest.
الحقول | |
---|---|
name |
مطلوب. اسم المورد لحالة قراءة سلسلة المحادثات المطلوب استردادها لا تتوافق هذه الميزة إلا مع الحصول على حالة القراءة للمستخدم المتصل. للإشارة إلى المستخدم الذي يتصل بتطبيقك، عليك ضبط أحد الخيارات التالية:
التنسيق: 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 للمؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات. |
ListMembershipsRequest
اطلب رسالة عن العضويات في القناة.
الحقول | |
---|---|
parent |
مطلوب. اسم مورد المساحة التي يمكنك استرجاع قائمة عضوية لها. التنسيق: Spaces/{space} |
page_size |
اختياريّ. الحدّ الأقصى لعدد العضويات المطلوب عرضها قد تعرض الخدمة أقل من هذه القيمة. وفي حال عدم تحديد قيمة هذا الخيار، يتم إرجاع 100 عضوية كحدّ أقصى. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة خطأ |
page_token |
اختياريّ. رمز مميّز للصفحة، تم تلقّيه من مكالمة سابقة لإدراج العضويات في القناة. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المعلمات الأخرى المقدّمة مع الاستدعاء الذي قدّم الرمز المميز للصفحة. قد يؤدي تمرير قيم مختلفة إلى المعلَمات الأخرى إلى نتائج غير متوقعة. |
filter |
اختياريّ. فلتر طلب بحث يمكنك فلترة الاشتراكات حسب دور العضو ( للفلترة حسب الدور، اضبط للفلترة حسب النوع، اضبط للفلترة حسب كل من الدور والنوع، استخدِم عامل التشغيل يجب إدخال إما على سبيل المثال، طلبات البحث التالية صالحة:
طلبات البحث التالية غير صالحة:
يرفض الخادم طلبات البحث غير الصالحة مع ظهور الخطأ |
show_groups |
اختياريّ. عند تلقّي عضوية في قناة |
show_invited |
اختياريّ. عند عرض " تتطلب حاليًا مصادقة المستخدم. |
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 لا يمكن إدراج اشتراكات التطبيقات في مساحة عند استخدام إذن الوصول الإداري. |
ListMembershipsResponse
الرد لإدراج أعضاء المساحة في المساحة
الحقول | |
---|---|
memberships[] |
قائمة بدون ترتيب. قائمة العضويات الظاهرة على الصفحة المطلوبة (أو الأولى) |
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 |
الرمز المميز للمتابعة لاسترداد الصفحة التالية من النتائج. هذا الحقل فارغ للصفحة الأخيرة من النتائج. |
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. يمكن لتطبيقات Chat معاينة عناوين URL المطابقة. لمزيد من المعلومات، يُرجى الاطّلاع على روابط المعاينة.
الحقول | |
---|---|
url |
النتائج فقط. تمثّل هذه السمة عنوان URL المطابق. |
العضوية
تمثّل هذه السمة علاقة العضوية في Google Chat، سواء تمت دعوة مستخدم أو تطبيق Chat إلى مساحة أو جزء منها أو عدم حضورها.
الحقول | |
---|---|
name |
اسم مورد الاشتراك الذي ضبطه الخادم تنسيق الملف: |
state |
النتائج فقط. حالة الاشتراك |
role |
اختياريّ. دور المستخدم ضمن مساحة Chat، والذي يحدِّد الإجراءات المسموح بها في المساحة يمكن استخدام هذا الحقل كإدخال فقط في |
create_time |
اختياريّ. غير قابل للتغيير. وقت إنشاء العضوية، مثل وقت انضمام عضو إلى مساحة أو دعوته للانضمام إليها هذا الحقل ناتج فقط، إلا عند استخدامه لاستيراد الاشتراكات السابقة في مساحات وضع الاستيراد. |
delete_time |
اختياريّ. غير قابل للتغيير. وقت حذف العضوية، مثل وقت مغادرة أحد الأعضاء للمساحة أو إزالته منها هذا الحقل ناتج فقط، إلا عند استخدامه لاستيراد الاشتراكات السابقة في مساحات وضع الاستيراد. |
حقل الاتحاد memberType . العضو المرتبط بهذه العضوية وقد يُتاح استخدام أنواع الأعضاء الأخرى في المستقبل. يمكن أن يكون memberType واحدًا فقط مما يلي: |
|
member |
مستخدِم أو تطبيق Google Chat الذي تتوافق معه العضوية. في حال تمت المصادقة كمستخدم في تطبيق Chat، ستتم تعبئة المستخدم |
group_member |
"مجموعة Google" المتوافقة مع العضوية. |
MembershipRole
تمثيل إجراءات المستخدم المسموح بها في مساحة Chat ويمكن إضافة المزيد من قيم التعداد في المستقبل.
عمليات التعداد | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
القيمة التلقائية. بالنسبة إلى users : هذا الشخص ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى Google Groups : يتم دائمًا منح هذا الدور لهم (قد يتم استخدام قيم التعداد الأخرى في المستقبل). |
ROLE_MEMBER |
عضو في المساحة يمتلك المستخدم الأذونات الأساسية، مثل إرسال الرسائل إلى المساحة. في المحادثات بين شخصين والمحادثات الجماعية بدون اسم، يحصل جميع المستخدمين على هذا الدور. |
ROLE_MANAGER |
مدير مساحة يمتلك المستخدم جميع الأذونات الأساسية بالإضافة إلى الأذونات الإدارية التي تتيح له إدارة المساحة، مثل إضافة الأعضاء أو إزالتهم. لا تتوفَّر هذه الميزة إلّا في SpaceType.SPACE . |
MembershipState
تحدِّد علاقة العضو بالمساحة. وقد نتيح في المستقبل استخدام حالات عضوية أخرى.
عمليات التعداد | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
القيمة التلقائية. يُرجى عدم استخدامها. |
JOINED |
تتم إضافة المستخدم إلى المساحة ويمكنه المشاركة فيها. |
INVITED |
تمت دعوة المستخدم للانضمام إلى المساحة، ولكنه لم ينضم إليها. |
NOT_A_MEMBER |
لا ينتمي المستخدم إلى المساحة وليس لديه دعوة في انتظار المراجعة للانضمام إلى المساحة. |
MembershipBatchCreatedEventData
حمولة الأحداث لعدة عضويات جديدة
نوع الحدث: google.workspace.chat.membership.v1.batchCreated
الحقول | |
---|---|
memberships[] |
قائمة بالاشتراكات الجديدة |
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، ستتم تعبئة المستخدم |
create_time |
اختياريّ. غير قابل للتغيير. وقت إنشاء الرسالة في المساحات التي تم إنشاؤها في Chat هذا الحقل هو الناتج فقط، إلا عند استخدامه في مساحات وضع الاستيراد. بالنسبة إلى مساحات وضع الاستيراد، يجب ضبط هذا الحقل على الطابع الزمني السابق الذي تم إنشاء الرسالة فيه في المصدر للحفاظ على وقت الإنشاء الأصلي. |
last_update_time |
النتائج فقط. الوقت الذي عدّل فيه المستخدم الرسالة آخر مرة. وإذا لم يتم تعديل الرسالة مطلقًا، سيكون هذا الحقل فارغًا. |
delete_time |
النتائج فقط. وقت حذف الرسالة في Google Chat إذا لم يتم حذف الرسالة مطلقًا، سيكون هذا الحقل فارغًا. |
text |
نص عادي للرسالة. ينشئ الرابط الأول لصورة أو فيديو أو صفحة ويب شريحة معاينة. يمكنك أيضًا الإشارة باستخدام@إلى مستخدم Google Chat أو جميع المشاركين في المساحة. لمعرفة كيفية إنشاء الرسائل النصية، راجع إرسال رسالة نصية. |
formatted_text |
النتائج فقط. يحتوي على الرسالة
للمزيد من المعلومات، يُرجى الاطّلاع على مقالة عرض تنسيق النص المُرسَل في رسالة. |
cards[] |
متوقّفة نهائيًا: استخدِم بطاقات تفاعلية ومنسّقة وتفاعلية يمكنك استخدامها لعرض عناصر واجهة المستخدم، مثل النصوص المنسّقة والأزرار والصور القابلة للنقر. يتم عرض البطاقات عادةً أسفل النص العادي للرسالة. يمكن أن يصل الحد الأقصى لحجم الملفَين |
cards_v2[] |
مصفوفة من البطاقات. يمكن لتطبيقات Chat فقط إنشاء البطاقات. في حال تمت المصادقة كمستخدم لتطبيق Chat، لا يمكن أن تحتوي الرسائل على بطاقات. للاطّلاع على البطاقات وكيفية إنشائها، راجِع إرسال رسائل البطاقات. تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات". فتح "أداة إنشاء البطاقات" |
annotations[] |
النتائج فقط. التعليقات التوضيحية المرتبطة بـ |
thread |
سلسلة المحادثات التي تنتمي إليها الرسالة. على سبيل المثال، يمكنك الاطّلاع على بدء سلسلة رسائل أو الرد عليها. |
space |
في حال تمت المصادقة كمستخدم لتطبيق Chat، تتم تعبئة المساحة |
fallback_text |
وصف بنص عادي لبطاقات الرسالة، يُستخدم عندما يتعذّر عرض البطاقات، مثل إشعارات الأجهزة الجوّالة. |
action_response |
الإدخال فقط. المَعلمات التي يمكن أن يستخدمها تطبيق Chat لضبط طريقة نشر ردّه |
argument_text |
النتائج فقط. نص عادي للرسالة مع إزالة جميع الإشارات إلى تطبيقات Chat |
slash_command |
النتائج فقط. معلومات عن الأوامر التي تبدأ بشرطة مائلة، إن أمكن |
attachment[] |
مرفق حمّله مستخدم |
matched_url |
النتائج فقط. عنوان URL في |
thread_reply |
النتائج فقط. عندما إذا كانت المساحة لا تتيح الرد في سلاسل المحادثات، سيكون هذا الحقل دائمًا |
client_assigned_message_id |
اختياريّ. معرّف مخصّص للرسالة يمكنك استخدام الحقل لتحديد رسالة أو للحصول على رسالة أو حذفها أو تعديلها. لإعداد معرّف مخصّص، حدِّد الحقل |
emoji_reaction_summaries[] |
النتائج فقط. قائمة ملخّصات التفاعلات باستخدام الرموز التعبيرية على الرسالة |
private_message_viewer |
غير قابل للتغيير. حقل لإنشاء رسالة، وللإخراج فقط. المستخدم الذي يمكنه عرض الرسالة عند ضبط هذه السياسة، تكون الرسالة خاصة ولا تظهر إلا للمستخدم المحدّد وتطبيق Chat. لا تتوفّر معاينات ومرفقات الروابط للرسائل الخاصة. يمكن لتطبيقات Chat فقط إرسال رسائل خاصة. في حال تمت المصادقة كمستخدم لتطبيق Chat، لا يمكن أن تكون الرسالة خاصة ويجب حذف هذا الحقل. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة إرسال رسائل خاصة إلى مستخدمي Google Chat. |
deletion_metadata |
النتائج فقط. معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط " |
quoted_message_metadata |
النتائج فقط. معلومات عن رسالة اقتبسها أحد مستخدمي Google Chat في مساحة يمكن لمستخدمي Google Chat اقتباس رسالة للرد عليها. |
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 |
الرسالة المحذوفة. تتم تعبئة الحقول |
MessageUpdatedEventData
حمولة الحدث لرسالة معدَّلة
نوع الحدث: google.workspace.chat.message.v1.updated
الحقول | |
---|---|
message |
الرسالة المعدَّلة |
QuotedMessageMetadata
معلومات حول رسالة مُقتبَسة
الحقول | |
---|---|
name |
النتائج فقط. اسم مورد الرسالة المقتبَسة تنسيق الملف: |
last_update_time |
النتائج فقط. الطابع الزمني لوقت إنشاء الرسالة المقتبَسة أو وقت آخر تعديل للرسالة المُقتبَسة |
فيديو يعرض ردود فعل
تفاعل مع رسالة
الحقول | |
---|---|
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 |
التفاعل المحذوف. |
RichLinkMetadata
تمثّل هذه السمة رابطًا منسّقًا يؤدي إلى مرجع.
الحقول | |
---|---|
uri |
معرّف الموارد المنتظم (URI) لهذا الرابط. |
rich_link_type |
نوع الرابط المنسّق. |
حقل الاتحاد data . بيانات المرجع المرتبط يمكن أن يكون data واحدًا فقط مما يلي: |
|
drive_link_data |
بيانات رابط Drive. |
chat_space_link_data |
بيانات رابط مساحة Chat |
RichLinkType
نوع الرابط المنسّق. ويمكن إضافة المزيد من الأنواع في المستقبل.
عمليات التعداد | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يُرجى عدم استخدامها. |
DRIVE_FILE |
نوع من الروابط المنسّقة في Google Drive. |
CHAT_SPACE |
نوع من الروابط الغنية بصريًا لمساحات Chat. على سبيل المثال، شريحة ذكية لمساحات. |
SearchSpacesRequest
يمكنك طلب البحث عن قائمة مساحات استنادًا إلى طلب بحث.
الحقول | |
---|---|
use_admin_access |
عند يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 تتيح هذه الطريقة حاليًا إذن الوصول الإداري فقط، وبالتالي يتم قبول |
page_size |
الحد الأقصى لعدد المسافات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. وفي حال عدم تحديد قيمة هذه السمة، يتم عرض 100 مسافة كحدّ أقصى. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. |
page_token |
رمز مميّز تم تلقّيه من المكالمة السابقة لمساحات البحث قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند التقسيم على صفحات، يجب أن تتطابق جميع المعلمات الأخرى المقدّمة مع الاستدعاء الذي قدّم الرمز المميز للصفحة. قد يؤدي تمرير قيم مختلفة إلى المعلَمات الأخرى إلى نتائج غير متوقعة. |
query |
مطلوب. طلب بحث يمكنك البحث باستخدام المَعلمات التالية:
يقبل كل من تكون لا يقبل يقبل لا تقبل الدالة يجب توفير في الحقول المختلفة، يمكن استخدام ضمن الحقل نفسه، لا يتوافق في ما يلي أمثلة طلبات البحث الصالحة:
|
order_by |
اختياريّ. كيفية ترتيب قائمة المساحات السمات المتوافقة مع الطلب هي:
القيم الصالحة لعملية الطلب هي:
الصيغة المتوافقة هي:
|
SearchSpacesResponse
ردّ يتضمّن قائمة بالمساحات المتوافقة مع طلب مساحات البحث.
الحقول | |
---|---|
spaces[] |
صفحة من المساحات المطلوبة. |
next_page_token |
هو رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة. |
total_size |
إجمالي عدد المساحات التي تطابق طلب البحث في جميع الصفحات. إذا كانت النتيجة أكثر من 10,000 مسافة، تكون هذه القيمة تقديرية. |
SetUpSpaceRequest
يمكنك طلب إنشاء مساحة وإضافة مستخدمين محدّدين إليها.
الحقول | |
---|---|
space |
مطلوب. يجب ملء الحقل لإنشاء مساحة، يجب ضبط لإنشاء محادثة جماعية، اضبط لإنشاء محادثة بين مستخدمَين، اضبط لإنشاء محادثة فردية بين مستخدم وتطبيق Chat الذي يجري الاتصال، اضبط في حال توفُّر مساحة |
request_id |
اختياريّ. معرّف فريد لهذا الطلب ننصحك باستخدام معرّف فريد عالمي (UUID) عشوائي. يؤدي تحديد رقم تعريف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض رسالة خطأ. |
memberships[] |
اختياريّ. المستخدمون أو المجموعات على Google Chat المطلوب دعوتهم للانضمام إلى المساحة. احذف اسم المستخدم المتصل لأنّه تتم إضافته تلقائيًا. تتيح هذه الميزة حاليًا إضافة ما يصل إلى 20 عضوية (بالإضافة إلى المتصل). بالنسبة إلى عضوية المستخدمين، يجب أن يحتوي الحقل بالنسبة إلى عضوية مجموعة 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 |
النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة (DM) التي تتضمّن تطبيق Chat، سواء أنشأ مشرف Google Workspace المساحة أم لا. يمكن للمشرفين تثبيت رسالة مباشرة وإعدادها باستخدام تطبيق في Chat نيابةً عن المستخدمين في مؤسستهم. لإتاحة التثبيت من خلال المشرف، يجب أن يتضمّن تطبيق Chat ميزة الرسائل المباشرة. |
membership_count |
النتائج فقط. يشير هذا المقياس إلى عدد العضويات في القناة مجمّعة حسب نوع العضوية. تتم تعبئة هذا الحقل عند ضبط |
access_settings |
اختياريّ. تُحدِّد إعدادات الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة |
space_uri |
النتائج فقط. معرّف الموارد المنتظم (URI) الخاص بالمستخدم للوصول إلى المساحة |
حقل الاتحاد 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 |
ما إذا كان الأعضاء غير الإداريين لديهم هذا الإذن أم لا. |
PermissionSettings
إعدادات الأذونات لمساحة مُعنوَنة لضبط إعدادات الأذونات عند إنشاء مساحة، حدِّد الحقل PredefinedPermissionSettings
في طلبك.
الحقول | |
---|---|
manage_members_and_groups |
إعداد لإدارة الأعضاء والمجموعات في المساحة. |
modify_space_details |
إعداد لتعديل اسم المساحة وصورتها الرمزية ووصفها وإرشاداتها |
toggle_history |
إعداد للتبديل بين تفعيل سجلّ المساحات وإيقافه. |
use_at_mention_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 |
هي رسائل مباشرة بين شخصين ومحادثات جماعية بين 3 أشخاص أو أكثر. |
SpaceType
نوع المساحة. هذا الحقل مطلوب عند إنشاء مساحة أو تعديلها. الناتج فقط للاستخدامات الأخرى.
عمليات التعداد | |
---|---|
SPACE_TYPE_UNSPECIFIED |
محجوز. |
SPACE |
مكان يمكن للأشخاص من خلاله إرسال الرسائل ومشاركة الملفات والتعاون معهم. يمكن أن تتضمّن السمة SPACE تطبيقات Chat. |
GROUP_CHAT |
محادثات جماعية بين 3 أشخاص أو أكثر. يمكن أن تتضمّن السمة GROUP_CHAT تطبيقات Chat. |
DIRECT_MESSAGE |
الرسائل الفردية بين مستخدمَين أو مستخدم وتطبيق Chat |
النوع
متوقّفة نهائيًا: استخدِم SpaceType
بدلاً منها.
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
محجوز. |
ROOM |
المحادثات بين شخصين أو أكثر. |
DM |
رسالة مباشرة بين مستخدم وتطبيق في Chat، حيث تكون جميع الرسائل مسطحة يُرجى العلم أنّ هذا الخيار لا يشمل الرسائل المباشرة بين شخصين. |
SpaceBatchUpdatedEventData
حمولة الأحداث لإجراء تعديلات متعددة على مساحة
نوع الحدث: google.workspace.chat.space.v1.batchUpdated
الحقول | |
---|---|
spaces[] |
قائمة بالمساحات المعدَّلة |
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 |
حمولة الأحداث لتفاعلات متعددة محذوفة نوع الحدث: |
SpaceReadState
حالة القراءة للمستخدم داخل مساحة، ويتم استخدامها لتحديد الرسائل المقروءة وغير المقروءة.
الحقول | |
---|---|
name |
اسم المورد لحالة القراءة في المساحة تنسيق الملف: |
last_read_time |
اختياريّ. الوقت الذي تم فيه تعديل حالة قراءة مساحة المستخدم وعادةً ما يتوافق هذا مع الطابع الزمني لآخر رسالة مقروءة أو طابع زمني يحدّده المستخدم لوضع علامة على آخر موضع قراءة في إحدى المساحات. |
SpaceUpdatedEventData
حمولة الأحداث في مساحة محدَّثة
نوع الحدث: google.workspace.chat.space.v1.updated
الحقول | |
---|---|
space |
المساحة المعدّلة |
Thread
سلسلة محادثات في مساحة Google Chat على سبيل المثال، يمكنك الاطّلاع على بدء سلسلة رسائل أو الرد عليها.
إذا حدّدت سلسلة محادثات عند إنشاء رسالة، يمكنك ضبط الحقل messageReplyOption
لتحديد ما يحدث في حال عدم العثور على سلسلة محادثات مطابقة.
الحقول | |
---|---|
name |
اسم مورد سلسلة المحادثات مثلاً: |
thread_key |
اختياريّ. حقل إدخال لإنشاء سلسلة محادثات أو تعديلها في الحالات الأخرى، يتم عرض الناتج فقط. رقم تعريف سلسلة المحادثات يمكن استخدام ما يصل إلى 4,000 حرف. ويكون هذا المعرّف فريدًا لتطبيق Chat الذي يضبطه. على سبيل المثال، في حال إنشاء عدة تطبيقات في Chat رسالة باستخدام مفتاح سلسلة المحادثات نفسه، يتم نشر الرسائل في سلاسل محادثات مختلفة. للرد في سلسلة محادثات أنشأها مستخدم أو تطبيق آخر في Chat، حدِّد حقل سلسلة المحادثات |
ThreadReadState
حالة القراءة للمستخدم داخل سلسلة محادثات، وتُستخدم لتحديد الرسائل المقروءة وغير المقروءة.
الحقول | |
---|---|
name |
اسم المورد لحالة قراءة سلسلة المحادثات تنسيق الملف: |
last_read_time |
الوقت الذي تم فيه تعديل حالة قراءة سلسلة محادثات المستخدم يتجاوب هذا عادةً مع الطابع الزمني لآخر رسالة مقروءة في سلسلة المحادثات. |
UpdateMembershipRequest
طلب رسالة لتعديل الاشتراك
الحقول | |
---|---|
membership |
مطلوب. الاشتراك المطلوب تعديله يتم تعديل الحقول التي يحدِّدها |
update_mask |
مطلوب. مسارات الحقول المطلوب تعديلها. افصل بين القيم المتعدّدة بفواصل أو استخدِم مسارات الحقول المتوافقة حاليًا:
|
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 |
UpdateMessageRequest
طلب تعديل رسالة
الحقول | |
---|---|
message |
مطلوب. تم تعديل رسالة تحتوي على حقول. |
update_mask |
مطلوب. مسارات الحقول المطلوب تعديلها. افصل بين القيم المتعدّدة بفواصل أو استخدِم مسارات الحقول المتوافقة حاليًا:
|
allow_missing |
اختياريّ. في حال عدم العثور على |
UpdateSpaceReadStateRequest
طلب رسالة لواجهة برمجة تطبيقات UpdateSpaceReadState.
الحقول | |
---|---|
space_read_state |
مطلوب. حالة قراءة المساحة والحقول المطلوب تعديلها. لا تتوافق هذه الميزة إلا مع تعديل حالة القراءة للمستخدم المتصل. للإشارة إلى المستخدم الذي يتصل بتطبيقك، عليك ضبط أحد الخيارات التالية:
التنسيق: users/{user}/spaces/{space}/spaceReadState |
update_mask |
مطلوب. مسارات الحقول المطلوب تعديلها. مسارات الحقول المتوافقة حاليًا:
عندما يكون لوضع علامة "مقروءة" على المساحة، اضبط |
UpdateSpaceRequest
طلب لتعديل مساحة واحدة
الحقول | |
---|---|
space |
مطلوب. مساحة تحتوي على حقول سيتم تعديلها. يجب ملء |
update_mask |
مطلوب. مسارات الحقول المعدَّلة، مفصولة بفواصل إذا كانت هناك عدة مسارات. يمكنك تعديل الحقول التالية للمساحة:
|
use_admin_access |
true ، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات". يتطلب نطاق OAuth 2.0 بعض قيم |
مستخدم
مستخدم في Google Chat عند عرض نتيجة من طلب، في حال تمت المصادقة كمستخدم في تطبيق Chat، لا تتم تعبئة نتائج مورد User
إلا name
وtype
للمستخدم.
الحقول | |
---|---|
name |
اسم المورد لـ التنسيق: بالنسبة إلى
|
display_name |
النتائج فقط. الاسم المعروض للمستخدم |
domain_id |
المعرّف الفريد لنطاق Google Workspace الخاص بالمستخدم |
type |
نوع المستخدِم. |
is_anonymous |
النتائج فقط. عند |
النوع
عمليات التعداد | |
---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يُرجى عدم استخدامها. |
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
يصف إجراء النموذج السلوك الذي يتم عند إرساله. على سبيل المثال، يمكنك استدعاء "برمجة تطبيقات Google" للتعامل مع النموذج.
الحقول | |
---|---|
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 |
|