REST Resource: spaces.messages

المورد: رسالة

رسالة في مساحة Google Chat

تمثيل JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
الحقول
name

string

المعرّف. اسم مورد الرسالة

التنسيق: spaces/{space}/messages/{message}

حيث يمثّل {space} معرّف المساحة التي تم نشر الرسالة فيها، ويمثّل {message} معرّفًا للرسالة يحدّده النظام. على سبيل المثال، spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

إذا ضبطت معرّفًا مخصّصًا عند إنشاء رسالة، يمكنك استخدام هذا المعرّف لتحديد الرسالة في طلب من خلال استبدال {message} بالقيمة من الحقل clientAssignedMessageId. على سبيل المثال، spaces/AAAAAAAAAAA/messages/client-custom-name. لمعرفة التفاصيل، يُرجى الاطّلاع على تسمية رسالة.
sender

object (User)

النتائج فقط. المستخدم الذي أنشأ الرسالة إذا كان تطبيق Chat يُجري المصادقة كمستخدم، لن يعرض الناتج سوى الحقلَين name وtype في user لكل من المستخدمين الداخليين والخارجيين، ما لم يكونوا أعضاء في المساحة أو لديهم صلة سابقة، مثل محادثة عبر رسالة مباشرة، مع المستخدم المتصل.
createTime

string (Timestamp format)

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

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

string (Timestamp format)

النتائج فقط. الوقت الذي عدّل فيه المستخدم الرسالة آخر مرة إذا لم يتم تعديل الرسالة مطلقًا، يكون هذا الحقل فارغًا.
deleteTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه حذف الرسالة في Google Chat إذا لم يتم حذف الرسالة مطلقًا، سيكون هذا الحقل فارغًا.
text

string

اختياريّ. نص الرسالة العادي يؤدي الرابط الأول إلى صورة أو فيديو أو صفحة ويب إلى إنشاء شريحة معاينة. يمكنك أيضًا الإشارة باستخدام @ إلى مستخدم Google Chat أو إلى جميع المستخدمين في المساحة.

لمعرفة كيفية إنشاء رسائل نصية، يُرجى الاطّلاع على مقالة إرسال رسالة.
formattedText

string

النتائج فقط. تحتوي على الرسالة text مع ترميزات مضافة لتوضيح التنسيق. قد لا يتضمّن هذا الحقل كل التنسيقات الظاهرة في واجهة المستخدم، ولكنه يتضمّن ما يلي:

  • بنية الترميز للنص الغامق والمائل والمشطوب والخط الأحادي المسافة والفقرة بالخط الأحادي المسافة والقائمة النقطية والاقتباس.

  • الإشارات إلى المستخدمين باستخدام التنسيق <users/{user}>

  • روابط تشعّبية مخصّصة تستخدم التنسيق <{url}|{rendered_text}> حيث تكون السلسلة الأولى هي عنوان URL والثانية هي النص المعروض، على سبيل المثال، <http://example.com|custom text>.

  • رمز إيموجي مخصّص باستخدام التنسيق :{emojiName}:، على سبيل المثال، :smile: لا ينطبق ذلك على رموز الإيموجي في يونيكود، مثل U+1F600 لوجه مبتسم.

  • استخدِم علامات النجمة (*) لإنشاء قائمة نقطية، مثلاً: * item.

لمزيد من المعلومات، يُرجى الاطّلاع على المقالة عرض تنسيق النص المُرسَل في رسالة.
cards[]
(deprecated)

object (Card)

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

بطاقات غنية ومنسّقة وتفاعلية يمكنك استخدامها لعرض عناصر في واجهة المستخدم، مثل النصوص المنسّقة والأزرار والصور القابلة للنقر. يتم عادةً عرض البطاقات أسفل نص الرسالة العادي. يمكن أن يبلغ الحد الأقصى لحجم cards وcardsV2 32 كيلوبايت.
cardsV2[]

