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)
    }
  ]
}
الحقول
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 يصادق على المستخدم، ستتم تعبئة الحقلين user name وtype في الناتج.
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 جزءًا من "برنامج معاينة المطوّر"، لن يتمكّن من إنشاء بطاقات تتضمّن مصادقة المستخدم.

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

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

فتح "أداة إنشاء البطاقات"
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 في spaces.messages.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)

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

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

CardWithId

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

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

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

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

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

تمثيل JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
الحقول
cardId

string

يجب توفيره إذا كانت الرسالة تحتوي على بطاقات متعددة، وهو معرّف فريد لبطاقة في رسالة.
card

object (Card)

بطاقة. الحد الأقصى للحجم هو 32 كيلوبايت.

تعليق توضيحي

النتائج فقط. يمكن ربط التعليقات التوضيحية بنص الرسالة العادي أو بالشرائح التي تتضمّن روابط تؤدي إلى مراجع 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، ويشمل القيمة) في نص الرسالة العادي الذي يتوافق مع هذا التعليق التوضيحي.
حقل الربط metadata بيانات وصفية إضافية حول التعليق التوضيحي يمكن أن يكون التعليق metadata إحدى القيم التالية فقط:
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) لهذا الرابط.
حقل الربط data بيانات المرجع المرتبط يمكن أن يكون التعليق data إحدى القيم التالية فقط:

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.

عمليات التعداد
TYPE_UNSPECIFIED القيمة التلقائية للتعداد لا تستخدِمها.
MEETING مساحة Meet هي اجتماع.
HUDDLE مساحة Meet هي اجتماع سريع.

HuddleStatus

حالة الاجتماع السريع

عمليات التعداد
HUDDLE_STATUS_UNSPECIFIED القيمة التلقائية للتعداد لا تستخدِمها.
STARTED بدأ الاجتماع السريع.
ENDED انتهى الاجتماع السريع. في هذه الحالة، لن يكون معرّف الموارد المنتظم (URI) والمعرّفات لمساحة Meet صالحَين.
MISSED لم يتم الانضمام إلى الاجتماع السريع، وفي هذه الحالة لن يكون معرّف الموارد الموحّد (URI) والمعرّفات لمساحة Meet صالحَين.

CalendarEventLinkData

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

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

string

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

string

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

CustomEmojiMetadata

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

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

object (CustomEmoji)

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

Thread

سلسلة محادثات في مساحة Chat في 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)

الإدخال فقط حالة طلب استدعاء مربّع حوار أو إرساله تعرِض هذه السمة حالة ورسالة للمستخدمين، إذا لزم الأمر. على سبيل المثال، في حال حدوث خطأ أو نجاح.
حقل الربط action الإجراء المطلوب تنفيذه يمكن أن يكون التعليق action إحدى القيم التالية فقط:
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 API

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

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

ليس خطأ، ويتم عرضه عند النجاح.

ربط HTTP: 200 OK
CANCELLED

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

ربط HTTP: 499 Client Closed Request
UNKNOWN

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

ربط HTTP: 500 Internal Server Error
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 Forbidden
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 Internal Server Error
UNAVAILABLE

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

اطّلِع على الإرشادات أعلاه لتحديد ما إذا كان يجب استخدام FAILED_PRECONDITION أو ABORTED أو UNAVAILABLE.

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

فقدان البيانات أو تلفها بشكل يتعذّر استرجاعه.

ربط HTTP: 500 Internal Server Error

UpdatedWidget

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

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

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

string

معرّف التطبيق المصغّر الذي تم تعديله، ويجب أن يتطابق مع معرّف التطبيق المصغّر الذي أطلق طلب التعديل.
حقل الربط updated_widget تم تعديل التطبيق المصغّر استجابةً لإجراء من المستخدم. يمكن أن يكون التعليق updated_widget إحدى القيم التالية فقط:
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

حقل للقراءة فقط، يمثّل اسم مؤلف الرسالة المقتبسة، ويتم ملؤه لنوعَي الاقتباس REPLY وFORWARD.
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.

AccessoryWidget

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

تمثيل JSON 
{

  "buttonList": {
    object (ButtonList)
  }
}
الحقول
حقل الربط action نوع الإجراء يمكن أن يكون التعليق action إحدى القيم التالية فقط:
buttonList

object (ButtonList)

تمثّل هذه السمة قائمة بالأزرار.

الطُرق

create

 تُنشئ هذه الطريقة رسالة في مساحة Chat على Google Chat.

delete

 لحذف رسالة

get

 تعرض هذه الطريقة تفاصيل حول رسالة.

list

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

patch

 تعديل رسالة

replaceCards

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

update

 تعديل رسالة