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

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

cards[]
(deprecated)

object (Card)

متوقّفة نهائيًا: استخدِم cardsV2 بدلاً منها.

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

cardsV2[]

object (CardWithId)

مصفوفة من البطاقات.

يمكن لتطبيقات Chat فقط إنشاء البطاقات. في حال تمت المصادقة كمستخدم لتطبيق Chat، لا يمكن أن تحتوي الرسائل على بطاقات.

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

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

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

annotations[]

object (Annotation)

النتائج فقط. التعليقات التوضيحية المرتبطة بـ text في هذه الرسالة

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 باستخدام مصادقة التطبيق وحذف ما يلي:

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

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 كيلوبايت.

تعليق توضيحي

النتائج فقط. التعليقات التوضيحية المرتبطة بالنص العادي للرسالة. لإضافة تنسيق أساسي إلى رسالة نصية، راجِع تنسيق الرسائل النصية.

مثال على نص رسالة بنص عادي:

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)
  }
  // End of list of possible types for union field metadata.
}
الحقول
type

enum (AnnotationType)

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

length

integer

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

startIndex

integer

بدء الفهرس (قائم على 0، شامل) في النص الأساسي لرسالة النص العادي الذي يتوافق مع هذا التعليق التوضيحي.

حقل الاتحاد metadata. بيانات وصفية إضافية حول التعليق التوضيحي. يمكن أن يكون metadata واحدًا فقط مما يلي:
userMention

object (UserMentionMetadata)

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

slashCommand

object (SlashCommandMetadata)

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

AnnotationType

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

عمليات التعداد
ANNOTATION_TYPE_UNSPECIFIED القيمة التلقائية للتعداد يُرجى عدم استخدامها.
USER_MENTION تمت الإشارة إلى مستخدم.
SLASH_COMMAND تم استدعاء أمر شرطة مائلة.

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

تمثّل هذه السمة رابطًا منسّقًا يؤدي إلى مرجع.

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

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

string

معرّف الموارد المنتظم (URI) لهذا الرابط.

حقل الاتحاد data. بيانات المرجع المرتبط يمكن أن يكون data واحدًا فقط مما يلي:

RichLinkType

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

عمليات التعداد
DRIVE_FILE نوع من الروابط المنسّقة في Google Drive.
CHAT_SPACE نوع من الروابط الغنية بصريًا لمساحات Chat. على سبيل المثال، شريحة ذكية لمساحات.

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}

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

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

PERMISSION_DENIED

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

تعيين HTTP: 403 محظور

UNAUTHENTICATED

لا يحتوي الطلب على بيانات اعتماد مصادقة صالحة للعملية.

تعيين HTTP: 401 غير مُصرح به

RESOURCE_EXHAUSTED

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

تعيين HTTP: 429 طلبات كثيرة جدًا

FAILED_PRECONDITION

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

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

تعيين HTTP: طلب 400 غير صالح

ABORTED

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

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

تعيين HTTP: تعارض 409

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

INTERNAL

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

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

UNAVAILABLE

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

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

تعيين HTTP: خدمة 503 غير متوفرة

DATA_LOSS

تلف أو فقدان بيانات غير قابل للإصلاح.

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

UpdatedWidget

تمثّل هذه السمة استجابة التطبيق المصغّر. يُستخدَم لتوفير خيارات الإكمال التلقائي لأداة ما.

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

المستخدم الذي حذف الرسالة وكيفية حذفها.

عمليات التعداد
DELETION_TYPE_UNSPECIFIED هذه القيمة غير مستخدمة.
CREATOR حذَف المستخدم رسالته الخاصة.
SPACE_OWNER حذف مالك المساحة الرسالة.
ADMIN حذف مشرف Google Workspace الرسالة.
APP_MESSAGE_EXPIRY حذف تطبيق Chat رسالته عند انتهاء صلاحيتها.
CREATOR_VIA_APP حذَف تطبيق Chat الرسالة نيابةً عن المستخدم.
SPACE_OWNER_VIA_APP حذَف تطبيق Chat الرسالة نيابةً عن مالك المساحة.

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

تعديل رسالة