object (CardWithId)

اختياريّ. مصفوفة من البطاقات

يمكن لتطبيقات Chat إنشاء بطاقات باستخدام مصادقة التطبيق. كجزء من برنامج معاينة المطوّر، إذا كان تطبيق Chat يصادق كمستخدم، يمكنه إنشاء رسائل بطاقات. إذا لم يكن تطبيق Chat جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتضمّن مصادقة المستخدم.

لمعرفة كيفية إنشاء رسالة تحتوي على بطاقات، يُرجى الاطّلاع على إرسال رسالة.

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

فتح Card Builder
annotations[]

object (Annotation)

النتائج فقط. يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، باستخدام startIndex وlength بقيمة 0.
thread

object (Thread)

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

object (Space)

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

string

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

object (ActionResponse)

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

string

النتائج فقط. النص العادي للرسالة مع إزالة جميع الإشارات إلى تطبيق Chat
slashCommand

object (SlashCommand)

النتائج فقط. معلومات الأمر الذي يبدأ بشرطة مائلة، إن توفّرت
attachment[]

object (Attachment)

اختياريّ. مرفق حمّله المستخدم
matchedUrl

object (MatchedUrl)

النتائج فقط. عنوان URL في حقل رسالة محادثة text يتطابق مع نمط معاينة الرابط. لمزيد من المعلومات، يُرجى الاطّلاع على معاينة الروابط.
threadReply

boolean

النتائج فقط. عندما تكون قيمة الحقل true، تكون الرسالة ردًا في سلسلة محادثات. عندما تكون القيمة false، تظهر الرسالة في المحادثة ذات المستوى الأعلى في المساحة كأول رسالة في سلسلة محادثات أو رسالة بدون ردود في سلسلة محادثات.

إذا كانت المساحة لا تتيح الردّ في سلاسل محادثات، يكون هذا الحقل دائمًا false.
silent

boolean

النتائج فقط. ما إذا كانت هذه رسالة صامتة الرسائل الصامتة هي رسائل يحجب فيها Chat الإشعارات الفورية للمستلِمين.
clientAssignedMessageId

string

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

object (EmojiReactionSummary)

النتائج فقط. قائمة ملخّصات التفاعلات باستخدام الإيموجي في الرسالة
privateMessageViewer

object (User)

اختياريّ. غير قابل للتغيير يتم إدخال البيانات لإنشاء رسالة، وإلا سيتم إخراجها فقط. المستخدم الذي يمكنه عرض الرسالة عند ضبط هذا الحقل، تكون الرسالة خاصة ولا تظهر إلا للمستخدم المحدّد وتطبيق Chat. لتضمين هذا الحقل في طلبك، عليك طلب Chat API باستخدام مصادقة التطبيق وحذف ما يلي:

لمعرفة التفاصيل، يُرجى الاطّلاع على إرسال رسالة خاصة.
deletionMetadata

object (DeletionMetadata)

النتائج فقط. معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط deleteTime.
quotedMessageMetadata

object (QuotedMessageMetadata)

اختياريّ. معلومات حول رسالة تقتبسها رسالة أخرى

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

عند تعديل رسالة، لا يمكنك إضافة الحقل quotedMessageMetadata أو استبداله، ولكن يمكنك إزالته.

للاطّلاع على مثال على الاستخدام، يُرجى مراجعة اقتباس رسالة أخرى.
attachedGifs[]

object (AttachedGif)

النتائج فقط. صور GIF المرفقة بالرسالة
accessoryWidgets[]

object (AccessoryWidget)

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

يتطلب إنشاء رسالة باستخدام تطبيقات مصغّرة ملحقة مصادقة التطبيق.
elements

object (Elements)

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

markupSyntax

enum (MarkupSyntax)

اختياريّ. يحدّد هذا الحقل كيفية تفسير الخادم لمحتوى حقل الرسالة text عند إنشاء رسالة أو تعديل حقل text في رسالة.

