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,
  "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 يصادق كمستخدم، ستملأ النتيجة المستخدم 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: لا ينطبق ذلك على رموز الإيموجي بتنسيق Unicode، مثل U+1F600 لوجه مبتسم.

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

object (Card)

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

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

object (CardWithId)

اختيارية: صفيف من البطاقات

يمكن لتطبيقات 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.
clientAssignedMessageId

string

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

object (EmojiReactionSummary)

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

object (User)

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

لمزيد من التفاصيل، يُرجى الاطّلاع على إرسال رسالة بشكل خاص.
deletionMetadata

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

النتائج فقط. معلومات حول رسالة اقتبسها مستخدم Google Chat في مساحة يمكن لمستخدمي Google Chat اقتباس رسالة للردّ عليها.
attachedGifs[]

object (AttachedGif)

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

object (AccessoryWidget)

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

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

CardWithId

بطاقة في رسالة Google 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,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
  // End of list of possible types for union field metadata.
}
الحقول
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),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
  // End of list of possible types for union field data.
}
الحقول
uri

string

معرّف الموارد المنتظم (URI) لهذا الرابط.
حقل الدمج data بيانات المرجع المرتبط يمكن أن تكون data إحدى القيم التالية فقط:

RichLinkType

نوع الرابط الغني بصريًا. وقد تتم إضافة المزيد من الأنواع في المستقبل.

عمليات التعداد
DRIVE_FILE نوع رابط غني في Google Drive
CHAT_SPACE نوع رابط غني بصريًا لمساحة Chat على سبيل المثال، شريحة ذكية لمساحة.
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 فاتتك مكالمة Huddle. في هذه الحالة، لن يكون معرّف الموارد المنتظم (URI) والمعرّفات لمساحة Meet صالحَين.

CalendarEventLinkData

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

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

string

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

string

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

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)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
الحقول
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

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

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

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

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

ثمة بيانات تالفة أو بيانات مفقودة ويتعذّر استرجاعها.

ربط HTTP: خطأ في الخادم الداخلي 500

UpdatedWidget

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

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

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
الحقول
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

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

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

string

النتائج فقط. اسم المورد الخاص بالرسالة المقتبسة

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

string (Timestamp format)

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

AttachedGif

صورة GIF يحدّدها عنوان URL.

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

string

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

AccessoryWidget

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

تمثيل JSON 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
الحقول
حقل الدمج action نوع الإجراء يمكن أن تكون action إحدى القيم التالية فقط:
buttonList

object (ButtonList)

قائمة بالأزرار

الطُرق

create

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

delete

 لحذف رسالة

get

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

list

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

patch

 تعديل رسالة

update

 تعديل رسالة