- المورد: Message
- تمثيل JSON
- البطاقة
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- الرمز
- Button
- TextButton
- ImageButton
- CardAction
- CardWithId
- البطاقة
- CardHeader
- ImageType
- Section
- التطبيق المصغّر
- TextParagraph
- TextSyntax
- Image
- OnClick
- الإجراء
- ActionParameter
- LoadIndicator
- التفاعل
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- الرمز
- MaterialIcon
- DecoratedText
- VerticalAlignment
- Button
- اللون
- النوع
- SwitchControl
- ControlType
- ButtonList
- TextInput
- النوع
- الاقتراحات
- SuggestionItem
- التحقّق
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- النوع
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- الفاصل
- الشبكة
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- الأعمدة
- العمود
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- التطبيقات المصغَّرة
- ChipList
- التصميم
- شريحة
- لوحة العرض الدوّارة
- CarouselCard
- NestedWidget
- مستوى العرض
- EventAction
- المشغّل
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- الحالة
- ExpressionDataCondition
- ConditionType
- التعليق التوضيحي
- AnnotationType
- UserMentionMetadata
- النوع
- SlashCommandMetadata
- النوع
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- MeetSpaceLinkData
- النوع
- HuddleStatus
- CalendarEventLinkData
- CustomEmojiMetadata
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- QuoteType
- QuotedMessageSnapshot
- ForwardedMetadata
- AttachedGif
- AccessoryWidget
- العناصر
- CitedSource
- المقتطف
- ElementsImage
- التذييل
- Citation
- MarkupSyntax
- الطُرق
المورد: رسالة
رسالة في مساحة Google Chat
| تمثيل JSON |
|---|
{ "name": string, "sender": { object ( |
| الحقول | |
|---|---|
name |
المعرّف. اسم مورد الرسالة التنسيق: حيث يمثّل إذا ضبطت معرّفًا مخصّصًا عند إنشاء رسالة، يمكنك استخدام هذا المعرّف لتحديد الرسالة في طلب من خلال استبدال |
sender |
للعرض فقط. المستخدم الذي أنشأ الرسالة إذا كان تطبيق Chat يُجري المصادقة كمستخدم، لن يعرض الناتج سوى الحقلَين |
createTime |
اختيارية: غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يشير هذا الحقل إلى وقت إنشاء الرسالة. هذا الحقل مخصّص للإخراج فقط، إلا عند استخدامه في مساحات وضع الاستيراد. بالنسبة إلى مساحات وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني القديم الذي تم إنشاء الرسالة فيه في المصدر من أجل الحفاظ على وقت الإنشاء الأصلي. |
lastUpdateTime |
للعرض فقط. الوقت الذي عدّل فيه المستخدم الرسالة آخر مرة إذا لم يتم تعديل الرسالة مطلقًا، سيكون هذا الحقل فارغًا. |
deleteTime |
للعرض فقط. الوقت الذي تم فيه حذف الرسالة في Google Chat إذا لم يتم حذف الرسالة مطلقًا، سيكون هذا الحقل فارغًا. |
text |
اختيارية: النص العادي للرسالة يؤدي الرابط الأول إلى صورة أو فيديو أو صفحة ويب إلى إنشاء شريحة معاينة. يمكنك أيضًا الإشارة باستخدام@إلى مستخدم Google Chat أو إلى جميع المستخدمين في المساحة. لمعرفة كيفية إنشاء رسائل نصية، يُرجى الاطّلاع على مقالة إرسال رسالة. |
formattedText |
للعرض فقط. تحتوي على الرسالة
لمزيد من المعلومات، يُرجى الاطّلاع على المقالة عرض تنسيق النص المُرسَل في رسالة. |
cards[] |
تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة بطاقات غنية ومنسّقة وتفاعلية يمكنك استخدامها لعرض عناصر في واجهة المستخدم، مثل النصوص المنسّقة والأزرار والصور القابلة للنقر يتم عادةً عرض البطاقات أسفل نص الرسالة العادي. يمكن أن يبلغ الحد الأقصى لحجم |
cardsV2[] |
اختيارية: مصفوفة من البطاقات يمكن لتطبيقات Chat إنشاء بطاقات باستخدام مصادقة التطبيق. كجزء من برنامج معاينة المطوّر، إذا كان تطبيق Chat يصادق كمستخدم، يمكنه إنشاء رسائل بطاقات. إذا لم يكن تطبيق Chat جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتطلّب مصادقة المستخدم. للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، يُرجى الاطّلاع على إرسال رسالة. صمِّم البطاقات وعايِنها باستخدام Card Builder. فتح "أداة إنشاء البطاقات" |
annotations[] |
للعرض فقط. يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بمراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع |
thread |
سلسلة المحادثات التي تنتمي إليها الرسالة للاطّلاع على مثال على الاستخدام، يُرجى مراجعة بدء سلسلة رسائل أو الردّ عليها. |
space |
للعرض فقط. إذا كان تطبيق Chat يُجري المصادقة كمستخدم، لن يعرض الناتج سوى المساحة |
fallbackText |
اختيارية: وصف نصي عادي لبطاقات الرسالة، يُستخدَم عندما يتعذّر عرض البطاقات الفعلية، على سبيل المثال، في الإشعارات إلى الجهاز الجوّال. |
actionResponse |
الإدخال فقط المَعلمات التي يمكن لتطبيق Chat استخدامها لضبط كيفية نشر ردّه |
argumentText |
للعرض فقط. النص العادي للرسالة مع إزالة جميع الإشارات إلى تطبيق Chat |
slashCommand |
للعرض فقط. معلومات عن الأمر الذي يبدأ بشرطة مائلة، إن توفّرت |
attachment[] |
اختيارية: مرفق حمّله المستخدم |
matchedUrl |
للعرض فقط. عنوان URL في حقل "رسالة المحادثة" |
threadReply |
للعرض فقط. عندما تكون قيمة الحقل إذا كانت المساحة لا تتيح الردّ في سلاسل محادثات، يكون هذا الحقل دائمًا |
silent |
للعرض فقط. ما إذا كانت هذه رسالة صامتة الرسائل الصامتة هي رسائل يحجب فيها Chat الإشعارات الفورية للمستلِمين. |
clientAssignedMessageId |
اختيارية: معرّف مخصّص للرسالة يمكنك استخدام هذا الحقل لتحديد رسالة أو الحصول عليها أو حذفها أو تعديلها. لضبط معرّف مخصّص، حدِّد الحقل |
emojiReactionSummaries[] |
للعرض فقط. قائمة ملخّصات التفاعلات باستخدام الإيموجي في الرسالة |
privateMessageViewer |
اختيارية: غير قابل للتغيير يُستخدم لإنشاء رسالة، وإلا يكون للإخراج فقط. المستخدم الذي يمكنه عرض الرسالة عند ضبط هذا الحقل، تكون الرسالة خاصة ولا تظهر إلا للمستخدم المحدّد وتطبيق Chat. لتضمين هذا الحقل في طلبك، عليك طلب Chat API باستخدام مصادقة التطبيق وحذف ما يلي: لمعرفة التفاصيل، يُرجى الاطّلاع على إرسال رسالة خاصة. |
deletionMetadata |
للعرض فقط. معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط |
quotedMessageMetadata |
اختيارية: معلومات حول رسالة تقتبسها رسالة أخرى عند إنشاء رسالة، يمكنك اقتباس رسائل ضمن سلسلة المحادثات نفسها، أو اقتباس رسالة جذرية لإنشاء رسالة جذرية جديدة. ومع ذلك، لا يمكنك اقتباس ردّ على رسالة من سلسلة محادثات مختلفة. عند تعديل رسالة، لا يمكنك إضافة الحقل للاطّلاع على مثال على الاستخدام، يُرجى مراجعة اقتباس رسالة أخرى. |
attachedGifs[] |
للعرض فقط. صور GIF المرفقة بالرسالة |
accessoryWidgets[] |
اختيارية: عنصر واجهة مستخدم تفاعلي واحد أو أكثر يظهر في أسفل الرسالة يمكنك إضافة تطبيقات مصغّرة ملحقة إلى الرسائل التي تحتوي على نص أو بطاقات أو كليهما. لا تتوفّر هذه الميزة للرسائل التي تحتوي على مربّعات حوار. لمعرفة التفاصيل، يُرجى الاطّلاع على إضافة تطبيقات مصغّرة تفاعلية في أسفل الرسالة. يتطلب إنشاء رسالة تتضمّن تطبيقات مصغّرة ملحقة مصادقة التطبيق. |
elements |
اختيارية: العناصر هي مكوّنات إضافية يتم توفيرها أثناء إنشاء الرسالة، وقد تكون مرتبطة بأجزاء معيّنة من نص الرسالة أو لا. وتختلف هذه عن التعليقات التوضيحية التي تكون مخصّصة للإخراج فقط وتقدّم معلومات تكميلية مرتبطة بأجزاء من الرسالة أو بنص الرسالة بالكامل. |
markupSyntax |
اختيارية: تحدّد هذه السمة كيفية تفسير الخادم لمحتوى حقل الرسالة |
CardWithId
بطاقة في رسالة محادثة في Google Chat
يمكن لتطبيقات Chat إنشاء بطاقات باستخدام مصادقة التطبيق. كجزء من برنامج معاينة المطوّر، إذا كان تطبيق Chat يصادق كمستخدم، يمكنه إنشاء رسائل بطاقات. إذا لم يكن تطبيق Chat جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتطلّب مصادقة المستخدم.
للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، يُرجى الاطّلاع على إرسال رسالة.
صمِّم البطاقات وعايِنها باستخدام Card Builder.
فتح "أداة إنشاء البطاقات"| تمثيل JSON |
|---|
{ "cardId": string, "card": { object ( |
| الحقول | |
|---|---|
cardId |
مطلوبة إذا كانت الرسالة تحتوي على بطاقات متعددة. معرّف فريد لبطاقة في رسالة |
card |
بطاقة. الحد الأقصى للحجم هو 32 كيلوبايت. |
ownerUser |
للعرض فقط. التطبيق الذي يملك البطاقة |
تعليق توضيحي
يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بمراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع startIndex و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"
}
}]
| تمثيل JSON |
|---|
{ "type": enum ( |
| الحقول | |
|---|---|
type |
نوع هذا التعليق التوضيحي |
length |
طول السلسلة الفرعية في نص الرسالة العادي الذي يتوافق معه هذا التعليق التوضيحي في حال عدم توفّرها، تشير إلى أنّ المدة هي 0. |
startIndex |
فهرس البداية (يبدأ من 0، شامل) في نص الرسالة العادي الذي يتوافق معه هذا التعليق التوضيحي. |
| بيانات وصفية إضافية حول التعليق التوضيحي في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
userMention |
البيانات الوصفية للإشارة إلى المستخدم |
slashCommand |
البيانات الوصفية لأمر يبدأ بشرطة مائلة |
richLinkMetadata |
البيانات الوصفية لرابط منسَّق |
customEmojiMetadata |
البيانات الوصفية لإيموجي مخصّص |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
AnnotationType
نوع التعليق التوضيحي
| عمليات التعداد | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يجب عدم استخدامها. |
USER_MENTION |
تمت الإشارة إلى مستخدم. |
SLASH_COMMAND |
يتم استدعاء أمر يبدأ بشرطة مائلة. |
RICH_LINK |
تعليق توضيحي لرابط غني |
CUSTOM_EMOJI |
تعليق توضيحي مخصّص للإيموجي |
UserMentionMetadata
البيانات الوصفية للتعليقات التوضيحية للإشارات إلى المستخدمين (@).
| تمثيل JSON |
|---|
{ "user": { object ( |
| الحقول | |
|---|---|
user |
المستخدم الذي تمت الإشارة إليه |
type |
نوع الإشارة إلى المستخدم |
النوع
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يجب عدم استخدامها. |
ADD |
إضافة مستخدم إلى المساحة |
MENTION |
الإشارة إلى مستخدم في مساحة |
SlashCommandMetadata
البيانات الوصفية للتعليقات التوضيحية للأوامر التي تبدأ بشرطة مائلة (/).
| تمثيل JSON |
|---|
{ "bot": { object ( |
| الحقول | |
|---|---|
bot |
تطبيق Chat الذي تم استدعاء أمره |
type |
نوع الأمر الذي يبدأ بشرطة مائلة |
commandName |
اسم الأمر الذي يبدأ بشرطة مائلة والذي تم استدعاؤه |
commandId |
رقم تعريف الأمر الذي يبدأ بشرطة مائلة. |
triggersDialog |
يشير إلى ما إذا كان الأمر الذي يبدأ بشرطة مائلة مخصّصًا لمربّع حوار. |
النوع
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يجب عدم استخدامها. |
ADD |
إضافة تطبيق Chat إلى المساحة |
INVOKE |
استدعاء أمر يبدأ بشرطة مائلة في مساحة |
RichLinkMetadata
رابط منسَّق يؤدي إلى مرجع يمكن ربط الروابط المنسَّقة بنص الرسالة العادي أو تمثيل شرائح ترتبط بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع ضبط startIndex وlength على 0.
| تمثيل JSON |
|---|
{ "uri": string, "richLinkType": enum ( |
| الحقول | |
|---|---|
uri |
معرّف الموارد المنتظم (URI) لهذا الرابط |
richLinkType |
نوع الرابط المنسَّق |
| بيانات المرجع المرتبط في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
driveLinkData |
بيانات رابط Drive |
chatSpaceLinkData |
بيانات رابط مساحة Chat |
meetSpaceLinkData |
بيانات رابط مساحة Meet |
calendarEventLinkData |
بيانات رابط حدث في "تقويم 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". |
DriveLinkData
بيانات روابط Google Drive
| تمثيل JSON |
|---|
{
"driveDataRef": {
object ( |
| الحقول | |
|---|---|
driveDataRef |
DriveDataRef يشير إلى ملف في Google Drive |
mimeType |
نوع mime لمرجع Google Drive المرتبط |
ChatSpaceLinkData
بيانات روابط مساحات Chat
| تمثيل JSON |
|---|
{ "space": string, "thread": string, "message": string } |
| الحقول | |
|---|---|
space |
مساحة Chat المرتبطة. التنسيق: |
thread |
سلسلة محادثات مورد مساحة Chat المرتبط التنسيق: |
message |
رسالة مورد مساحة Chat المرتبطة التنسيق: |
MeetSpaceLinkData
بيانات روابط مساحات Meet
| تمثيل JSON |
|---|
{ "meetingCode": string, "type": enum ( |
| الحقول | |
|---|---|
meetingCode |
رمز الاجتماع لمساحة Meet المرتبطة |
type |
يشير إلى نوع مساحة Meet. |
huddleStatus |
اختيارية: للعرض فقط. إذا كان اجتماع Meet عبارة عن اجتماع سريع، يشير هذا الحقل إلى حالة الاجتماع السريع. وإلا، لن يتم ضبط هذا الحقل. |
النوع
نوع مساحة Meet
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
القيمة التلقائية للتعداد يجب عدم استخدامها. |
MEETING |
مساحة Meet هي اجتماع. |
HUDDLE |
مساحة Meet هي اجتماع سريع. |
HuddleStatus
حالة الاجتماع السريع
| عمليات التعداد | |
|---|---|
HUDDLE_STATUS_UNSPECIFIED |
القيمة التلقائية للتعداد يجب عدم استخدامها. |
STARTED |
بدأ الاجتماع السريع. |
ENDED |
انتهى الاجتماع السريع. وفي هذه الحالة، لن يعود معرّف الموارد المنتظم (URI) والمعرّفات الخاصة بمساحة Meet صالحة. |
MISSED |
فاتتك مكالمة Huddle. وفي هذه الحالة، لن يعود معرّف الموارد المنتظم (URI) والمعرّفات الخاصة بمساحة Meet صالحة. |
CalendarEventLinkData
بيانات روابط الأحداث في "تقويم Google"
| تمثيل JSON |
|---|
{ "calendarId": string, "eventId": string } |
| الحقول | |
|---|---|
calendarId |
معرّف التقويم المرتبط |
eventId |
معرّف الحدث المرتبط في "تقويم Google" |
CustomEmojiMetadata
البيانات الوصفية للتعليقات التوضيحية الخاصة بالإيموجي المخصّص
| تمثيل JSON |
|---|
{
"customEmoji": {
object ( |
| الحقول | |
|---|---|
customEmoji |
الإيموجي المخصّص |
Thread
سلسلة محادثات في مساحة Google Chat للاطّلاع على مثال على الاستخدام، يُرجى مراجعة بدء سلسلة رسائل أو الردّ عليها.
إذا حدّدت سلسلة محادثات عند إنشاء رسالة، يمكنك ضبط الحقل messageReplyOption لتحديد ما يحدث في حال عدم العثور على سلسلة محادثات مطابقة.
| تمثيل JSON |
|---|
{ "name": string, "threadKey": string } |
| الحقول | |
|---|---|
name |
المعرّف. اسم مورد سلسلة المحادثات مثلاً: |
threadKey |
اختيارية: إدخال لإنشاء سلسلة محادثات أو تعديلها وفي الحالات الأخرى، يكون الحقل مخصّصًا للعرض فقط. رقم تعريف سلسلة المحادثات يمكنك إدخال ما يصل إلى 4,000 حرف. يكون هذا المعرّف فريدًا لتطبيق Chat الذي يضبطه. على سبيل المثال، إذا أنشأت عدة تطبيقات في Chat رسالة باستخدام مفتاح سلسلة المحادثات نفسه، يتم نشر الرسائل في سلاسل محادثات مختلفة. للردّ في سلسلة محادثات أنشأها مستخدم أو تطبيق Chat آخر، حدِّد حقل سلسلة المحادثات |
ActionResponse
المَعلمات التي يمكن لتطبيق Chat استخدامها لضبط كيفية نشر ردّه
| تمثيل JSON |
|---|
{ "type": enum ( |
| الحقول | |
|---|---|
type |
الإدخال فقط نوع ردّ تطبيق Chat |
url |
الإدخال فقط عنوان URL للمستخدمين للمصادقة أو الضبط (لأنواع الردود على |
dialogAction |
الإدخال فقط ردّ على حدث تفاعل مرتبط بمربّع حوار يجب أن يكون برفقة |
updatedWidget |
الإدخال فقط ردّ التطبيق المصغّر المعدَّل |
ResponseType
نوع ردّ تطبيق Chat
| عمليات التعداد | |
|---|---|
TYPE_UNSPECIFIED |
النوع التلقائي الذي يتم التعامل معه على أنّه NEW_MESSAGE |
NEW_MESSAGE |
انشرها كرسالة جديدة في الموضوع. |
UPDATE_MESSAGE |
عدِّل رسالة تطبيق Chat. لا يُسمح بذلك إلا في حدث CARD_CLICKED حيث يكون نوع مُرسِل الرسالة هو BOT. |
UPDATE_USER_MESSAGE_CARDS |
تعديل البطاقات في رسالة المستخدم يُسمح بذلك فقط كردّ على حدث MESSAGE يتضمّن عنوان URL مطابقًا، أو حدث CARD_CLICKED يكون فيه نوع مُرسِل الرسالة هو HUMAN. ويتم تجاهل النص. |
REQUEST_CONFIG |
اطلب من المستخدم بشكل خاص إجراء مصادقة أو ضبط إضافي. |
DIALOG |
يعرض مربّع حوار. |
UPDATE_WIDGET |
طلب بحث لخيارات الإكمال التلقائي للنص في التطبيق المصغّر |
DialogAction
يحتوي على مربّع حوار ورمز حالة الطلب.
| تمثيل JSON |
|---|
{ "actionStatus": { object ( |
| الحقول | |
|---|---|
actionStatus |
الإدخال فقط حالة طلب استدعاء مربّع حوار أو إرساله يعرض حالة ورسالة للمستخدمين، إذا لزم الأمر. على سبيل المثال، في حال حدوث خطأ أو نجاح. |
| الإجراء المطلوب تنفيذه في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
dialog |
الإدخال فقط مربّع حوار للطلب |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
مربّع حوار
Wrapper around the card body of the dialog.
| تمثيل JSON |
|---|
{
"body": {
object ( |
| الحقول | |
|---|---|
body |
الإدخال فقط نص مربّع الحوار الذي يتم عرضه في نافذة مشروطة لا تتيح تطبيقات Google Chat استخدام عناصر البطاقات التالية: |
ActionStatus
تمثّل حالة طلب استدعاء مربّع حوار أو إرساله.
| تمثيل JSON |
|---|
{
"statusCode": enum ( |
| الحقول | |
|---|---|
statusCode |
رمز الحالة |
userFacingMessage |
الرسالة التي يتم إرسالها إلى المستخدمين بشأن حالة طلبهم في حال عدم ضبطها، يتم إرسال رسالة عامة استنادًا إلى |
الرمز
رموز الخطأ الأساسية لواجهات برمجة التطبيقات gRPC
في بعض الأحيان، قد تنطبق رموز خطأ متعددة. يجب أن تعرض الخدمات رمز الخطأ الأكثر تحديدًا الذي ينطبق. على سبيل المثال، يُفضَّل استخدام الرمز OUT_OF_RANGE بدلاً من FAILED_PRECONDITION إذا كان كلا الرمزَين ينطبقان. وبالمثل، يفضّل استخدام NOT_FOUND أو ALREADY_EXISTS بدلاً من FAILED_PRECONDITION.
| عمليات التعداد | |
|---|---|
OK |
لا يشير إلى خطأ، بل يتم عرضه عند نجاح العملية. تخطيط HTTP: 200 OK |
CANCELLED |
تم إلغاء العملية، عادةً من قِبل المتصل. HTTP Mapping: 499 Client Closed Request |
UNKNOWN |
حدث خطأ غير معروف. على سبيل المثال، قد يظهر هذا الخطأ عندما تنتمي قيمة تخطيط HTTP: 500 خطأ في الخادم الداخلي |
INVALID_ARGUMENT |
حدّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ هذا يختلف عن تخطيط HTTP: 400 طلب غير صالح |
DEADLINE_EXCEEDED |
انتهى الموعد النهائي قبل اكتمال العملية. بالنسبة إلى العمليات التي تغيّر حالة النظام، قد يظهر هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد يكون الردّ الناجح من الخادم قد تأخّر لفترة كافية لانتهاء الموعد النهائي. الربط ببروتوكول HTTP: 504 Gateway Timeout |
NOT_FOUND |
لم يتم العثور على بعض الكيانات المطلوبة (مثل الملف أو الدليل). ملاحظة لمطوّري الخوادم: إذا تم رفض طلب لفئة كاملة من المستخدمين، مثل طرح ميزة تدريجيًا أو قائمة مسموح بها غير موثّقة، يمكن استخدام الربط ببروتوكول HTTP: 404 لم يتم العثور على الصفحة |
ALREADY_EXISTS |
الكيان الذي حاول العميل إنشاءه (مثل ملف أو دليل) موجود حاليًا. تخطيط HTTP: 409 Conflict |
PERMISSION_DENIED |
لا يملك المتصل الإذن لتنفيذ العملية المحدّدة. يجب عدم استخدام تخطيط HTTP: 403 محظور |
UNAUTHENTICATED |
لا يتضمّن الطلب بيانات اعتماد مصادقة صالحة للعملية. التوافق مع بروتوكول HTTP: 401 غير مصرّح به |
RESOURCE_EXHAUSTED |
تم استنفاد بعض الموارد، ربما حصة لكل مستخدم، أو ربما نفدت مساحة نظام الملفات بالكامل. HTTP Mapping: 429 Too Many Requests |
FAILED_PRECONDITION |
تم رفض العملية لأنّ النظام ليس في الحالة المطلوبة لتنفيذها. على سبيل المثال، إذا كان الدليل المطلوب حذفه غير فارغ، أو إذا تم تطبيق عملية rmdir على ملف ليس دليلاً، وما إلى ذلك. يمكن لمطوّري الخدمات استخدام الإرشادات التالية للاختيار بين تخطيط HTTP: 400 طلب غير صالح |
ABORTED |
تم إلغاء العملية، ويرجع ذلك عادةً إلى مشكلة في التزامن، مثل تعذُّر التحقّق من التسلسل أو إلغاء المعاملة. اطّلِع على الإرشادات أعلاه للاختيار بين تخطيط HTTP: 409 Conflict |
OUT_OF_RANGE |
تمت محاولة تنفيذ العملية بعد النطاق الصالح. على سبيل المثال، البحث عن نهاية الملف أو قراءتها. على عكس هناك قدر كبير من التداخل بين تخطيط HTTP: 400 طلب غير صالح |
UNIMPLEMENTED |
لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعَّلة في هذه الخدمة. تخطيط HTTP: 501 Not Implemented |
INTERNAL |
أخطاء داخلية وهذا يعني أنّ بعض الثوابت التي يتوقعها النظام الأساسي قد تم كسرها. رمز الخطأ هذا محجوز للأخطاء الخطيرة. تخطيط HTTP: 500 خطأ في الخادم الداخلي |
UNAVAILABLE |
هذه الخدمة غير متاحة حاليًا. على الأرجح أنّ هذه حالة عابرة يمكن تصحيحها من خلال إعادة المحاولة مع استخدام فترة انتظار. يُرجى العِلم أنّه ليس من الآمن دائمًا إعادة محاولة تنفيذ العمليات غير المتكررة. اطّلِع على الإرشادات أعلاه للاختيار بين الربط ببروتوكول HTTP: 503 الخدمة غير متاحة |
DATA_LOSS |
فقدان البيانات أو تلفها بشكل لا يمكن استرداده تخطيط HTTP: 500 خطأ في الخادم الداخلي |
UpdatedWidget
بالنسبة إلى تطبيقات selectionInput المصغّرة، يتم عرض اقتراحات الإكمال التلقائي لقائمة الاختيار المتعدّد.
| تمثيل JSON |
|---|
{
"widget": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"suggestions": {
object ( |
| الحقول | |
|---|---|
widget |
رقم تعريف التطبيق المصغّر الذي تم تعديله يجب أن يتطابق رقم التعريف مع رقم تعريف التطبيق المصغّر الذي أرسل طلب التعديل. |
| تم تعديل التطبيق المصغّر استجابةً لإجراء من المستخدم. في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
suggestions |
قائمة نتائج الإكمال التلقائي للتطبيقات المصغّرة |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
SelectionItems
قائمة بنتائج الإكمال التلقائي للتطبيق المصغّر
| تمثيل JSON |
|---|
{
"items": [
{
object ( |
| الحقول | |
|---|---|
items[] |
مصفوفة من عناصر SelectionItem |
SlashCommand
البيانات الوصفية حول أمر يبدأ بشرطة مائلة في Google Chat
| تمثيل JSON |
|---|
{ "commandId": string } |
| الحقول | |
|---|---|
commandId |
رقم تعريف الأمر الذي يبدأ بشرطة مائلة |
MatchedUrl
عنوان URL مطابق في رسالة محادثة يمكن لتطبيقات Chat معاينة عناوين URL المطابقة. لمزيد من المعلومات، يُرجى الاطّلاع على معاينة الروابط.
| تمثيل JSON |
|---|
{ "url": string } |
| الحقول | |
|---|---|
url |
للعرض فقط. عنوان URL الذي تمت مطابقته |
EmojiReactionSummary
عدد الأشخاص الذين تفاعلوا مع رسالة باستخدام إيموجي معيّن
| تمثيل JSON |
|---|
{
"emoji": {
object ( |
| الحقول | |
|---|---|
emoji |
للعرض فقط. الإيموجي المرتبط بالتفاعلات |
reactionCount |
للعرض فقط. إجمالي عدد التفاعلات باستخدام الإيموجي المرتبط |
DeletionMetadata
معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط deleteTime.
| تمثيل JSON |
|---|
{
"deletionType": enum ( |
| الحقول | |
|---|---|
deletionType |
يشير إلى المستخدم الذي حذف الرسالة. |
DeletionType
المستخدم الذي حذف الرسالة وكيفية حذفها قد تتم إضافة المزيد من القيم في المستقبل. يُرجى الاطّلاع على مقالة تعديل رسالة أو حذفها في Google Chat لمعرفة تفاصيل حول الحالات التي يمكن فيها حذف الرسائل.
| عمليات التعداد | |
|---|---|
DELETION_TYPE_UNSPECIFIED |
هذه القيمة غير مستخدَمة. |
CREATOR |
حذف المستخدم رسالته. |
SPACE_OWNER |
حذف مالك أو مدير الرسالة. |
ADMIN |
حذف مشرف Google Workspace الرسالة. يمكن للمشرفين حذف أي رسالة في المساحة، بما في ذلك الرسائل التي يرسلها أي عضو في المساحة أو تطبيق في Chat. |
APP_MESSAGE_EXPIRY |
حذف تطبيق Chat رسالته الخاصة عند انتهاء صلاحيتها. |
CREATOR_VIA_APP |
حذف تطبيق Chat الرسالة نيابةً عن منشئها (باستخدام مصادقة المستخدم). |
SPACE_OWNER_VIA_APP |
حذف تطبيق Chat الرسالة نيابةً عن مدير المساحة (باستخدام مصادقة المستخدم). |
SPACE_MEMBER |
حذف أحد أعضاء المساحة الرسالة. يمكن للمستخدمين حذف الرسائل التي ترسلها التطبيقات. |
QuotedMessageMetadata
معلومات حول رسالة تقتبسها رسالة أخرى
عند تعديل رسالة، لا يمكنك إضافة الحقل quotedMessageMetadata أو استبداله، ولكن يمكنك إزالته.
للاطّلاع على مثال على الاستخدام، يُرجى مراجعة اقتباس رسالة أخرى.
| تمثيل JSON |
|---|
{ "name": string, "lastUpdateTime": string, "quoteType": enum ( |
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم مورد الرسالة المقتبَسة التنسيق: |
lastUpdateTime |
الحقل مطلوب. الطابع الزمني لوقت إنشاء الرسالة المقتبسة أو وقت آخر تعديل لها إذا تم تعديل الرسالة، استخدِم هذا الحقل: إذا لم يتطابق |
quoteType |
اختيارية: تحدّد هذه السمة نوع الاقتباس. في حال عدم ضبطه، يتم ضبطه تلقائيًا على REPLY في مسار قراءة/كتابة الرسالة للتوافق مع الأنظمة القديمة. |
quotedMessageSnapshot |
للعرض فقط. لقطة من محتوى الرسالة المقتبَسة |
forwardedMetadata |
للعرض فقط. البيانات الوصفية حول المساحة المصدر للرسالة المقتبسة تتم تعبئة هذا الحقل لنوع عرض الأسعار FORWARD فقط. |
QuoteType
نوع الاقتباس للرسالة المقتبسة
| عمليات التعداد | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
محجوزة هذه القيمة غير مستخدَمة. |
REPLY |
عندما يكون
|
FORWARD |
عندما يكون
|
QuotedMessageSnapshot
يوفّر لقطة لمحتوى الرسالة المقتبَسة في وقت الاقتباس أو إعادة التوجيه
| تمثيل JSON |
|---|
{ "sender": string, "text": string, "formattedText": string, "annotations": [ { object ( |
| الحقول | |
|---|---|
sender |
للعرض فقط. اسم مؤلف الرسالة المقتبسة يتم ملؤها لكل من نوعَي الاقتباس "رد" و"إعادة توجيه". |
text |
للعرض فقط. لقطة من المحتوى النصي للرسالة المقتبسة |
formattedText |
للعرض فقط. تحتوي على الرسالة المقتبَسة |
annotations[] |
للعرض فقط. التعليقات التوضيحية التي تم تحليلها من نص الرسالة المقتبسة. تتم تعبئة هذا الحقل لنوع عرض الأسعار FORWARD فقط. |
attachments[] |
للعرض فقط. المرفقات التي كانت جزءًا من الرسالة المقتبَسة هذه نُسخ من البيانات الوصفية لمرفقات الرسالة المقتبسة. تتم تعبئة هذا الحقل لنوع عرض الأسعار FORWARD فقط. |
ForwardedMetadata
البيانات الوصفية حول المساحة المصدر التي تمت إعادة توجيه رسالة منها
| تمثيل JSON |
|---|
{ "space": string, "spaceDisplayName": string } |
| الحقول | |
|---|---|
space |
للعرض فقط. اسم المورد للمساحة المصدر التنسيق: spaces/{space} |
spaceDisplayName |
للعرض فقط. الاسم المعروض لمساحة المصدر أو الرسالة المباشرة في وقت إعادة التوجيه بالنسبة إلى |
AttachedGif
صورة GIF يتم تحديدها من خلال عنوان URL.
| تمثيل JSON |
|---|
{ "uri": string } |
| الحقول | |
|---|---|
uri |
للعرض فقط. عنوان URL الذي يستضيف صورة GIF |
AccessoryWidget
عنصر واجهة مستخدم تفاعلي واحد أو أكثر يظهر في أسفل الرسالة لمعرفة التفاصيل، يُرجى الاطّلاع على إضافة تطبيقات مصغّرة تفاعلية في أسفل الرسالة.
| تمثيل JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"buttonList": {
object ( |
| الحقول | |
|---|---|
| نوع الإجراء في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
buttonList |
قائمة بالأزرار |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
العناصر
| تمثيل JSON |
|---|
{ "citedSources": [ { object ( |
| الحقول | |
|---|---|
citedSources[] |
قائمة بالمصادر التي سيتم عرضها أسفل الرسالة كروابط تذييل لا تتم الإشارة إليها بشكل مضمّن. بالنسبة إلى المراجع المضمّنة، استخدِم |
citations[] |
قائمة بالاقتباسات المضمّنة المُشار إليها في نص الرسالة (عبر علامات |
CitedSource
| تمثيل JSON |
|---|
{ "title": string, "uri": string, "snippet": { object ( |
| الحقول | |
|---|---|
title |
الحقل مطلوب. عنوان |
uri |
الحقل مطلوب. معرّف الموارد المنتظم (URI) الذي يشير إلى المورد المُشار إليه في |
snippet |
اختيارية: مقتطف يحتوي على معلومات من المصدر مباشرةً |
footer |
اختيارية: معلومات إضافية تظهر بجانب المقتطف على شكل تذييل |
المقتطف
| تمثيل JSON |
|---|
{
"text": string,
"imagePreview": {
object ( |
| الحقول | |
|---|---|
text |
اختيارية: مقتطف نصي قصير من النص الأساسي مباشرةً قد يتم عرضه في Chat لا يتيح تنسيق Markdown. |
imagePreview |
اختيارية: معاينة صورة المقتطف المقدَّم كإدخال عند إنشاء الاقتباس |
ElementsImage
| تمثيل JSON |
|---|
{ "imageUri": string } |
| الحقول | |
|---|---|
| الحقل مطلوب. أحد تمثيلات الصور المتوافقة في ما يلي قائمة بالحقول التي يستبعد بعضها بعضًا. سيتم ضبط حقل واحد على الأكثر في الرد: | |
imageUri |
الحقل مطلوب. معرّف موارد منتظم (URI) متاح للجميع لصورة معيّنة |
| نهاية الحقول التي يستبعد كلّ منها الآخر | |
معلومات الكتاب
<chat-citation data-id="{id}">{text}</chat-citation>. لا تتوفّر الاقتباسات إلا عندما يتم ضبط markupSyntax للرسالة على MARKDOWN.يتم تجاهل الاقتباسات غير المُشار إليها في Elements.citations (تلك التي لا تحتوي على علامة <chat-citation> مطابقة في نص الرسالة) ولا تؤدي إلى رفض الرسالة.
| تمثيل JSON |
|---|
{
"id": string,
"citedSources": [
{
object ( |
| الحقول | |
|---|---|
id |
الحقل مطلوب. معرّف محدّد من التطبيق يجب أن يحتوي على أحرف وأرقام ASCII فقط، وأقل من 63 حرفًا. |
citedSources[] |
اختيارية: قائمة بالمصادر ذات الصلة بالاقتباس يتم عرض المصادر في بطاقة المعلومات الخاصة بالاقتباس. |
MarkupSyntax
تحدّد بنية الترميز المستخدَمة لتنسيق نص رسالة Chat. تنطبق هذه السمة على الحقل text للمورد Message.
| عمليات التعداد | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
تمثّل القيمة غير المحدّدة. |
MARKUP_SYNTAX_CHAT |
يستخدم هذا الحقل بنية الترميز في Google Chat. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts. |
MARKUP_SYNTAX_MARKDOWN |
يستخدم بنية Markdown. تستند هذه البنية إلى مواصفات CommonMark، مع إضافات أخرى. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts. |
الطُرق |
|
|---|---|
|
ينشئ رسالة في مساحة Google Chat. |
|
لحذف رسالة |
|
تعرض هذه الطريقة تفاصيل عن رسالة معيّنة. |
|
تعرض هذه الطريقة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء والمساحات المحظورة. |
|
تعديل رسالة |
|
يستبدل البطاقات المضمّنة في رسالة. |
|
يبحث عن الرسائل في Google Chat التي يمكن للمستخدم المتصل الوصول إليها. |
|
تعديل رسالة |