عند طلب UpdateMessage، اضبط markupSyntax وtext على المورد Message وأدرِج text (وليس markupSyntax) في updateMask.

تعليق توضيحي

يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بموارد 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 (AnnotationType),
  "length": integer,
  "startIndex": integer,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
الحقول
type

enum (AnnotationType)

نوع هذا التعليق التوضيحي
length

integer

طول السلسلة الفرعية في نص الرسالة العادي الذي يتوافق معه هذا التعليق التوضيحي في حال عدم توفّرها، تشير إلى أنّ المدة هي 0.
startIndex

integer

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

object (UserMentionMetadata)

البيانات الوصفية للإشارة إلى المستخدم
slashCommand

object (SlashCommandMetadata)

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

object (CustomEmojiMetadata)

البيانات الوصفية لإيموجي مخصّص
نهاية الحقول التي يستبعد كلّ منها الآخر

AnnotationType

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

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

UserMentionMetadata

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

تمثيل JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
الحقول
user

object (User)

المستخدم الذي تمت الإشارة إليه
type

enum (Type)

نوع الإشارة إلى المستخدم

النوع

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

SlashCommandMetadata

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

تمثيل JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
الحقول
bot

object (User)

تطبيق Chat الذي تم استدعاء أمره
type

enum (Type)

نوع الأمر الذي يبدأ بشرطة مائلة
commandName

string

اسم الأمر الذي يبدأ بشرطة مائلة والذي تم استدعاؤه
commandId

string (int64 format)

رقم تعريف الأمر الذي يبدأ بشرطة مائلة.
triggersDialog

boolean

يشير إلى ما إذا كان الأمر الذي يبدأ بشرطة مائلة مخصّصًا لمربّع حوار.

النوع

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

RichLinkMetadata

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

تمثيل JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
الحقول
uri

string

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

RichLinkType

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

عمليات التعداد
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)
  },
  "mimeType": string
}
الحقول
driveDataRef

object (DriveDataRef)

‫DriveDataRef يشير إلى ملف في Google Drive
mimeType

string

نوع mime لمرجع Google Drive المرتبط

ChatSpaceLinkData

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

تمثيل JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
الحقول
space

string

مساحة مورد مساحة Chat المرتبطة

التنسيق: spaces/{space}
thread

string

سلسلة محادثات مورد مساحة Chat المرتبط

التنسيق: spaces/{space}/threads/{thread}
message

string

رسالة مورد مساحة Chat المرتبطة

التنسيق: spaces/{space}/messages/{message}

MeetSpaceLinkData

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

تمثيل JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
الحقول
meetingCode

string

رمز الاجتماع لمساحة Meet المرتبطة
type

enum (Type)

يشير إلى نوع مساحة Meet.
huddleStatus

enum (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

string

معرّف التقويم المرتبط
eventId

string

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

CustomEmojiMetadata

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

تمثيل JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
الحقول
customEmoji

object (CustomEmoji)

الإيموجي المخصّص

Thread

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

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

تمثيل JSON 
{
  "name": string,
  "threadKey": string
}
الحقول
name

string

المعرّف. اسم مورد سلسلة المحادثات

مثلاً: spaces/{space}/threads/{thread}
threadKey

string

اختياريّ. إدخال لإنشاء سلسلة محادثات أو تعديلها وإلا، ستكون النتائج فقط. رقم تعريف سلسلة المحادثات يمكن إدخال ما يصل إلى 4,000 حرف.

يكون هذا المعرّف فريدًا لتطبيق Chat الذي يضبطه. على سبيل المثال، إذا أنشأت عدة تطبيقات في Chat رسالة باستخدام مفتاح سلسلة المحادثات نفسه، يتم نشر الرسائل في سلاسل محادثات مختلفة. للردّ في سلسلة محادثات أنشأها مستخدم أو تطبيق Chat آخر، حدِّد حقل سلسلة المحادثات name بدلاً من ذلك.

ActionResponse

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

تمثيل JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  },
  "updatedWidget": {
    object (UpdatedWidget)
  }
}
الحقول
type

enum (ResponseType)

للمدخلات فقط. نوع ردّ تطبيق Chat
url

string

للمدخلات فقط. عنوان URL للمستخدمين للمصادقة أو الضبط (لأنواع الردود على REQUEST_CONFIG فقط)
dialogAction

object (DialogAction)

للمدخلات فقط. ردّ على حدث تفاعل مرتبط بمربّع حوار يجب أن يكون برفقة ResponseType.Dialog.
updatedWidget

object (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": {
    object (Dialog)
  }
}
الحقول
actionStatus

object (ActionStatus)

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

object (Dialog)

للمدخلات فقط. مربّع حوار للطلب
نهاية الحقول التي يستبعد كلّ منها الآخر

مربّع حوار

تمثّل هذه السمة برنامج تضمين حول نص بطاقة مربّع الحوار.

تمثيل JSON 
{
  "body": {
    object (Card)
  }
}
الحقول
body

object (Card)

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

ActionStatus

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

تمثيل JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
الحقول
statusCode

enum (Code)

رمز الحالة
userFacingMessage

string

الرسالة التي يتم إرسالها إلى المستخدمين بشأن حالة طلبهم في حال عدم ضبطها، يتم إرسال رسالة عامة استنادًا إلى statusCode.

الرمز

رموز الخطأ الأساسية لواجهات برمجة تطبيقات gRPC

في بعض الأحيان، قد تنطبق رموز خطأ متعددة. يجب أن تعرض الخدمات رمز الخطأ الأكثر تحديدًا الذي ينطبق. على سبيل المثال، يُفضَّل استخدام OUT_OF_RANGE بدلاً من FAILED_PRECONDITION إذا كان كلا الرمزَين ينطبقان. وبالمثل، يفضّل NOT_FOUND أو ALREADY_EXISTS على FAILED_PRECONDITION.

عمليات التعداد
OK

لا يشير إلى خطأ، بل يتم عرضه عند نجاح العملية.

تخطيط HTTP‏: 200 OK
CANCELLED

تم إلغاء العملية، عادةً من قِبل المتصل.

HTTP Mapping: 499 Client Closed Request
UNKNOWN

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

تخطيط HTTP‏: 500 خطأ في الخادم الداخلي
INVALID_ARGUMENT

حدّد العميل وسيطة غير صالحة. يُرجى العِلم أنّ هذا يختلف عن FAILED_PRECONDITION. تشير السمة INVALID_ARGUMENT إلى الوسيطات التي تسبب مشاكل بغض النظر عن حالة النظام (على سبيل المثال، اسم ملف غير صالح).

تخطيط HTTP‏: 400 طلب غير صالح
DEADLINE_EXCEEDED

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

تخطيط HTTP: ‏504 انتهت مهلة البوابة
NOT_FOUND

لم يتم العثور على بعض الكيانات المطلوبة (مثل الملف أو الدليل).

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

تخطيط HTTP‏: 404 لم يتم العثور على الصفحة
ALREADY_EXISTS

الكيان الذي حاول العميل إنشاءه (مثل ملف أو دليل) موجود حاليًا.

تخطيط HTTP‏: 409 Conflict
PERMISSION_DENIED

لا يملك المتصل الإذن لتنفيذ العملية المحدّدة. يجب عدم استخدام PERMISSION_DENIED لحالات الرفض الناتجة عن استنفاد بعض الموارد (استخدِم RESOURCE_EXHAUSTED بدلاً من ذلك لهذه الأخطاء). يجب عدم استخدام PERMISSION_DENIED إذا تعذّر تحديد المتصل (استخدِم UNAUTHENTICATED بدلاً من ذلك لهذه الأخطاء). لا يعني رمز الخطأ هذا أنّ الطلب صالح أو أنّ الكيان المطلوب متوفّر أو يستوفي الشروط المسبقة الأخرى.

الربط ببروتوكول HTTP: ‏403 محظور
UNAUTHENTICATED

لا يتضمّن الطلب بيانات اعتماد مصادقة صالحة للعملية.

تخطيط HTTP‏: 401 غير مصرّح به
RESOURCE_EXHAUSTED

تم استنفاد بعض الموارد، ربما حصة لكل مستخدم، أو ربما نفدت مساحة نظام الملفات بالكامل.

تخطيط HTTP‏: 429 Too Many Requests
FAILED_PRECONDITION

تم رفض العملية لأنّ النظام ليس في الحالة المطلوبة لتنفيذها. على سبيل المثال، إذا كان الدليل المطلوب حذفه غير فارغ، أو إذا تم تطبيق عملية rmdir على عنصر ليس دليلاً، وما إلى ذلك.

يمكن لمطوّري الخدمات استخدام الإرشادات التالية للاختيار بين FAILED_PRECONDITION وABORTED وUNAVAILABLE: (أ) استخدِم UNAVAILABLE إذا كان بإمكان العميل إعادة محاولة إجراء المكالمة التي تعذّر إجراؤها فقط. (ب) استخدِم ABORTED إذا كان على العميل إعادة المحاولة على مستوى أعلى. على سبيل المثال، عندما يفشل اختبار وتعيين يحدده العميل، مما يشير إلى أنه يجب على العميل إعادة تشغيل تسلسل القراءة والتعديل والكتابة. (ج) استخدِم FAILED_PRECONDITION إذا كان على العميل عدم إعادة المحاولة إلى أن يتم إصلاح حالة النظام بشكل صريح. على سبيل المثال، إذا تعذّر تنفيذ الأمر "rmdir" لأنّ الدليل غير فارغ، يجب عرض FAILED_PRECONDITION لأنّه يجب ألا يعيد العميل المحاولة إلا بعد حذف الملفات من الدليل.

تخطيط HTTP‏: 400 طلب غير صالح
ABORTED

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

اطّلِع على الإرشادات أعلاه للاختيار بين FAILED_PRECONDITION وABORTED وUNAVAILABLE.

تخطيط HTTP‏: 409 Conflict
OUT_OF_RANGE

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

على عكس INVALID_ARGUMENT، يشير هذا الخطأ إلى مشكلة قد يتم حلّها في حال تغيّرت حالة النظام. على سبيل المثال، سينشئ نظام الملفات الذي يتألف من 32 بت INVALID_ARGUMENT إذا طُلب منه القراءة عند إزاحة ليست في النطاق [0,2^32-1]، ولكنه سينشئ OUT_OF_RANGE إذا طُلب منه القراءة من إزاحة تتجاوز حجم الملف الحالي.

هناك تداخل كبير بين FAILED_PRECONDITION وOUT_OF_RANGE. ننصح باستخدام OUT_OF_RANGE (الخطأ الأكثر تحديدًا) عندما ينطبق ذلك حتى يتمكّن المتصلون الذين يتكررون في مساحة من البحث بسهولة عن خطأ OUT_OF_RANGE لاكتشاف وقت انتهائهم.

تخطيط HTTP‏: 400 طلب غير صالح
UNIMPLEMENTED

لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعّلة في هذه الخدمة.

تخطيط HTTP‏: 501 Not Implemented
INTERNAL

أخطاء داخلية وهذا يعني أنّ بعض الثوابت التي يتوقعها النظام الأساسي قد تم كسرها. رمز الخطأ هذا محجوز للأخطاء الخطيرة.

تخطيط HTTP‏: 500 خطأ في الخادم الداخلي
UNAVAILABLE

هذه الخدمة غير متاحة حاليًا. على الأرجح أنّ هذه حالة عابرة يمكن تصحيحها من خلال إعادة المحاولة مع استخدام استراتيجية التراجع. يُرجى العِلم أنّه ليس من الآمن دائمًا إعادة محاولة تنفيذ العمليات غير المتكررة.

اطّلِع على الإرشادات أعلاه للاختيار بين FAILED_PRECONDITION وABORTED وUNAVAILABLE.

تخطيط HTTP‏: 503 الخدمة غير متاحة
DATA_LOSS

فقدان البيانات أو تلفها بشكل لا يمكن استرداده

تخطيط HTTP‏: 500 خطأ في الخادم الداخلي

UpdatedWidget

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

تمثيل JSON 
{
  "widget": string,

  "suggestions": {
    object (SelectionItems)
  }
}
الحقول
widget

string

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

object (SelectionItems)

قائمة نتائج الإكمال التلقائي للتطبيقات المصغّرة
نهاية الحقول التي يستبعد كلّ منها الآخر

SelectionItems

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

تمثيل JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
الحقول
items[]

object (SelectionItem)

مصفوفة من عناصر SelectionItem

SlashCommand

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

تمثيل JSON 
{
  "commandId": string
}
الحقول
commandId

string (int64 format)

رقم تعريف الأمر الذي يبدأ بشرطة مائلة

MatchedUrl

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

تمثيل JSON 
{
  "url": string
}
الحقول
url

string

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

EmojiReactionSummary

عدد الأشخاص الذين تفاعلوا مع رسالة باستخدام إيموجي معيّن

تمثيل JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
الحقول
emoji

object (Emoji)

النتائج فقط. الإيموجي المرتبط بالتفاعلات
reactionCount

integer

النتائج فقط. إجمالي عدد التفاعلات باستخدام الإيموجي المرتبط

DeletionMetadata

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

تمثيل JSON 
{
  "deletionType": enum (DeletionType)
}
الحقول
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 (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
الحقول
name

string

الحقل مطلوب. اسم مورد الرسالة المقتبسة

التنسيق: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

الحقل مطلوب. الطابع الزمني لوقت إنشاء الرسالة المقتبَسة أو وقت آخر تعديل لها

إذا تم تعديل الرسالة، استخدِم هذا الحقل: lastUpdateTime. إذا لم يتم تعديل الرسالة مطلقًا، استخدِم createTime.

إذا لم يتطابق lastUpdateTime مع أحدث إصدار من الرسالة المقتبسة، سيتعذّر تنفيذ الطلب.
quoteType

enum (QuoteType)

اختياريّ. تحدّد هذه السمة نوع الاقتباس. في حال عدم ضبطه، يتم ضبطه تلقائيًا على REPLY في مسار قراءة/كتابة الرسالة للتوافق مع الأنظمة القديمة.
quotedMessageSnapshot

object (QuotedMessageSnapshot)

النتائج فقط. لقطة من محتوى الرسالة المقتبَسة
forwardedMetadata

object (ForwardedMetadata)

النتائج فقط. البيانات الوصفية حول المساحة المصدر للرسالة المقتبسة تتم تعبئة هذا الحقل فقط لنوع عرض الأسعار FORWARD.

QuoteType

نوع الاقتباس للرسالة المقتبسة

عمليات التعداد
QUOTE_TYPE_UNSPECIFIED محجوزة هذه القيمة غير مستخدَمة.
REPLY

عندما يكون quoteType REPLY، يمكنك إجراء ما يلي:

  • إذا كنت تردّ في سلسلة محادثات، يمكنك اقتباس رسالة أخرى في تلك السلسلة.

  • إذا كنت تنشئ رسالة جذرية، يمكنك اقتباس رسالة جذرية أخرى في تلك المساحة.
FORWARD

عندما يكون quoteType هو FORWARD، يمكنك اقتباس:

  • رسالة من مساحة مختلفة

  • ردّ على رسالة من سلسلة محادثات مختلفة في المساحة نفسها

QuotedMessageSnapshot

يوفّر لقطة لمحتوى الرسالة المقتبَسة في وقت الاقتباس أو إعادة التوجيه

تمثيل JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
الحقول
sender

string

النتائج فقط. اسم مؤلف الرسالة المقتبَسة يتم ملؤها لكل من نوعَي الاقتباس "رد" و"إعادة توجيه".
text

string

النتائج فقط. لقطة من المحتوى النصي للرسالة المقتبَسة
formattedText

string

النتائج فقط. تحتوي على الرسالة المقتبَسة text مع إضافة ترميزات لإتاحة التنسيق المتقدّم، مثل الروابط التشعّبية ورموز الإيموجي المخصّصة والترميز وما إلى ذلك. تتم تعبئتها فقط لنوع الاقتباس FORWARD.
annotations[]

object (Annotation)

النتائج فقط. التعليقات التوضيحية التي تم تحليلها من نص الرسالة المقتبسة تتم تعبئة هذا الحقل فقط لنوع عرض الأسعار FORWARD.
attachments[]

object (Attachment)

النتائج فقط. المرفقات التي كانت جزءًا من الرسالة المقتبَسة هذه نُسخ من البيانات الوصفية لمرفقات الرسالة المقتبسة. تتم تعبئة هذا الحقل فقط لنوع عرض الأسعار FORWARD.

ForwardedMetadata

البيانات الوصفية حول مساحة المصدر التي تمت إعادة توجيه رسالة منها

تمثيل JSON 
{
  "space": string,
  "spaceDisplayName": string
}
الحقول
space

string

النتائج فقط. اسم المورد للمساحة المصدر التنسيق: spaces/{space}
spaceDisplayName

string

النتائج فقط. الاسم المعروض للمساحة المصدر أو الرسالة المباشرة في وقت إعادة التوجيه بالنسبة إلى SPACE، هذا هو اسم المساحة. بالنسبة إلى DIRECT_MESSAGE، هذا هو اسم المشارك الآخر (مثلاً، "المستخدم أ"). بالنسبة إلى GROUP_CHAT، هذا اسم يتم إنشاؤه استنادًا إلى الأسماء الأولى للأعضاء، ويقتصر على 5 أسماء بما في ذلك صانع المحتوى (مثلاً، "المستخدم أ، المستخدم ب").

AttachedGif

صورة GIF يتم تحديدها من خلال عنوان URL.

تمثيل JSON 
{
  "uri": string
}
الحقول
uri

string

النتائج فقط. عنوان URL الذي يستضيف صورة GIF

العناصر

العناصر هي مكوّنات إضافية قد تكون مرتبطة بنص الرسالة المقدَّم أثناء إنشاء الرسالة أو لا.

تمثيل JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
الحقول
citedSources[]

object (CitedSource)

قائمة بالمصادر التي سيتم عرضها أسفل الرسالة كروابط تذييل ولا تتم الإشارة إليها بشكل مضمّن. بالنسبة إلى المراجع المضمّنة، استخدِم citations.
citations[]

object (Citation)

قائمة بالاقتباسات المضمّنة المُشار إليها في نص الرسالة (عبر علامات <chat-citation>) والتي تظهر كبطاقات معلومات تفاعلية

الطُرق

create

 ينشئ رسالة في مساحة Google Chat.

delete

 لحذف رسالة

get

 تعرض هذه الطريقة تفاصيل عن رسالة معيّنة.

list

 تعرض هذه الطريقة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء والمساحات المحظورة.

patch

 تعديل رسالة

replaceCards

 يستبدل البطاقات المضمّنة في رسالة.
يبحث عن الرسائل في Google Chat التي يمكن للمستخدم الطالب الوصول إليها.

update

 تعديل رسالة