Package google.chat.v1

الفهرس

ChatService

تتيح للمطوّرين إنشاء تطبيقات Chat وعمليات الدمج على Google Chat Platform.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

تُكمل عملية الاستيراد للمساحة المحدَّدة وتجعلها مرئية للمستخدمين.

يتطلّب مصادقة التطبيق والتفويض على مستوى النطاق. لمزيد من المعلومات، اطّلِع على تفويض تطبيقات Google Chat لاستيراد البيانات.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.import

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

تُنشئ رمزًا تعبيريًا مخصّصًا.

يتطلب مصادقة المستخدم.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.customemojis

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

توفّر الأنواع التالية من المصادقة:

على سبيل المثال، يمكنك الاطّلاع على ما يلي:

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

إنشاء رسالة في مساحة Google Chat مثلاً، راجِع إرسال رسالة.

تتطلّب طريقة create() إما مصادقة المستخدم أو مصادقة التطبيق. تختلف سمات مُرسِل الرسالة في Chat حسب نوع المصادقة التي تستخدمها في طلبك.

توضِّح الصورة التالية كيفية تحديد Chat لمصدر رسالة عند استخدام مصادقة التطبيق. يعرض تطبيق Chat تطبيق Chat باعتباره مُرسِل الرسالة. يمكن أن يتضمّن محتوى الرسالة نصًا (text) وبطاقات (cardsV2) وتطبيقات مصغّرة لوظائف إضافية (accessoryWidgets).

رسالة تم إرسالها باستخدام مصادقة التطبيق

توضّح الصورة التالية كيفية تحديد تطبيق Chat لرسالة عند استخدام مصادقة المستخدم. يعرض Chat المستخدم بصفته مُرسِل الرسالة وينسب تطبيق Chat إلى الرسالة من خلال عرض اسمه. يمكن أن يحتوي محتوى الرسالة على نص فقط (text).

تم إرسال الرسالة مع مصادقة المستخدم.

الحد الأقصى لحجم الرسالة، بما في ذلك محتوى الرسالة، هو 32,000 بايت.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

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

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة، جرِّب displayName مختلفًا. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

إذا كنت مشتركًا في برنامج معاينة المطوّرين، يمكنك إنشاء محادثة جماعية في وضع الاستيراد باستخدام spaceType.GROUP_CHAT.

توفّر الأنواع التالية من المصادقة:

عند المصادقة كتطبيق، يجب ضبط الحقل space.customer في الطلب.

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

لحذف رمز تعبيري مخصّص

يتطلب مصادقة المستخدم.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.customemojis

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

أن تتيح الأنواع التالية من المصادقة:

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

لحذف رسالة على سبيل المثال، راجِع حذف رسالة.

توفّر الأنواع التالية من المصادقة:

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

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

لحذف تفاعل مع رسالة يمكن استخدام الرموز التعبيرية بترميز يونيكود فقط. على سبيل المثال، راجِع المقالة حذف تفاعل.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

لحذف مساحة مُعنوَنة تُجري هذه العملية دائمًا عملية حذف متسلسلة، ما يعني أنّه يتم أيضًا حذف الموارد الفرعية للمساحة، مثل الرسائل المنشورة في المساحة وعضويات المساحة. على سبيل المثال، راجِع حذف مساحة.

توفّر الأنواع التالية من المصادقة:

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

عرض الرسالة المباشرة الحالية مع المستخدم المحدّد في حال عدم العثور على مساحة رسالة مباشرة، يتم عرض خطأ 404 NOT_FOUND. على سبيل المثال، راجِع البحث عن رسالة مباشرة.

من خلال مصادقة التطبيق، يتم عرض مساحة الرسالة المباشرة بين المستخدم المحدّد وتطبيق Chat الذي يجري الاتصال.

مع مصادقة المستخدم، يتم عرض مساحة الرسالة المباشرة بين المستخدم المحدّد والمستخدم الذي تمّت المصادقة عليه.

// يتيح الأنواع التالية من المصادقة:

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

الحصول على البيانات الوصفية لمرفق رسالة يتم جلب بيانات المرفق باستخدام media API. للحصول على مثال، يُرجى الاطّلاع على الحصول على البيانات الوصفية حول مرفق رسالة. يتطلب مصادقة التطبيق.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.bot

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

يتطلب مصادقة المستخدم.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

عرض تفاصيل حول اشتراك على سبيل المثال، اطّلِع على الحصول على تفاصيل حول اشتراك مستخدم أو تطبيق Google Chat.

توفّر الأنواع التالية من المصادقة:

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

عرض تفاصيل عن رسالة على سبيل المثال، اطّلِع على الحصول على تفاصيل عن رسالة.

أن تتيح الأنواع التالية من المصادقة:

ملاحظة: قد يعرض رسالة من عضو محظور أو مساحة.

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

عرض تفاصيل عن مساحة على سبيل المثال، يُرجى الاطّلاع على الحصول على تفاصيل عن مساحة.

أن تتيح الأنواع التالية من المصادقة:

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

عرض حدث من مساحة Google Chat تحتوي حمولة الحدث على أحدث إصدار من المرجع الذي تغيّر. على سبيل المثال، إذا طلبت حدثًا حول رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، يعرض الخادم مورد Message المحدّث في حمولة الحدث.

ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر Space ضمن بيانات حدث Space لهذا الطلب.

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

على سبيل المثال، راجِع مقالة الحصول على تفاصيل عن حدث من مساحة في Google Chat.

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

الحصول على إعدادات حالة إشعارات المساحة

يتطلب مصادقة المستخدم.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.users.spacesettings

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

تعرِض هذه السمة تفاصيل عن حالة قراءة المستخدم ضمن مساحة معيّنة، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة. على سبيل المثال، اطّلِع على الحصول على تفاصيل عن حالة قراءة مساحة المستخدم.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

تعرض قائمة برموز الإيموجي المخصّصة التي تظهر للمستخدم الذي تم مصادقة هويته.

يتطلب مصادقة المستخدم.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

يسرد العضوية في مساحة. على سبيل المثال، راجِع إنشاء قائمة بالمستخدمين وتطبيقات Google Chat في مساحة. تعرض بطاقة بيانات المتجر التي تستخدم ميزة المصادقة على التطبيق الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكنها تُستثنى منها الاشتراكات في التطبيقات، بما فيها المساحات الخاصة بها. يؤدي إدراج العضويات باستخدام مصادقة المستخدم إلى إدراج العضويات في المساحات التي يمكن للمستخدم المُعتمَد الوصول إليها.

توفّر الأنواع التالية من المصادقة:

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

تعرض هذه الصفحة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل الواردة من الأعضاء والمساحات المحظورة. في حال إدراج رسائل من مساحة لا تحتوي على رسائل، يكون الردّ كائنًا فارغًا. عند استخدام واجهة REST/HTTP، يحتوي الردّ على عنصر JSON فارغ، {}. على سبيل المثال، راجِع قائمة الرسائل.

يتطلب مصادقة المستخدم.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

يسرد التفاعلات مع رسالة. على سبيل المثال، اطّلِع على المقالة سرد التفاعلات مع رسالة.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

يسرد الأحداث من مساحة Google Chat. يحتوي الحِمل على أحدث إصدار من مورد Chat لكل حدث. مثلاً، في حال إدراج أحداث عن أعضاء المساحة الجدد، يعرض الخادم موارد Membership التي تحتوي على أحدث تفاصيل العضوية. إذا تمت إزالة الأعضاء الجدد خلال الفترة المطلوبة، تحتوي حمولة الحدث على مورد Membership فارغ.

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

على سبيل المثال، اطّلِع على إدراج الأحداث من مساحة في Google Chat.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

أن تتيح الأنواع التالية من المصادقة:

لإدراج جميع المساحات المُسمّاة حسب مؤسسة Google Workspace، استخدِم الطريقة spaces.search() باستخدام امتيازات مشرف Workspace بدلاً من ذلك.

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

تعرض قائمة المساحات في مؤسسة Google Workspace استنادًا إلى بحث المشرف.

تتطلب مصادقة المستخدمين الذين لديهم امتيازات المشرف. في الطلب، اضبط السمة use_admin_access على true.

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

لتحديد الأعضاء المطلوب إضافتهم، أضِف العضويات باستخدام السمة membership.member.name المناسبة. لإضافة مستخدم فعلي، استخدِم users/{user}، حيث يمكن أن يكون {user} عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن تكون السمة {user} هي id للمستخدم من People API، أو id للمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم user@example.com في People API هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/user@example.com أو users/123456789.

لتحديد مجموعات Google المطلوب إضافتها، أضِف العضويات باستخدام السمة membership.group_member.name المناسبة. لإضافة مجموعة Google أو دعوتها، استخدِم groups/{group}، حيث يكون {group} هو id للمجموعة من Cloud Identity Groups API. مثلاً، يمكنك استخدام Cloud Identity Groups lookup API لاسترداد المعرّف 123456789 للبريد الإلكتروني للمجموعة group@example.com، ثم إضافة المجموعة إلى المساحة من خلال ضبط membership.group_member.name على groups/123456789. البريد الإلكتروني للمجموعة غير متاح ولا يمكن إضافة "مجموعات Google" إلا كأعضاء في المساحات المُعنونة.

في المساحة المُعنوَنة أو المحادثة الجماعية، إذا حظر المتصل أو بعض الأعضاء، أو لم يكن لديه الإذن بإضافة بعض الأعضاء، لن تتم إضافة هؤلاء الأعضاء إلى المساحة التي تم إنشاؤها.

لإنشاء رسالة مباشرة بين المستخدم المتصل ومستخدم آخر، حدِّد عضوية واحدة بالضبط لتمثيل المستخدم. إذا حظر مستخدم مستخدمًا آخر، سيتعذّر إرسال الطلب ولن يتم إنشاء رسالة خاصة.

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

إذا كانت هناك رسالة مباشرة بين مستخدمَين، حتى عندما يحظر أحد المستخدمين الآخر عند تقديم الطلب، سيتم عرض الرسالة المباشرة الحالية.

المساحات التي تحتوي على ردود ضمن سلاسل غير متاحة. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب displayName مختلفًا. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

توفّر الأنواع التالية من المصادقة:

نطاقات الأذونات

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

يتم تعديل رسالة. هناك فرق بين طريقة patch وupdate. تستخدم الطريقة patch طلب patch بينما تستخدم الطريقة update طلب put. ننصحك باستخدام الطريقة patch. على سبيل المثال، راجِع تعديل رسالة.

أن تتيح الأنواع التالية من المصادقة:

عند استخدام مصادقة التطبيقات، لا يمكن للطلبات تعديل إلا الرسائل التي تم إنشاؤها من خلال تطبيق Chat للاتصال.

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

تعديل مساحة للحصول على مثال، يُرجى الاطّلاع على تعديل مساحة.

إذا كنت بصدد تعديل الحقل displayName وظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب اسمًا معروضًا مختلفًا. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

توفّر الأنواع التالية من المصادقة:

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

يتم تعديل إعدادات حالة إشعارات المساحة.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.users.spacesettings

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

تعدِّل حالة القراءة للمستخدم في مساحة، ويتم استخدامها لتحديد الرسائل المقروءة وغير المقروءة. على سبيل المثال، راجِع تعديل حالة قراءة مساحة المستخدم.

يتطلب مصادقة المستخدم.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/chat.users.readstate

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

AccessoryWidget

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

الحقول
حقل الربط action نوع الإجراء. يمكن أن يكون action واحدًا فقط مما يلي:
button_list

ButtonList

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

ActionResponse

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

الحقول
type

ResponseType

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

string

الإدخال فقط. عنوان URL يمكن للمستخدمين مصادقته أو ضبطه. (لنوعي REQUEST_CONFIG فقط من الردود).
dialog_action

DialogAction

الإدخال فقط ردّ على حدث تفاعل مرتبط بمربّع حوار يجب أن يكون مصحوبًا بـ ResponseType.Dialog.
updated_widget

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 طلب بحث عن خيارات الإكمال التلقائي للنص في التطبيق المصغّر

SelectionItems

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

الحقول
items[]

SelectionItem

مصفوفة من كائنات SelectionItem.

UpdatedWidget

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

الحقول
widget

string

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

SelectionItems

قائمة نتائج الإكمال التلقائي للأداة

ActionStatus

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

الحقول
status_code

Code

رمز الحالة
user_facing_message

string

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

تعليق توضيحي

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

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

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"
   }
}]
الحقول
type

AnnotationType

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

int32

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

int32

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

UserMentionMetadata

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

SlashCommandMetadata

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

AnnotationType

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

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

AttachedGif

صورة GIF محدّدة من خلال عنوان URL

الحقول
uri

string

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

مرفق

مرفق في Google Chat

الحقول
name

string

اسم المورد للمرفق، بالتنسيق spaces/{space}/messages/{message}/attachments/{attachment}
content_name

string

النتائج فقط. اسم الملف الأصلي للمحتوى، وليس المسار الكامل.
content_type

string

النتائج فقط. نوع المحتوى (نوع MIME) للملف
thumbnail_uri

string

النتائج فقط. عنوان URL للصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق لمستخدم بشري. يجب ألا تستخدم تطبيقات المحادثات عنوان URL هذا لتنزيل محتوى المرفقات.
download_uri

string

النتائج فقط. عنوان URL للتنزيل الذي يجب استخدامه للسماح لأحد المستخدمين بتنزيل المرفق. يجب ألا تستخدم تطبيقات المحادثات عنوان URL هذا لتنزيل محتوى المرفقات.
source

Source

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

AttachmentDataRef

إشارة إلى بيانات المرفق يُستخدَم هذا الحقل مع واجهة برمجة التطبيقات media API لتنزيل بيانات المرفق.
drive_data_ref

DriveDataRef

النتائج فقط. مرجع إلى مرفق Google Drive يتم استخدام هذا الحقل مع Google Drive API.

المصدر

مصدر المرفق.

عمليات التعداد
SOURCE_UNSPECIFIED محجوز.
DRIVE_FILE الملف هو ملف Google Drive.
UPLOADED_CONTENT تم تحميل الملف إلى Chat.

AttachmentDataRef

مرجع إلى بيانات المرفق.

الحقول
resource_name

string

اسم المورد لبيانات المرفق يُستخدَم هذا الحقل مع واجهة برمجة التطبيقات media API لتنزيل بيانات المرفق.
attachment_upload_token

string

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

CardWithId

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

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

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

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

الحقول
card_id

string

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

Card

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

ChatSpaceLinkData

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

الحقول
space

string

مساحة مرجع "مساحة Chat" المرتبط

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

string

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

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

string

رسالة مرجع مساحة Chat المرتبط.

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

CompleteImportSpaceRequest

رسالة طلب لإكمال عملية استيراد مساحة

الحقول
name

string

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

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

CompleteImportSpaceResponse

رسالة ردّ لإكمال عملية الاستيراد لمساحة

الحقول
space

Space

مساحة وضع الاستيراد

ContextualAddOnMarkup

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

الترميز المخصّص للمطوّرين لتحديد محتوى إضافة سياقية

بطاقة

البطاقة هي عنصر واجهة مستخدِم يمكن أن يحتوي على تطبيقات مصغّرة لواجهة المستخدِم، مثل النصوص والصور.

الحقول
header

CardHeader

عنوان البطاقة يحتوي العنوان عادةً على عنوان وصورة.
sections[]

Section

يتم فصل الأقسام بمقسم خط.
card_actions[]

CardAction

إجراءات هذه البطاقة.
name

string

اسم البطاقة

CardAction

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

لا تتوفّر هذه الميزة في تطبيقات Google Chat.

الحقول
action_label

string

التصنيف الذي كان معروضًا في عنصر قائمة الإجراءات
on_click

OnClick

إجراء JSON لبند العمل هذا.

CardHeader

الحقول
title

string

يجب تحديد العنوان. يكون للعنوان ارتفاع ثابت: إذا تم تحديد عنوان وعنوان فرعي، يشغل كل منهما سطرًا واحدًا. إذا تم تحديد العنوان فقط، سيشغل كلا السطرين.
subtitle

string

العنوان الفرعي لعنوان البطاقة.
image_style

ImageStyle

نوع الصورة (على سبيل المثال، حدود مربّعة أو حدود دائرية).
image_url

string

عنوان URL للصورة في عنوان البطاقة

ImageStyle

عمليات التعداد
IMAGE_STYLE_UNSPECIFIED
IMAGE حدود مربّعة
AVATAR حدود دائرية

القسم

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

الحقول
header

string

تمثّل هذه السمة عنوان القسم. يُسمح باستخدام النص المنسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على مقالتَي تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
widgets[]

WidgetMarkup

يجب أن يحتوي القسم على تطبيق مصغّر واحد على الأقل.

CreateCustomEmojiRequest

طلب لإنشاء رمز تعبيري مخصّص

الحقول
custom_emoji

CustomEmoji

مطلوب. الرموز التعبيرية المخصصة التي سيتم إنشاؤها.

CreateMembershipRequest

رسالة طلب لإنشاء اشتراك

الحقول
parent

string

مطلوب. اسم المورد للمساحة التي تريد إنشاء الاشتراك لها.

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

Membership

مطلوب. علاقة الاشتراك المطلوب إنشاؤها.

يجب أن يحتوي الحقل memberType على مستخدم تم ملء الحقلين user.name وuser.type فيه. سيعين الخادم اسم مورد ويستبدل أي شيء محدد.

عندما ينشئ تطبيق Chat علاقة اشتراك لأحد المستخدمين، يجب أن يستخدم نطاقات تفويض معيّنة ويضبط قيمًا معيّنة لحقول معيّنة:

  • عند المصادقة كمستخدم، يجب توفُّر نطاق التفويض chat.memberships.

  • عند المصادقة كتطبيق، يجب توفُّر نطاق التفويض chat.app.memberships. تتوفر المصادقة كتطبيق في

  • يمكنك ضبط user.type على HUMAN، وضبط user.name بالتنسيق users/{user}، حيث يمكن أن يكون {user} هو عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن يكون {user} أيضًا id لشخص من People API، أو id للمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم في People API في user@example.com هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/user@example.com أو users/123456789.

عندما ينشئ تطبيق Chat علاقة عضوية لنفسه، يجب المصادقة كمستخدم] واستخدام نطاق chat.memberships.app، وضبط user.type على BOT، وضبط user.name على users/app.
use_admin_access

bool

عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب chat.admin.memberships نطاق OAuth 2.0.

لا تتوفّر إمكانية إنشاء اشتراكات في التطبيقات أو إنشاء اشتراكات للمستخدمين خارج مؤسسة المشرف في Google Workspace باستخدام إذن وصول المشرف.

CreateMessageRequest

ينشئ رسالة

الحقول
parent

string

مطلوب. اسم المورد للمساحة التي تريد إنشاء رسالة فيها.

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

Message

مطلوب. نص الرسالة.
thread_key
(deprecated)

string

اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام thread.thread_key بدلاً منها. رقم تعريف سلسلة المحادثات يمكن استخدام ما يصل إلى 4,000 حرف. لبدء سلسلة محادثات أو الإضافة إليها، أنشِئ رسالة وحدِّد threadKey أو thread.name. للاطّلاع على أمثلة على الاستخدام، يُرجى الاطّلاع على بدء سلسلة محادثات أو الردّ عليها.
request_id

string

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

MessageReplyOption

اختياريّ. تُحدِّد ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة.
message_id

string

اختياريّ. معرّف مخصّص لرسالة. يسمح هذا الإذن للتطبيقات في Chat بتلقّي رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين رقم التعريف الذي يعيّنه النظام في اسم مورد الرسالة (المتمثل في حقل الرسالة name).

يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية:

  • يبدأ بـ client-. على سبيل المثال، client-custom-name هو معرّف مخصّص صالح، على عكس custom-name.
  • يشتمل على ما يصل إلى 63 حرفًا، ويمكن أن يشمل أحرفًا صغيرة وأرقامًا وواصلات فقط.
  • أن تكون فريدة من نوعها ضمن مساحة لا يمكن لتطبيق Chat استخدام المعرّف المخصّص نفسه لرسائل مختلفة.

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

MessageReplyOption

تُحدِّد كيفية الردّ على رسالة. قد تتم إضافة المزيد من الولايات في المستقبل.

عمليات التعداد
MESSAGE_REPLY_OPTION_UNSPECIFIED تلقائي: بدء سلسلة محادثات جديدة يؤدي استخدام هذا الخيار إلى تجاهل أي thread ID أو thread_key تم تضمينه.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD ينشئ الرسالة كرد على سلسلة المحادثات المحدّدة من قِبل "thread ID" أو "thread_key". إذا فشلت، تبدأ الرسالة سلسلة محادثات جديدة بدلاً من ذلك.
REPLY_MESSAGE_OR_FAIL ينشئ الرسالة كرد على سلسلة المحادثات المحدّدة من قِبل "thread ID" أو "thread_key". في حال استخدام thread_key جديد، يتم إنشاء سلسلة محادثات جديدة. وإذا تعذَّر إنشاء الرسالة، سيتم عرض الخطأ NOT_FOUND بدلاً من ذلك.

CreateReactionRequest

لإنشاء تفاعل مع رسالة

الحقول
parent

string

مطلوب. الرسالة التي تم إنشاء التفاعل عليها

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

Reaction

مطلوب. التفاعل المطلوب إنشائه.

CreateSpaceRequest

طلب لإنشاء مساحة مُسمّاة بدون أعضاء

الحقول
space

Space

مطلوب. يجب تعبئة الحقلَين displayName وspaceType. يُسمَح باستخدام SpaceType.SPACE فقط.

إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب displayName مختلفًا. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض.

إذا كنت مشتركًا في برنامج معاينة المطوّر، يمكن استخدام SpaceType.GROUP_CHAT في حال ضبط السياسة importMode على "صحيح".

يتم تخصيص المسافة name على الخادم، لذا سيتم تجاهل أي عنصر محدَّد في هذا الحقل.
request_id

string

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

CustomEmoji

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

الحقول
name

string

المُعرّف. اسم مصدر الرموز التعبيرية المخصّصة الذي حدّده الخادم

التنسيق: customEmojis/{customEmoji}

uid

string

النتائج فقط. مفتاح فريد لمورد الرموز التعبيرية المخصّصة
emoji_name

string

غير قابل للتغيير الاسم الذي يقدّمه المستخدم للرمز التعبيري المخصّص، وهو فريد داخل المؤسسة.

مطلوب عند إنشاء الرمز التعبيري المخصّص، وإخراج القيمة فقط في الحالات الأخرى.

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

مثلاً: :valid-emoji-name:

temporary_image_uri

string

النتائج فقط. عنوان URL للصورة المخصّصة للرموز التعبيرية، ويجب أن يكون صالحًا لمدة 10 دقائق على الأقل. يُرجى العِلم أنّه لا تتم تعبئة هذا الحقل في الردّ عند إنشاء الرمز التعبيري المخصَّص.

payload

CustomEmojiPayload

الإدخال فقط. بيانات الحمولة

CustomEmojiPayload

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

الحقول
file_content

bytes

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

يجب أن تكون الحمولة أقل من 256 كيلوبايت ويجب أن يتراوح أبعاد الصورة بين 64 و500 بكسل. تخضع القيود للتغيير.
filename

string

مطلوب. الإدخال فقط اسم ملف الصورة.

امتدادات الملفات المتوافقة: .png و.jpg و.gif.

DeleteCustomEmojiRequest

طلب لحذف رمز تعبيري مخصّص

الحقول
name

string

مطلوب. اسم مورد الرمز التعبيري المخصّص المطلوب حذفه.

التنسيق: customEmojis/{customEmoji}

يمكنك استخدام اسم الرمز التعبيري كاسم بديل لـ {customEmoji}. على سبيل المثال، customEmojis/:example-emoji: حيث يكون :example-emoji: هو اسم الرمز التعبيري للرمز التعبيري المخصّص.

DeleteMembershipRequest

طلب حذف عضوية في مساحة

الحقول
name

string

مطلوب. اسم مورد العضوية المطلوب حذفه. يمكن لتطبيقات Chat حذف اشتراكات المستخدمين أو اشتراكاتهم الخاصة. لا يمكن لتطبيقات المحادثة حذف الاشتراكات في التطبيقات الأخرى.

عند حذف اشتراك مستخدم، يجب استخدام النطاق chat.memberships وتنسيق spaces/{space}/members/{member}. يمكنك استخدام البريد الإلكتروني كاسم مستعار للنطاق {member}. على سبيل المثال، spaces/{space}/members/example@gmail.com حيث يكون example@gmail.com هو عنوان البريد الإلكتروني لمستخدم Google Chat.

عند حذف اشتراك في تطبيق، يجب استخدام نطاق chat.memberships.app وتنسيق spaces/{space}/members/app.

التنسيق: spaces/{space}/members/{member} أو spaces/{space}/members/app
use_admin_access

bool

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاق OAuth 2.0 chat.admin.memberships.

لا يمكن حذف الاشتراكات في التطبيقات في مساحة باستخدام إذن وصول المشرف.

DeleteMessageRequest

طلب حذف رسالة

الحقول
name

string

مطلوب. اسم المورد للرسالة

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

في حال ضبط معرّف مخصّص لرسالتك، يمكنك استخدام القيمة من الحقل clientAssignedMessageId لـ {message}. للحصول على التفاصيل، يُرجى الاطِّلاع على تسمية رسالة.
force

bool

عندما true، يؤدي حذف الرسالة إلى حذف الردود المتسلسلة أيضًا. عندما يكون الخيار false مفعَّلاً، إذا كانت الرسالة تتضمّن ردودًا في سلسلة محادثات، يتعذّر حذفها.

لا تنطبق إلا عند المصادقة كمستخدم. لا يحدث أي تأثير عند المصادقة كتطبيق Chat.

DeleteReactionRequest

لحذف تفاعل مع رسالة

الحقول
name

string

مطلوب. اسم التفاعل المطلوب حذفه.

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

DeleteSpaceRequest

طلب حذف مساحة

الحقول
name

string

مطلوب. اسم المورد للمساحة المطلوب حذفها

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

bool

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب chat.admin.delete نطاق OAuth 2.0.

DeletionMetadata

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

الحقول
deletion_type

DeletionType

يشير إلى المستخدم الذي حذف الرسالة.

DeletionType

المستخدم الذي حذف الرسالة وطريقة حذفها ويمكن إضافة المزيد من القيم في المستقبل.

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

مربّع حوار

منتج يتم إغلاقه حول نص البطاقة في مربّع الحوار.

الحقول
body

Card

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

DialogAction

يحتوي على محادثة ورمز حالة الطلب.

الحقول
action_status

ActionStatus

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

Dialog

الإدخال فقط مربّع الحوار للطلب

DriveDataRef

إشارة إلى بيانات مرفق في مساحة التخزين

الحقول
drive_file_id

string

رقم تعريف ملف Drive. الاستخدام مع Drive API

DriveLinkData

بيانات روابط Google Drive

الحقول
drive_data_ref

DriveDataRef

DriveDataRef يشير إلى ملف على Google Drive
mime_type

string

نوع MIME لمورد Google Drive المرتبط.

رموز الإيموجي

رمز تعبيري يُستخدم كتفاعل مع رسالة.

الحقول
حقل الاتحاد content. محتوى الرمز التعبيري يمكن أن يكون content واحدًا فقط مما يلي:
unicode

string

يشير ذلك المصطلح إلى رمز تعبيري أساسي يتم تمثيله بسلسلة بترميز يونيكود.
custom_emoji

CustomEmoji

النتائج فقط. رمز تعبيري مخصّص

EmojiReactionSummary

عدد المستخدمين الذين تفاعلوا مع رسالة باستخدام رمز تعبيري معيّن

الحقول
emoji

Emoji

الرمز التعبيري المرتبط بالتفاعلات
reaction_count

int32

إجمالي عدد التفاعلات باستخدام الرمز التعبيري المرتبط

FindDirectMessageRequest

طلب للحصول على مساحة رسالة مباشرة استنادًا إلى مورد المستخدم.

الحقول
name

string

مطلوب. اسم المورد للمستخدم الذي تريد العثور على رسالة مباشرة به.

التنسيق: users/{user}، حيث يكون {user} هو id الخاص بالشخص من People API، أو id الخاص بالمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي في People API هو 123456789، يمكنك العثور على رسالة مباشرة مع هذا المستخدم باستخدام users/123456789 كـ name. عند المصادقة كمستخدم، يمكنك استخدام عنوان البريد الإلكتروني كاسم بديل لـ {user}. على سبيل المثال، users/example@gmail.com حيث يكون example@gmail.com هو عنوان البريد الإلكتروني لمستخدم Google Chat.

GetAttachmentRequest

طلب الحصول على مرفق

الحقول
name

string

مطلوب. اسم مصدر المرفق، بالتنسيق spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

طلب عرض رمز تعبيري مخصّص واحد

الحقول
name

string

مطلوب. اسم المورد الخاص بالرمز التعبيري المخصّص

تنسيق الملف: customEmojis/{customEmoji}

يمكنك استخدام اسم الرمز التعبيري كاسم مستعار لـ {customEmoji}. على سبيل المثال، customEmojis/:example-emoji: حيث يكون :example-emoji: هو اسم رمز تعبيري مخصّص.

GetMembershipRequest

طلب الحصول على عضوية في مساحة

الحقول
name

string

مطلوب. اسم مورد العضوية المطلوب استرداده.

للحصول على اشتراك في التطبيق باستخدام مصادقة المستخدم، يمكنك اختياريًا استخدام spaces/{space}/members/app.

التنسيق: spaces/{space}/members/{member} أو spaces/{space}/members/app

يمكنك استخدام عنوان البريد الإلكتروني للمستخدم كعنوان بديل لـ {member}. على سبيل المثال، spaces/{space}/members/example@gmail.com حيث يكون example@gmail.com هو عنوان البريد الإلكتروني لمستخدم Google Chat.
use_admin_access

bool

عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاقات OAuth 2.0 chat.admin.memberships أو chat.admin.memberships.readonly.

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

GetMessageRequest

يمكنك طلب تلقّي رسالة.

الحقول
name

string

مطلوب. اسم المورد للرسالة

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

إذا كنت قد ضبطت معرّفًا مخصّصًا لرسالتك، يمكنك استخدام القيمة من حقل clientAssignedMessageId لـ {message}. للحصول على التفاصيل، يُرجى الاطِّلاع على تسمية رسالة.

GetSpaceEventRequest

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

الحقول
name

string

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

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

GetSpaceNotificationSettingRequest

رسالة طلب للحصول على إعدادات الإشعارات في المساحة لا يتوافق هذا الخيار إلا مع إعدادات تلقّي الإشعارات للمستخدم المتصل.

الحقول
name

string

مطلوب. التنسيق: users/{user}/spaces/{space}/spaceNotificationsetting

  • users/me/spaces/{space}/spaceNotificationSetting أو
  • users/user@example.com/spaces/{space}/spaceNotificationSetting، أو
  • users/123456789/spaces/{space}/spaceNotificationSetting. ملاحظة: يُسمح فقط برقم تعريف المستخدم أو عنوان البريد الإلكتروني الخاص بالمتصل في المسار.

GetSpaceReadStateRequest

طلب رسالة لواجهة برمجة تطبيقات GetSpaceReadState.

الحقول
name

string

مطلوب. اسم المورد لحالة قراءة المساحة المطلوب استرجاعها

لا تتيح هذه الوظيفة سوى الحصول على حالة القراءة للمستخدم المتصل.

للإشارة إلى المستخدم الذي يتصل بتطبيقك، عليك ضبط أحد الخيارات التالية:

  • العنوان البديل للبريد الإلكتروني me مثلاً: users/me/spaces/{space}/spaceReadState

  • عنوان البريد الإلكتروني في Workspace مثلاً: users/user@example.com/spaces/{space}/spaceReadState

  • رقم تعريف المستخدم مثلاً: users/123456789/spaces/{space}/spaceReadState

التنسيق: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

طلب لعرض مساحة واحدة

الحقول
name

string

مطلوب. اسم مورد المساحة، بالتنسيق spaces/{space}

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

bool

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاقات OAuth 2.0 chat.admin.spaces أو chat.admin.spaces.readonly.

GetThreadReadStateRequest

طلب رسالة لواجهة برمجة تطبيقات GetThreadReadStateRequest.

الحقول
name

string

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

لا تتوافق هذه الميزة إلا مع الحصول على حالة القراءة للمستخدم المتصل.

للإشارة إلى المستخدم الذي يتصل بتطبيقك، عليك ضبط أحد الخيارات التالية:

  • العنوان البديل للبريد الإلكتروني me مثلاً: users/me/spaces/{space}/threads/{thread}/threadReadState

  • عنوان البريد الإلكتروني في Workspace مثلاً: users/user@example.com/spaces/{space}/threads/{thread}/threadReadState

  • رقم تعريف المستخدم مثلاً: users/123456789/spaces/{space}/threads/{thread}/threadReadState

التنسيق: users/{user}/spaces/{space}/threads/{thread}/threadReadState

مجموعة

"مجموعة Google" في Google Chat

الحقول
name

string

اسم المورد لمجموعة Google

ممثِّلة مجموعة في Cloud Identity Groups API

التنسيق: groups/{group}

HistoryState

حالة السجلّ للرسائل والمساحات تُحدِّد هذه القيمة مدة الاحتفاظ بالرسائل وسلاسل المحادثات بعد إنشائها.

عمليات التعداد
HISTORY_STATE_UNSPECIFIED القيمة التلقائية لا تستخدِم هذه الطريقة.
HISTORY_OFF السجلّ غير مفعَّل. يتم الاحتفاظ بالرسائل وسلاسل المحادثات لمدة 24 ساعة.
HISTORY_ON السجلّ مفعّل. تحدِّد قواعد الاحتفاظ بالبيانات في Vault الخاصة بالمؤسسة مدة الاحتفاظ بالرسائل سلاسل المحادثات.

ListCustomEmojisRequest

طلب لعرض قائمة رموز تعبيرية مخصّصة

الحقول
page_size

int32

اختياريّ. الحد الأقصى لعدد رموز الإيموجي المخصّصة التي يتم عرضها يمكن أن تعرض الخدمة عددًا أقل من رموز الإيموجي المخصّصة مقارنةً بهذه القيمة. في حال عدم تحديد القيمة، تكون القيمة التلقائية هي 25. الحدّ الأقصى للقيمة هو 200، ويتمّ تغيير القيم التي تزيد عن 200 إلى 200.
page_token

string

اختياريّ. (في حال الاستئناف من استعلام سابق.)

رمز مميّز للصفحة تم تلقّيه من استدعاء رمز تعبيري مخصّص سابق للقائمة. قدِّم هذا المرجع لاسترداد الصفحة اللاحقة.

عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم الرمز المميّز للصفحة. وقد يؤدي تمرير قيمة مختلفة إلى نتائج غير متوقّعة.
filter

string

اختياريّ. فلتر طلب بحث

تتيح الفلترة حسب صانع المحتوى.

لفلترة المحتوى حسب صانع المحتوى، يجب تحديد قيمة صالحة. في الوقت الحالي، يمكن فقط لكل من creator("users/me") وNOT creator("users/me") فلترة الرموز التعبيرية المخصّصة حسب ما إذا كان المستخدم المتصل هو من أنشأ هذه الرموز أم لا.

على سبيل المثال، يعرض طلب البحث التالي رموزًا تعبيرية مخصصة أنشأها المتصل:

creator("users/me")

يرفض الخادم طلبات البحث غير الصالحة مع ظهور الخطأ INVALID_ARGUMENT.

ListCustomEmojisResponse

ردّ على قائمة برموز إيموجي مخصّصة

الحقول
custom_emojis[]

CustomEmoji

قائمة بدون ترتيب قائمة برموز الإيموجي المخصّصة في الصفحة المطلوبة (أو الأولى)
next_page_token

string

رمز مميز يمكنك إرساله كـ pageToken لاسترداد الصفحة التالية من النتائج. إذا كانت فارغة، يعني ذلك عدم توفّر صفحات لاحقة.

ListMembershipsRequest

رسالة طلب إدراج الاشتراكات الداعمة

الحقول
parent

string

مطلوب. اسم المورد للمساحة المطلوب جلب قائمة الاشتراكات فيها.

التنسيق: domains/{space}
page_size

int32

اختياريّ. الحدّ الأقصى لعدد العضويات المطلوب عرضها قد تعرض الخدمة عددًا أقل من هذه القيمة.

إذا لم يتم تحديد عدد معيّن، يتم عرض 100 اشتراك كحدّ أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.

تعرِض القيم السلبية خطأ INVALID_ARGUMENT.
page_token

string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من مكالمة سابقة لإدراج العضويات في القناة. قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلمات الأخرى المقدّمة مع الاستدعاء الذي قدّم الرمز المميز للصفحة. وقد يؤدي ضبط قيم مختلفة للمَعلمات الأخرى إلى نتائج غير متوقّعة.
filter

string

اختياريّ. فلتر طلب بحث

يمكنك فلترة الاشتراكات الداعمة حسب دور العضو (role) ونوعه (member.type).

لفلترة البيانات حسب الدور، اضبط role على ROLE_MEMBER أو ROLE_MANAGER.

للفلترة حسب النوع، اضبط member.type على HUMAN أو BOT. يمكنك أيضًا الفلترة حسب member.type باستخدام عامل التشغيل !=.

لفلترة البيانات حسب الدور والنوع معًا، استخدِم عامل التشغيل AND. للفلترة حسب الدور أو النوع، استخدِم عامل التشغيل OR.

يجب استخدام إما member.type = "HUMAN" أو member.type != "BOT" عند ضبط use_admin_access على "صحيح". سيتم رفض فلاتر أنواع الأعضاء الأخرى.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

طلبات البحث التالية غير صالحة:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

يرفض الخادم طلبات البحث غير الصالحة ويعرض خطأ INVALID_ARGUMENT.
show_groups

bool

اختياريّ. عند true، يتم أيضًا عرض العضويات المرتبطة بـ Google Group، بالإضافة إلى أنواع أخرى من العضويات. في حال ضبط filter، لا يتم عرض العضويات في Google Group التي لا تطابق معايير الفلتر.
show_invited

bool

اختياريّ. عند عرض "true"، يعرض أيضًا العضويات المرتبطة بأعضاء invited، بالإضافة إلى أنواع أخرى من العضويات. وفي حال ضبط فلتر، لن يتم عرض عضويات invited التي لا تتطابق مع معايير الفلتر.

تتطلب حاليًا مصادقة المستخدم.
use_admin_access

bool

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاق OAuth 2.0 chat.admin.memberships.readonly أو chat.admin.memberships.

لا يمكن إدراج اشتراكات التطبيقات في مساحة عند استخدام إذن الوصول الإداري.

ListMembershipsResponse

الرد لإدراج أعضاء المساحة في المساحة

الحقول
memberships[]

Membership

قائمة بدون ترتيب. قائمة العضويات الظاهرة على الصفحة المطلوبة (أو الأولى)
next_page_token

string

رمز مميز يمكنك إرساله كـ pageToken لاسترداد الصفحة التالية من النتائج. وإذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة.

ListMessagesRequest

يسرد الرسائل في المساحة المحدّدة التي يكون المستخدم عضوًا فيها.

الحقول
parent

string

مطلوب. اسم المورد للمساحة التي تريد إدراج الرسائل منها

تنسيق الملف: spaces/{space}
page_size

int32

الحد الأقصى لعدد الرسائل التي يتم عرضها. قد تعرض الخدمة رسائل أقل من هذه القيمة.

إذا لم يتم تحديد عدد، يتم عرض 25 عنصرًا بحد أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.

تعرِض القيم السلبية خطأ INVALID_ARGUMENT.
page_token

string

اختياري، في حال استئناف طلب بحث سابق

رمز مميّز للصفحة تم تلقّيه من مكالمة سابقة لرسائل قائمة قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلمات الأخرى المقدّمة مع الاستدعاء الذي قدّم الرمز المميز للصفحة. وقد يؤدي ضبط قيم مختلفة للمَعلمات الأخرى إلى نتائج غير متوقّعة.
filter

string

فلتر طلب بحث

يمكنك فلترة الرسائل حسب التاريخ (create_time) وسلسلة المحادثات (thread.name).

لفلترة الرسائل حسب تاريخ إنشائها، حدِّد create_time باستخدام طابع زمني بتنسيق RFC-3339 وعلامتَي اقتباس مزدوجتَين. مثلاً: "2023-04-21T11:30:00-04:00" يمكنك استخدام عامل التشغيل "أكبر من" > لإدراج الرسائل التي تم إنشاؤها بعد طابع زمني، أو عامل التشغيل "أقل من" < لإدراج الرسائل التي تم إنشاؤها قبل طابع زمني. لفلترة الرسائل ضمن فاصل زمني، استخدِم عامل التشغيل AND بين طابعَي زمنيَّين.

لفلترة الرسائل حسب سلسلة المحادثات، حدِّد thread.name بالتنسيق spaces/{space}/threads/{thread}. يمكنك تحديد thread.name واحدة فقط لكل طلب بحث.

للفلترة حسب سلسلة المحادثات والتاريخ، استخدِم عامل التشغيل AND في طلب البحث.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

يرفض الخادم طلبات البحث غير الصالحة مع ظهور الخطأ INVALID_ARGUMENT.
order_by

string

اختياري، في حال استئناف طلب بحث سابق

كيفية ترتيب قائمة الرسائل. حدِّد قيمة لترتيبها حسب عملية ترتيب. في ما يلي القيم الصالحة لعملية الترتيب:

  • ASC تصاعديًا.

  • DESC للترتيب التنازلي

الترتيب التلقائي هو create_time ASC.
show_deleted

bool

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

ListMessagesResponse

رسالة ردّ على الرسائل المدرَجة في بطاقة بيانات المتجر.

الحقول
messages[]

Message

قائمة الرسائل
next_page_token

string

يمكنك إرسال رمز مميّز على النحو التالي: pageToken لاسترداد الصفحة التالية من النتائج. إذا كانت فارغة، يعني ذلك عدم توفّر صفحات لاحقة.

ListReactionsRequest

يسرد التفاعلات مع رسالة.

الحقول
parent

string

مطلوب. الرسالة التي تفاعل معها المستخدمون

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

int32

اختياريّ. الحد الأقصى لعدد التفاعلات المعروضة يمكن أن تعرض الخدمة تفاعلات أقل من هذه القيمة. إذا لم يتم تحديد عدد، تكون القيمة التلقائية هي 25. الحد الأقصى للقيمة هو 200، ويتم تغيير القيم الأعلى من 200 إلى 200.
page_token

string

اختياريّ. (في حال الاستئناف من استعلام سابق.)

رمز مميّز للصفحة تم تلقّيه من طلب سابق لعرض التفاعلات مع المحتوى. قدِّم هذا المرجع لاسترداد الصفحة اللاحقة.

عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلتر مع الطلب الذي قدّم الرمز المميّز للصفحة. وقد يؤدي تمرير قيمة مختلفة إلى نتائج غير متوقّعة.
filter

string

اختياريّ. فلتر طلب بحث

يمكنك فلترة التفاعلات حسب الرمز التعبيري (emoji.unicode أو emoji.custom_emoji.uid) والمستخدم (user.name).

لفلترة التفاعلات لرموز تعبيرية أو مستخدمين متعددين، يمكنك دمج حقول متشابهة مع عامل التشغيل OR، مثل emoji.unicode = "🙂" OR emoji.unicode = "👍" وuser.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

لفلترة التفاعلات حسب الرموز التعبيرية والمستخدم، استخدِم عامل التشغيل AND، مثل emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

إذا كان طلب البحث يستخدم كلاً من AND وOR، اجمعهما باستخدام قوسَين.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

طلبات البحث التالية غير صالحة:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

يرفض الخادم طلبات البحث غير الصالحة ويعرض خطأ INVALID_ARGUMENT.

ListReactionsResponse

ردّ على طلب عرض التفاعلات

الحقول
reactions[]

Reaction

قائمة بالتفاعلات في الصفحة المطلوبة (أو الأولى)
next_page_token

string

الرمز المميز للمتابعة لاسترداد الصفحة التالية من النتائج. هذا الحقل فارغ للصفحة الأخيرة من النتائج.

ListSpaceEventsRequest

رسالة طلب إدراج أحداث المساحة

الحقول
parent

string

مطلوب. اسم المورد لمساحة Google Chat التي وقعت فيها الأحداث

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

int32

اختياريّ. الحد الأقصى لعدد أحداث المساحة التي يتم عرضها قد تعرض الخدمة عددًا أقل من هذه القيمة.

تعرِض القيم السلبية خطأ INVALID_ARGUMENT.
page_token

string

رمز تعريف صفحة تم تلقّيه من طلب سابق لأحداث مساحة القائمة قدِّم هذا المرجع لاسترداد الصفحة اللاحقة.

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

string

مطلوب. فلتر طلب بحث

يجب تحديد نوع حدث واحد على الأقل (event_type) باستخدام عامل التشغيل has :. للفلترة حسب أنواع أحداث متعدّدة، استخدِم عامل التشغيل OR. إزالة أنواع أحداث الدفعات في الفلتر يعرض الطلب تلقائيًا أي أحداث مجمّعة ذات صلة. على سبيل المثال، في حال الفلترة حسب التفاعلات الجديدة (google.workspace.chat.reaction.v1.created)، يعرض الخادم أيضًا أحداث التفاعلات الجديدة المجمّعة (google.workspace.chat.reaction.v1.batchCreated). للحصول على قائمة بأنواع الأحداث المتوافقة، يمكنك الاطّلاع على المستندات المرجعية لنظام SpaceEvents.

يمكنك اختياريًا أيضًا الفلترة حسب وقت البدء (start_time) ووقت الانتهاء (end_time):

  • start_time: طابع زمني حصري لبدء إدراج أحداث المساحة يمكنك سرد الأحداث التي تمت قبل ما يصل إلى 28 يومًا. في حال عدم تحديد ذلك، سيتم عرض أحداث المساحة من آخر 28 يومًا.
  • end_time: طابع زمني شامل يتم إدراج أحداث المساحة قبله في حال عدم تحديده، يتم إدراج الأحداث حتى وقت الطلب.

لتحديد وقت البدء أو وقت الانتهاء، استخدِم عامل التشغيل يساوي = والتنسيق RFC-3339. لفلترة البيانات حسب start_time وend_time معًا، استخدِم عامل التشغيل AND.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

طلبات البحث التالية غير صالحة:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

يرفض الخادم طلبات البحث غير الصالحة مع ظهور الخطأ INVALID_ARGUMENT.

ListSpaceEventsResponse

رسالة ردّ على بيانات أحداث المساحة

الحقول
space_events[]

SpaceEvent

يتم عرض النتائج بترتيب زمني (الحدث الأقدم أولاً). ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر Space لطلبات القوائم.
next_page_token

string

رمز المتابعة المستخدَم لجلب المزيد من الأحداث في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

ListSpacesRequest

طلب بعرض المساحات التي يكون المتصل عضوًا فيها

الحقول
page_size

int32

اختياريّ. الحد الأقصى لعدد المسافات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة.

إذا لم يتم تحديد عدد، يتم عرض 100 مسافة كحد أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.

تعرِض القيم السلبية خطأ INVALID_ARGUMENT.
page_token

string

اختياريّ. رمز مميّز للصفحة، تم تلقّيه من استدعاء سابق لمساحات قائمة قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

عند التقسيم على صفحات، يجب أن تتطابق قيمة الفلتر مع الاستدعاء الذي قدّم الرمز المميز للصفحة. قد يؤدي إدخال قيمة مختلفة إلى نتائج غير متوقّعة.
filter

string

اختياريّ. فلتر طلب بحث

يمكنك فلترة المساحات حسب نوع المساحة (space_type).

للفلترة حسب نوع المساحة، يجب تحديد قيمة تعداد صالحة، مثل SPACE أو GROUP_CHAT (لا يمكن أن تكون قيمة space_type هي SPACE_TYPE_UNSPECIFIED). وللبحث عن أنواع مساحات متعدّدة، استخدِم عامل التشغيل OR.

على سبيل المثال، تكون طلبات البحث التالية صالحة:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

يرفض الخادم طلبات البحث غير الصالحة ويعرض خطأ INVALID_ARGUMENT.

ListSpacesResponse

الردّ على طلب مساحات عمل قائمة

الحقول
spaces[]

Space

قائمة بالمساحات في الصفحة المطلوبة (أو الأولى). ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر Space لطلبات القوائم.
next_page_token

string

يمكنك إرسال رمز مميّز كـ pageToken لاسترداد الصفحة التالية من النتائج. إذا كانت فارغة، يعني ذلك عدم توفّر صفحات لاحقة.

MatchedUrl

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

الحقول
url

string

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

العضوية

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

الحقول
name

string

اسم المورد الخاص بالاشترِك الذي عيّنه الخادم

التنسيق: spaces/{space}/members/{member}
state

MembershipState

النتائج فقط. حالة الاشتراك
role

MembershipRole

اختياريّ. دور المستخدم ضمن مساحة Chat، والذي يحدِّد الإجراءات المسموح بها في المساحة

يمكن استخدام هذا الحقل كإدخال فقط في UpdateMembership.
create_time

Timestamp

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

Timestamp

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

User

مستخدِم أو تطبيق Google Chat الذي تتوافق معه العضوية. إذا كان تطبيق Chat يستخدم المصادقة كمستخدم، ستتم تعبئة المستخدِم name وtype في الإخراج.
group_member

Group

مجموعة Google التي تتوافق معها العضوية

تتطلب قراءة بيانات العضويات أو تغييرها في "مجموعات Google" مصادقة المستخدم.

MembershipRole

لتمثيل إجراءات المستخدم المسموح بها في مساحة Chat قد تتم إضافة المزيد من قيم التعداد في المستقبل.

عمليات التعداد
MEMBERSHIP_ROLE_UNSPECIFIED القيمة التلقائية بالنسبة إلى users: هذا الشخص ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى Google Groups: يتم دائمًا تعيين هذا الدور لها (قد يتم استخدام قيم أخرى للترقيم في المستقبل).
ROLE_MEMBER عضو في المساحة يحصل المستخدم على أذونات أساسية، مثل إرسال الرسائل إلى المساحة. في المحادثات بين شخصين والمحادثات الجماعية بدون اسم، يحصل جميع المستخدمين على هذا الدور.
ROLE_MANAGER مدير مساحة يمتلك المستخدم جميع الأذونات الأساسية بالإضافة إلى الأذونات الإدارية التي تتيح له إدارة المساحة، مثل إضافة الأعضاء أو إزالتهم. متاح في SpaceType.SPACE فقط.

MembershipState

تُحدِّد علاقة العضو بالمساحة. وقد نتيح في المستقبل استخدام حالات عضوية أخرى.

عمليات التعداد
MEMBERSHIP_STATE_UNSPECIFIED القيمة التلقائية. يُرجى عدم استخدامها.
JOINED تتم إضافة المستخدم إلى المساحة ويمكنه المشاركة فيها.
INVITED تمت دعوة المستخدم للانضمام إلى المساحة، ولكنّه لم ينضم إليها.
NOT_A_MEMBER لا ينتمي المستخدم إلى المساحة وليس لديه دعوة في انتظار المراجعة للانضمام إلى المساحة.

MembershipBatchCreatedEventData

حمولة الأحداث لعدة عضويات جديدة

نوع الحدث: google.workspace.chat.membership.v1.batchCreated

الحقول
memberships[]

MembershipCreatedEventData

قائمة بالاشتراكات الجديدة

MembershipBatchDeletedEventData

حمولة الأحداث لعدة عضويات محذوفة.

نوع الحدث: google.workspace.chat.membership.v1.batchDeleted

الحقول
memberships[]

MembershipDeletedEventData

قائمة بالاشتراكات المحذوفة

MembershipBatchUpdatedEventData

الحمولة في الحدث لعدة اشتراكات معدَّلة

نوع الحدث: google.workspace.chat.membership.v1.batchUpdated

الحقول
memberships[]

MembershipUpdatedEventData

قائمة بالاشتراكات المعدَّلة

MembershipCreatedEventData

الحمولة في الحدث لاشتراك جديد.

نوع الفعالية: google.workspace.chat.membership.v1.created.

الحقول
membership

Membership

العضوية الجديدة

MembershipDeletedEventData

الحمولة في الحدث لاشتراك تم حذفه

نوع الحدث: google.workspace.chat.membership.v1.deleted

الحقول
membership

Membership

العضوية المحذوفة. تتم تعبئة الحقلين name وstate فقط.

MembershipUpdatedEventData

الحمولة البرمجية للحدث لاشتراك معدَّل

نوع الحدث: google.workspace.chat.membership.v1.updated

الحقول
membership

Membership

الاشتراك المعدّل

الرسالة

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

الحقول
name

string

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

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

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

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

User

النتائج فقط. المستخدِم الذي أنشأ الرسالة إذا كان تطبيق Chat يستخدم المصادقة كمستخدم، ستتم تعبئة المستخدِم name وtype في الإخراج.
create_time

Timestamp

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

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

Timestamp

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

Timestamp

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

string

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

لمعرفة كيفية إنشاء الرسائل النصية، راجع إرسال رسالة.
formatted_text

string

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

  • بنية الترميز للنص الغامق والمائل والمخطوط والنص ذي المسافة الثابتة والنص ذي المسافة الثابتة في شكل كتلة والقائمة النقطية

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

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

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

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

Card

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

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

CardWithId

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

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

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

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

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

Annotation

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

Thread

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

Space

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

string

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

ActionResponse

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

string

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

SlashCommand

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

Attachment

مرفق حمّله المستخدم
matched_url

MatchedUrl

النتائج فقط. عنوان URL في spaces.messages.text يتطابق مع نمط معاينة الرابط لمزيد من المعلومات، يُرجى الاطّلاع على معاينة الروابط.
thread_reply

bool

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

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

string

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

EmojiReactionSummary

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

User

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

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

DeletionMetadata

النتائج فقط. معلومات حول رسالة تم حذفها يتم حذف الرسالة عند ضبط "delete_time".
quoted_message_metadata

QuotedMessageMetadata

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

AttachedGif

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

AccessoryWidget

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

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

MessageBatchCreatedEventData

حمولة الحدث للرسائل الجديدة المتعددة

نوع الحدث: google.workspace.chat.message.v1.batchCreated

الحقول
messages[]

MessageCreatedEventData

قائمة بالرسائل الجديدة

MessageBatchDeletedEventData

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

نوع الحدث: google.workspace.chat.message.v1.batchDeleted

الحقول
messages[]

MessageDeletedEventData

قائمة بالرسائل المحذوفة

MessageBatchUpdatedEventData

الحمولة للحدث لعدة رسائل معدَّلة

نوع الحدث: google.workspace.chat.message.v1.batchUpdated

الحقول
messages[]

MessageUpdatedEventData

قائمة بالرسائل المعدّلة

MessageCreatedEventData

حمولة الحدث لرسالة جديدة

نوع الحدث: google.workspace.chat.message.v1.created

الحقول
message

Message

الرسالة الجديدة

MessageDeletedEventData

الحمولة لحدث رسالة محذوفة

نوع الحدث: google.workspace.chat.message.v1.deleted

الحقول
message

Message

الرسالة المحذوفة يتم ملء حقول name وcreateTime وdeleteTime وdeletionMetadata فقط.

MessageUpdatedEventData

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

نوع الحدث: google.workspace.chat.message.v1.updated

الحقول
message

Message

الرسالة المعدَّلة

QuotedMessageMetadata

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

الحقول
name

string

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

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

Timestamp

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

فيديو يعرض ردود فعل

تفاعل مع رسالة

الحقول
name

string

اسم المورد للتفاعل

تنسيق الملف: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

النتائج فقط. المستخدم الذي أنشأ التفاعل
emoji

Emoji

الرمز التعبيري المستخدَم في التفاعل

ReactionBatchCreatedEventData

حمولة الأحداث لتفاعلات جديدة متعددة.

نوع الحدث: google.workspace.chat.reaction.v1.batchCreated

الحقول
reactions[]

ReactionCreatedEventData

قائمة بالتفاعلات الجديدة

ReactionBatchDeletedEventData

حمولة الأحداث لتفاعلات متعددة محذوفة

نوع الحدث: google.workspace.chat.reaction.v1.batchDeleted

الحقول
reactions[]

ReactionDeletedEventData

قائمة بالتفاعلات المحذوفة

ReactionCreatedEventData

حمولة الحدث لتفاعل جديد.

نوع الحدث: google.workspace.chat.reaction.v1.created

الحقول
reaction

Reaction

التفاعل الجديد

ReactionDeletedEventData

حمولة الحدث لتفاعل محذوف.

النوع: google.workspace.chat.reaction.v1.deleted

الحقول
reaction

Reaction

التفاعل المحذوف.

RichLinkMetadata

رابط مخصّص يؤدّي إلى مرجع

الحقول
uri

string

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

RichLinkType

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

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

SearchSpacesRequest

طلب البحث عن قائمة بالمساحات استنادًا إلى طلب بحث

الحقول
use_admin_access

bool

عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاق OAuth 2.0 chat.admin.spaces.readonly أو chat.admin.spaces.

تتيح هذه الطريقة حاليًا إذن الوصول الإداري فقط، وبالتالي يتم قبول true فقط لهذا الحقل.
page_size

int32

الحد الأقصى لعدد المسافات التي سيتم عرضها قد تعرض الخدمة عددًا أقل من هذه القيمة.

وفي حال عدم تحديد قيمة هذه السمة، يتم عرض 100 مسافة كحدّ أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.
page_token

string

رمز مميّز تم استلامه من طلب مساحات البحث السابق قدِّم هذه المَعلمة لاسترداد الصفحة اللاحقة.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلمات الأخرى المقدّمة مع الاستدعاء الذي قدّم الرمز المميز للصفحة. قد يؤدي تمرير قيم مختلفة إلى المعلَمات الأخرى إلى نتائج غير متوقعة.
query

string

مطلوب. طلب بحث

يمكنك البحث باستخدام المَعلمات التالية:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

يقبل الحقلَان create_time وlast_active_time طابعًا زمنيًا بتنسيق RFC-3339، وعوامل المقارنة المتوافقة هي: = و< و> و<= و>=.

يجب إدخال customer، ويتم استخدامه للإشارة إلى العميل الذي سيتم جلب المساحات منه. customers/my_customer هي القيمة الوحيدة المسموح بها.

لا يقبل display_name سوى عامل التشغيل HAS (:). يتم أولاً تقسيم النص المطلوب مطابقته إلى وحدات ترميز، ويتم مطابقة كل وحدة ترميز مع البادئة بشكل مستقل وغير حسّاس لحالة الأحرف كسلسلة فرعية في أي مكان في display_name المساحة. على سبيل المثال، يتطابق Fun Eve مع Fun event أو The evening was fun، ولكن لا يتطابق مع notFun event أو even.

يقبل external_user_allowed إما true أو false.

لا يقبل المتغيّر space_history_state سوى القيم من حقل historyState لمورد space.

السمة space_type مطلوبة والقيمة الصالحة الوحيدة هي SPACE.

في الحقول المختلفة، يمكن استخدام AND عوامل تشغيل فقط. مثال صالح هو space_type = "SPACE" AND display_name:"Hello" ومثال غير صالح هو space_type = "SPACE" OR display_name:"Hello".

لا يتوافق عامل التشغيل space_type مع عاملَي التشغيل AND أو OR في الحقل نفسه. لا تتيح السمات display_name و"space_history_state" و"external_user_allowed" سوى عوامل التشغيل OR. يتوافق كل من last_active_time وcreate_time مع عاملَي التشغيل AND وOR. لا يمكن استخدام AND إلا لتمثيل فاصل زمني، مثل last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

طلبات البحث التالية صالحة:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

اختياريّ. كيفية ترتيب قائمة المساحات

السمات المتوافقة مع الطلب هي:

  • membership_count.joined_direct_human_user_count — يشير إلى عدد المستخدمين الذين انضموا مباشرةً إلى مساحة.
  • last_active_time: يشير إلى الوقت الذي تمت فيه إضافة آخر عنصر مؤهَّل إلى أي موضوع في هذه المساحة.
  • create_time: يشير إلى وقت إنشاء المساحة.

القيم الصالحة لعملية الطلب هي:

  • ASC تصاعديًا. القيمة التلقائية.

  • DESC للترتيب التنازلي

الصيغة المتوافقة هي:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

ردّ يتضمّن قائمة بالمساحات التي تتوافق مع طلب مساحات البحث

الحقول
spaces[]

Space

صفحة من المساحات المطلوبة.
next_page_token

string

رمز مميّز يمكن استخدامه لاسترداد الصفحة التالية. إذا كان هذا الحقل فارغًا، لن تظهر أي صفحات لاحقة.
total_size

int32

إجمالي عدد المساحات التي تتطابق مع طلب البحث في جميع الصفحات إذا كانت النتيجة أكثر من 10,000 مسافة، تكون هذه القيمة تقديرية.

SetUpSpaceRequest

يمكنك طلب إنشاء مساحة وإضافة مستخدمين محدّدين إليها.

الحقول
space

Space

مطلوب. حقل Space.spaceType مطلوب.

لإنشاء مساحة، اضبط Space.spaceType على SPACE واضبط Space.displayName. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب استخدام displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

لإنشاء محادثة جماعية، اضبط Space.spaceType على GROUP_CHAT. لا تضبط Space.displayName.

لإنشاء محادثة بين مستخدمَين، اضبط Space.spaceType على DIRECT_MESSAGE واضبط Space.singleUserBotDm على false. لا تضبط القيمة على Space.displayName أو Space.spaceDetails.

لإنشاء محادثة بين شخص وتطبيق Chat، اضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm على true. لا تضبط القيمة على Space.displayName أو Space.spaceDetails.

في حال توفُّر مساحة DIRECT_MESSAGE من قبل، سيتم عرض هذه المساحة بدلاً من إنشاء مساحة جديدة.
request_id

string

اختياريّ. معرّف فريد لهذا الطلب. يُنصح باستخدام معرّف UUID عشوائي. يؤدي تحديد رقم تعريف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى عرض رسالة خطأ.
memberships[]

Membership

اختياريّ. مستخدمو Google Chat أو المجموعات المطلوب دعوتها للانضمام إلى المساحة احذف اسم المستخدم المتصل لأنّه تتم إضافته تلقائيًا.

تتيح المجموعة حاليًا ما يصل إلى 20 اشتراكًا داعمًا (بالإضافة إلى المتصل).

بالنسبة إلى عضوية المستخدمين، يجب أن يحتوي الحقل Membership.member على user مع تعبئة name (التنسيق: users/{user}) وtype على User.Type.HUMAN. لا يمكنك إضافة مستخدمين إلا عند إعداد مساحة (لا يمكن إضافة تطبيقات Chat إلا لإعداد الرسائل المباشرة باستخدام تطبيق الاتصال). يمكنك أيضًا إضافة أعضاء باستخدام البريد الإلكتروني للمستخدم كاسم مستعار لـ {user}. على سبيل المثال، يمكن أن تكون السمة user.name هي users/example@gmail.com. لدعوة مستخدمي Gmail أو مستخدمين من نطاقات Google Workspace خارجية، يجب استخدام عنوان البريد الإلكتروني للمستخدم في {user}.

بالنسبة إلى عضوية مجموعة Google، يجب أن يحتوي الحقل Membership.group_member على group مع ملء name (التنسيق groups/{group}). لا يمكنك إضافة مجموعات Google إلا عند ضبط Space.spaceType على SPACE.

اختيارية عند ضبط Space.spaceType على SPACE.

مطلوبة عند ضبط Space.spaceType على GROUP_CHAT، مع عضويتَين على الأقل.

مطلوب عند ضبط Space.spaceType على DIRECT_MESSAGE مع مستخدم بشري، بالإضافة إلى اشتراك واحد بالضبط.

يجب أن تكون فارغة عند إنشاء محادثة بين شخص وتطبيق Chat (عند ضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm على true).

SlashCommand

أمر شرطة مائلة في Google Chat.

الحقول
command_id

int64

تم استدعاء معرّف أمر الشرطة المائلة.

SlashCommandMetadata

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

الحقول
bot

User

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

Type

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

string

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

int64

معرّف الأمر لأمر الشرطة المائلة التي تم استدعاؤها.
triggers_dialog

bool

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

النوع

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

مسافة

مساحة في Google Chat المساحات هي محادثات بين مستخدمَين أو أكثر أو رسائل بين مستخدم وتطبيق Chat.

الحقول
name

string

اسم المورد للمساحة.

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

حيث يمثّل {space} المعرّف الذي عيّنه النظام للمساحة. يمكنك الحصول على رقم تعريف المساحة من خلال طلب الطريقة spaces.list() أو من عنوان URL للمساحة. على سبيل المثال، إذا كان عنوان URL للمساحة هو https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA، يكون رقم تعريف المساحة هو AAAAAAAAA.
type
(deprecated)

Type

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

SpaceType

نوع المساحة مطلوب عند إنشاء مساحة أو تعديل نوع المساحة. الناتج فقط للاستخدامات الأخرى.
single_user_bot_dm

bool

اختياريّ. ما إذا كانت المساحة عبارة عن رسالة مباشرة بين تطبيق Chat وشخص واحد
threaded
(deprecated)

bool

النتائج فقط. متوقّفة نهائيًا: استخدِم spaceThreadingState بدلاً منها. ما إذا كانت الرسائل مُدرَجة في سلسلة محادثات في هذه المساحة
display_name

string

الاسم المعروض للمساحة. هذا الحقل مطلوب عند إنشاء مساحة باستخدام spaceType من SPACE. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة أو تعديل displayName، يُرجى تجربة displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

بالنسبة إلى الرسائل المباشرة، قد يكون هذا الحقل فارغًا.

ويدعم حتى 128 حرفًا.
external_user_allowed

bool

غير قابل للتغيير ما إذا كانت هذه المساحة تسمح لأي مستخدم في Google Chat بأن يكون عضوًا فيها الإدخال عند إنشاء مساحة في مؤسسة على Google Workspace انسَب هذا الحقل عند إنشاء المساحات في الحالات التالية:

  • يستخدم المستخدم الذي تمّت مصادقة هويته حساب مستهلك (حساب مستخدم غير مُدار). تسمح المساحة التي أنشأها حساب مستهلك تلقائيًا لأي مستخدم في Google Chat بالانضمام إليها.

بالنسبة إلى المساحات الحالية، يكون هذا الحقل مخصّصًا للعرض فقط.
space_threading_state

SpaceThreadingState

النتائج فقط. حالة سلاسل المحادثات في "مساحة Chat"
space_details

SpaceDetails

تفاصيل حول المساحة بما في ذلك الوصف والقواعد.
space_history_state

HistoryState

حالة سجلّ الرسائل للرسائل وسلاسل المحادثات في هذه المساحة
import_mode

bool

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

يتطلب إنشاء مساحة في Import Mode مصادقة المستخدم.
create_time

Timestamp

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

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

لا تتم تعبئة هذا الحقل في الإخراج إلا عندما يكون spaceType هو GROUP_CHAT أو SPACE.
last_active_time

Timestamp

النتائج فقط. الطابع الزمني لآخر رسالة في المساحة

admin_installed

bool

النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة (DM) التي تتضمّن تطبيق Chat، سواء أنشأ مشرف Google Workspace المساحة أم لا. يمكن للمشرفين تثبيت رسالة مباشرة وإعدادها باستخدام تطبيق Chat نيابةً عن المستخدمين في مؤسستهم.

لإتاحة التثبيت من خلال المشرف، يجب أن يتضمّن تطبيق Chat ميزة الرسائل المباشرة.
membership_count

MembershipCount

النتائج فقط. عدد العضويات التي تم الانضمام إليها مجمّعة حسب نوع العضو تتم تعبئة هذا الحقل عند ضبط space_type على SPACE أو DIRECT_MESSAGE أو GROUP_CHAT.

access_settings

AccessSettings

اختياريّ. تُحدِّد إعدادات الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما يكون space_type هو SPACE.
space_uri

string

النتائج فقط. معرّف الموارد المتسلسل (URI) للمستخدم للوصول إلى المساحة
customer

string

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

بالتنسيق customers/{customer}، حيث يشير customer إلى id من [مرجع العملاء في "SDK للمشرف"]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المعرِّف customers/my_customer لإنشاء المساحة في مؤسسة Google Workspace نفسها التي ينتمي إليها التطبيق.

لا تتم تعبئة هذا الحقل للرسائل المباشرة.

حقل الاتحاد space_permission_settings. يمثّل هذا الإعداد إعدادات الأذونات للمساحة. لا تتم تعبئة هذا الحقل إلا عندما يكون space_type هو SPACE.

يتطلب مصادقة المستخدم. يمكن أن يكون space_permission_settings واحدًا فقط مما يلي:
predefined_permission_settings

PredefinedPermissionSettings

اختياريّ. الإدخال فقط إعدادات أذونات المساحة المحدّدة مسبقًا، لا يتم إدخالها إلا عند إنشاء مساحة. وفي حال عدم ضبط الحقل، سيتم إنشاء مساحة تعاون. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل PermissionSettings.
permission_settings

PermissionSettings

اختياريّ. إعدادات أذونات المساحة للمساحات الحالية إدخال لتعديل إعدادات أذونات المساحة الدقيقة، حيث يتم استبدال إعدادات الأذونات الحالية يسرد الإخراج إعدادات الأذونات الحالية.

AccessSettings

يمثّل إعداد الوصول للمساحة.

الحقول
access_state

AccessState

النتائج فقط. يشير إلى حالة الوصول إلى المساحة.
audience

string

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

تنسيق الملف: audiences/{audience}

لاستخدام الجمهور المستهدَف التلقائي لمؤسّسة Google Workspace، اضبط القيمة على audiences/default.

تتيح قراءة الجمهور المستهدَف ما يلي:

لا يتمّ ملء هذا الحقل عند استخدام نطاق chat.bot مع مصادقة التطبيق.

يتطلّب تحديد الجمهور المستهدَف مصادقة المستخدم.

AccessState

يمثل حالة الوصول إلى المساحة.

عمليات التعداد
ACCESS_STATE_UNSPECIFIED حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه.
PRIVATE لا يمكن للمستخدمين أو مجموعات Google الذين تمت إضافتهم أو دعوتهم بشكل فردي من قِبل مستخدمين آخرين أو مشرفي Google Workspace سوى اكتشاف المساحة والوصول إليها.
DISCOVERABLE

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

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

MembershipCount

يمثل هذا العدد عدد العضويات في مساحة، مجمَّعة ضمن فئات.

الحقول
joined_direct_human_user_count

int32

عدد المستخدمين الذين انضموا مباشرةً إلى المساحة، ولا يتم احتساب عدد المستخدمين الذين انضموا من خلال العضوية في مجموعة
joined_group_count

int32

عدد جميع المجموعات التي انضمت إلى المساحة مباشرةً

PermissionSetting

يمثّل هذا الإعداد إعدادًا لإذن المساحة.

الحقول
managers_allowed

bool

ما إذا كان لدى مدراء المساحات هذا الإذن
members_allowed

bool

ما إذا كان الأعضاء غير الإداريين لديهم هذا الإذن أم لا.

PermissionSettings

إعدادات الأذونات التي يمكنك تحديدها عند تعديل مساحة مُسمّاة حالية

لضبط إعدادات الأذونات عند إنشاء مساحة، حدِّد حقل PredefinedPermissionSettings في طلبك.

الحقول
manage_members_and_groups

PermissionSetting

إعدادات لإدارة الأعضاء والمجموعات في مساحة
modify_space_details

PermissionSetting

إعدادات لتعديل اسم المساحة وصورتها الرمزية ووصفها وإرشاداتها
toggle_history

PermissionSetting

إعداد لتفعيل سجلّ المساحة وإيقافه
use_at_mention_all

PermissionSetting

إعدادات استخدام @all في مساحة
manage_apps

PermissionSetting

إعدادات إدارة التطبيقات في مساحة
manage_webhooks

PermissionSetting

إعداد لإدارة روابط الردّ التلقائي على الويب في مساحة
post_messages

PermissionSetting

النتائج فقط. إعدادات نشر الرسائل في مساحة
reply_messages

PermissionSetting

إعداد للرد على الرسائل في مساحة

PredefinedPermissionSettings

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

عمليات التعداد
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED غير محدد يُرجى عدم استخدامها.
COLLABORATION_SPACE إعداد لجعل المساحة مساحة تعاونية حيث يمكن لجميع الأعضاء نشر الرسائل
ANNOUNCEMENT_SPACE إعداد لجعل المساحة مساحة إعلانية حيث يمكن فقط لمدراء المساحة نشر الرسائل

SpaceDetails

تفاصيل حول المساحة بما في ذلك الوصف والقواعد.

الحقول
description

string

اختياريّ. وصف للمساحة. على سبيل المثال، يمكنك وصف موضوع مناقشة المساحة أو الغرض الوظيفي أو المشاركين.

يمكن استخدام 150 حرفًا كحدّ أقصى.
guidelines

string

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

يمكن استخدام ما يصل إلى 5,000 حرف.

SpaceThreadingState

تُحدِّد هذه السياسة نوع حالة سلاسل المحادثات في مساحة Chat.

عمليات التعداد
SPACE_THREADING_STATE_UNSPECIFIED محجوز.
THREADED_MESSAGES المساحات المُعنونة التي تتيح سلاسل الرسائل عندما يردّ المستخدمون على رسالة، يمكنهم الردّ في سلسلة المحادثات، ما يحافظ على ردّهم في سياق الرسالة الأصلية.
GROUPED_MESSAGES مساحات مُسمّاة يتم تنظيم المحادثة فيها حسب الموضوع ويتم تجميع المواضيع وردودها معًا.
UNTHREADED_MESSAGES الرسائل المباشرة بين شخصَين والمحادثات الجماعية بين 3 أشخاص أو أكثر

SpaceType

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

عمليات التعداد
SPACE_TYPE_UNSPECIFIED محجوز.
SPACE مكان يمكن للأشخاص من خلاله إرسال الرسائل ومشاركة الملفات والتعاون معهم. يمكن أن يتضمّن SPACE تطبيقات Chat.
GROUP_CHAT محادثات جماعية بين 3 أشخاص أو أكثر. يمكن أن يتضمّن GROUP_CHAT تطبيقات Chat.
DIRECT_MESSAGE الرسائل بين شخصَين أو بين شخص وتطبيق Chat

النوع

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

عمليات التعداد
TYPE_UNSPECIFIED محجوز.
ROOM محادثات بين شخصين أو أكثر
DM رسالة مباشرة بين مستخدم وتطبيق Chat، تكون فيها جميع الرسائل مسطحة يُرجى العلم أنّ هذا الخيار لا يشمل الرسائل المباشرة بين شخصين.

SpaceBatchUpdatedEventData

حمولة الأحداث لإجراء تعديلات متعددة على مساحة

نوع الحدث: google.workspace.chat.space.v1.batchUpdated

الحقول
spaces[]

SpaceUpdatedEventData

قائمة بالمساحات المعدَّلة

SpaceEvent

حدث يمثّل تغييرًا أو نشاطًا في مساحة على Google Chat لمزيد من المعلومات، راجِع مقالة العمل مع الأحداث من Google Chat.

الحقول
name

string

اسم مورد الحدث في المساحة

تنسيق الملف: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

الوقت الذي وقع فيه الحدث
event_type

string

نوع حدث المساحة يحتوي كل نوع من أنواع الأحداث على نسخة مجمّعة تمثّل تكرارات متعددة من نوع الحدث الذي يقع في فترة زمنية قصيرة. بالنسبة إلى طلبات spaceEvents.list()، احذف أنواع الأحداث المجمّعة في فلتر طلبات البحث. يعرض الخادم تلقائيًا نوع الحدث ونسخة الحزمة.

أنواع الأحداث المتوافقة مع الرسائل:

  • رسالة جديدة: google.workspace.chat.message.v1.created
  • الرسالة المعدَّلة: google.workspace.chat.message.v1.updated
  • رسالة محذوفة: google.workspace.chat.message.v1.deleted
  • رسائل جديدة متعددة: google.workspace.chat.message.v1.batchCreated
  • رسائل متعددة تم تعديلها: google.workspace.chat.message.v1.batchUpdated
  • رسائل محذوفة متعددة: google.workspace.chat.message.v1.batchDeleted

أنواع الأحداث المتوافقة مع الاشتراكات:

  • عضوية جديدة: google.workspace.chat.membership.v1.created
  • العضوية المعدَّلة: google.workspace.chat.membership.v1.updated
  • العضوية المحذوفة: google.workspace.chat.membership.v1.deleted
  • اشتراكات جديدة متعددة: google.workspace.chat.membership.v1.batchCreated
  • العضويات المعدَّلة المتعددة: google.workspace.chat.membership.v1.batchUpdated
  • عدة عضويات محذوفة: google.workspace.chat.membership.v1.batchDeleted

أنواع الأحداث المتوافقة مع التفاعلات:

  • تفاعل جديد: google.workspace.chat.reaction.v1.created
  • التفاعل المحذوف: google.workspace.chat.reaction.v1.deleted
  • تفاعلات متعددة جديدة: google.workspace.chat.reaction.v1.batchCreated
  • تفاعلات متعدّدة محذوفة: google.workspace.chat.reaction.v1.batchDeleted

أنواع الأحداث المتوافقة مع المساحة:

  • المساحة التي تم تعديلها: google.workspace.chat.space.v1.updated
  • تعديلات متعددة على المساحة: google.workspace.chat.space.v1.batchUpdated

حقل الربط payload

يمكن أن يكون payload واحدًا فقط مما يلي:
message_created_event_data

MessageCreatedEventData

الحمولة للحدث لرسالة جديدة.

نوع الحدث: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

حمولة الحدث لرسالة معدَّلة

نوع الحدث: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

حمولة الحدث لرسالة محذوفة

نوع الحدث: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

حمولة الحدث للرسائل الجديدة المتعددة

نوع الحدث: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

الحمولة للحدث لعدة رسائل معدَّلة

نوع الحدث: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

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

نوع الحدث: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

حمولة الأحداث لتعديل المساحة

نوع الحدث: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

الحمولة للحدث لإجراء تعديلات متعدّدة على مساحة

نوع الحدث: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

حمولة الأحداث لعضوية جديدة.

نوع الحدث: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

حمولة الحدث لعضوية معدّلة

نوع الحدث: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

حمولة الحدث لعضوية محذوفة.

نوع الحدث: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

الحمولة في الحدث لعدة اشتراكات جديدة

نوع الحدث: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

حمولة الأحداث لعدة عضويات تم تعديلها.

نوع الحدث: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

الحمولة في الحدث لعدة عضويات تم حذفها

نوع الحدث: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

حمولة الحدث لتفاعل جديد.

نوع الحدث: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

حمولة الحدث لتفاعل محذوف.

نوع الحدث: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

حمولة الأحداث لتفاعلات جديدة متعددة.

نوع الحدث: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

الحمولة للحدث لعدة تفاعلات محذوفة

نوع الحدث: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

إعدادات الإشعارات لمستخدم في مساحة

الحقول
name

string

المُعرّف. اسم المورد لإعدادات إشعارات المساحة. التنسيق: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting

NotificationSetting

إعدادات الإشعارات
mute_setting

MuteSetting

إعداد كتم صوت إشعارات المساحة

MuteSetting

أنواع إعدادات كتم صوت إشعارات المساحة

عمليات التعداد
MUTE_SETTING_UNSPECIFIED محجوز.
UNMUTED سيتلقّى المستخدم إشعارات بشأن المساحة استنادًا إلى إعدادات الإشعارات.
MUTED لن يتلقى المستخدم أي إشعارات للمساحة، بغض النظر عن إعداد الإشعارات.

NotificationSetting

أنواع إعدادات الإشعارات

عمليات التعداد
NOTIFICATION_SETTING_UNSPECIFIED محجوز.
ALL يتم تشغيل الإشعارات من خلال الإشارات باستخدام @وسلاسل المحادثات التي تتم متابعتها والرسالة الأولى من سلاسل المحادثات الجديدة. تتم متابعة جميع سلاسل المحادثات الجديدة تلقائيًا، ما لم يلغِ المستخدم متابعتها يدويًا.
MAIN_CONVERSATIONS يتم تشغيل الإشعار من خلال الإشارات باستخدام @وسلاسل المحادثات التي تتم متابعتها والرسالة الأولى من سلاسل المحادثات الجديدة. لا تتوفّر هذه الميزة للرسائل المباشرة بين شخصَين.
FOR_YOU يتم تشغيل الإشعار من خلال الإشارات باستخدام @ وسلاسل المحادثات التي تتم متابعتها. لا تتوفّر هذه الميزة للرسائل المباشرة بين شخصَين.
OFF تم إيقاف الإشعار.

SpaceReadState

حالة قراءة المستخدم ضمن مساحة، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة.

الحقول
name

string

اسم المورد لحالة القراءة في المساحة

التنسيق: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

اختياريّ. الوقت الذي تم فيه تعديل حالة قراءة مساحة المستخدم ويتوافق ذلك عادةً مع الطابع الزمني لآخر رسالة تمت قراءتها، أو الطابع الزمني الذي حدّده المستخدم لتحديد موضع القراءة الأخير في مساحة.

SpaceUpdatedEventData

الحمولة للحدث لمساحة معدَّلة

نوع الحدث: google.workspace.chat.space.v1.updated

الحقول
space

Space

المساحة المعدّلة

Thread

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

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

الحقول
name

string

اسم مورد سلسلة المحادثات

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

string

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

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

ThreadReadState

حالة قراءة المستخدم ضمن سلسلة محادثات، تُستخدَم لتحديد الرسائل المقروءة وغير المقروءة.

الحقول
name

string

اسم المورد لحالة قراءة سلسلة المحادثات

تنسيق الملف: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

الوقت الذي تم فيه تعديل حالة قراءة سلسلة محادثات المستخدم يتجاوب هذا عادةً مع الطابع الزمني لآخر رسالة مقروءة في سلسلة المحادثات.

UpdateMembershipRequest

رسالة طلب لتعديل اشتراك

الحقول
membership

Membership

مطلوب. الاشتراك المطلوب تعديله لا يتم تعديل سوى الحقول المحدّدة بواسطة update_mask.
update_mask

FieldMask

مطلوب. مسارات الحقول التي سيتم تعديلها افصل بين القيم المتعدّدة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول.

مسارات الحقول المتوافقة حاليًا:

  • role
use_admin_access

bool

عند true، يتم تشغيل الطريقة باستخدام امتيازات مشرف Google Workspace للمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب chat.admin.memberships نطاق OAuth 2.0.

UpdateMessageRequest

طلب تعديل رسالة

الحقول
message

Message

مطلوب. تم تعديل رسالة تحتوي على حقول.
update_mask

FieldMask

مطلوب. مسارات الحقول التي سيتم تعديلها افصل القيم المتعدّدة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول.

مسارات الحقول المتوافقة حاليًا:
allow_missing

bool

اختياريّ. في حال عدم العثور على true والرسالة، يتم إنشاء رسالة جديدة ويتم تجاهل updateMask. يجب أن يكون معرّف الرسالة المحدّد client-assigned وإلا سيتعذّر تنفيذ الطلب.

UpdateSpaceNotificationSettingRequest

طلب تعديل إعدادات الإشعارات في المساحة لا تتوافق هذه الميزة إلا مع تعديل إعدادات الإشعارات للمستخدم المتصل.

الحقول
space_notification_setting

SpaceNotificationSetting

مطلوب. يجب ملء اسم المورد لإعدادات الإشعارات الخاصة بالمساحة بالصيغة users/{user}/spaces/{space}/spaceNotificationSetting. يتم تعديل الحقول التي يحدِّدها update_mask فقط.
update_mask

FieldMask

مطلوب. مسارات الحقول المتوافقة: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

طلب رسالة لواجهة برمجة تطبيقات UpdateSpaceReadState.

الحقول
space_read_state

SpaceReadState

مطلوب. حالة قراءة المساحة والحقول المطلوب تعديلها.

لا تتوافق هذه الميزة إلا مع تعديل حالة القراءة للمستخدم المتصل.

للإشارة إلى المستخدم المتصل، اضبط أحد الخيارَين التاليَين:

  • العنوان البديل للبريد الإلكتروني me مثلاً: users/me/spaces/{space}/spaceReadState

  • عنوان البريد الإلكتروني في Workspace مثلاً: users/user@example.com/spaces/{space}/spaceReadState

  • رقم تعريف المستخدم مثلاً: users/123456789/spaces/{space}/spaceReadState

التنسيق: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

مطلوب. مسارات الحقول التي سيتم تعديلها مسارات الحقول المتوافقة حاليًا:

  • last_read_time

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

لوضع علامة "تمت القراءة" على المساحة، اضبط last_read_time على أي قيمة لاحقة (أكبر) من وقت إنشاء آخر رسالة. تم فرض قيمة last_read_time لمطابقة أحدث وقت لإنشاء الرسالة. يُرجى ملاحظة أنّ حالة قراءة المساحة تؤثر فقط في حالة قراءة الرسائل التي تظهر في المحادثة ذات المستوى الأعلى في المساحة. لا تتأثر الردود في سلاسل المحادثات بهذا الطابع الزمني، بل تعتمد بدلاً من ذلك على حالة قراءة سلسلة المحادثات.

UpdateSpaceRequest

طلب لتعديل مساحة واحدة

الحقول
space

Space

مطلوب. مساحة تحتوي على حقول ستتمّ مراجعتها يجب تعبئة Space.name على شكل spaces/{space}. لا يتم تعديل سوى الحقول المحدّدة بواسطة update_mask.
update_mask

FieldMask

مطلوب. مسارات الحقول المعدّلة، مفصولة بفواصل في حال توفّر عدة مسارات

يمكنك تعديل الحقول التالية للمساحة:

space_details: تعديل وصف المساحة يمكن استخدام أكثر من 150 حرفًا.

display_name: لا تتيح هذه القيمة تعديل الاسم المعروض إلا للمساحات التي يكون فيها الحقل spaceType هو SPACE. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS، جرِّب قيمة مختلفة. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

space_type: لا تتيح سوى تغيير نوع مساحة GROUP_CHAT إلى SPACE. يُرجى تضمين display_name مع space_type في قناع التحديث والتأكّد من أنّ المساحة المحدّدة لها اسم معروض غير فارغ ونوع المساحة SPACE. إنّ تضمين قناع space_type ونوع SPACE في المساحة المحدّدة عند تعديل الاسم المعروض اختياري إذا كانت المساحة الحالية تتضمّن نوع SPACE. تؤدي محاولة تعديل نوع المساحة بطرق أخرى إلى ظهور خطأ وسيطة غير صالح. لا يمكن استخدام space_type مع useAdminAccess.

space_history_state: لتعديل إعدادات سجلّ المساحات عن طريق تفعيل السجلّ أو إيقافه للمساحة. لا يتوفّر هذا الخيار إلا إذا كانت إعدادات السجلّ مفعّلة لمؤسسة Google Workspace. لتعديل حالة سجلّ المساحة، يجب حذف جميع أقنعة الحقول الأخرى في طلبك. لا يمكن استخدام space_history_state مع useAdminAccess.

access_settings.audience: يعدِّل إعدادات الوصول للمستخدمين الذين يمكنهم اكتشاف المساحة والانضمام إلى المساحة ومعاينة الرسائل في المساحة المُعنوَنة حيث يكون الحقل spaceType SPACE. إذا كانت المساحة الحالية تتضمّن جمهورًا مستهدفًا، يمكنك إزالة الجمهور وحصر الوصول إلى المساحة عن طريق حذف قيمة لقناع الحقل هذا. لتعديل إعدادات الوصول إلى مساحة، يجب أن يكون المستخدم المصادق مدير مساحة وأن يحذف جميع أقنعة الحقول الأخرى في طلبك. لا يمكنك تعديل هذا الحقل إذا كانت المساحة في وضع الاستيراد. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة جعل مساحة قابلة للاكتشاف من مستخدمين محدّدين. لا يمكن استخدام access_settings.audience مع useAdminAccess.

permission_settings: تتيح تغيير إعدادات الأذونات للمساحة. عند تعديل إعدادات الأذونات، يمكنك فقط تحديد أقنعة حقل permissionSettings، ولا يمكنك تعديل أقنعة حقول أخرى في الوقت نفسه. لا يمكن استخدام permissionSettings مع useAdminAccess. تشمل أقنعة الحقول المتوافقة ما يلي:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

عند true، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم.

يجب أن يكون المستخدم المتصل مشرفًا في Google Workspace لديه امتياز إدارة المحادثات في Chat وفي "المساحات".

يتطلب نطاق OAuth 2.0 chat.admin.spaces.

بعض قيم FieldMask غير متاحة عند استخدام إذن الوصول الإداري. لمعرفة التفاصيل، يُرجى الاطّلاع على وصف "update_mask".

مستخدم

مستخدم في Google Chat عند عرضها كنتيجة من طلب، إذا كان تطبيق Chat يُثبِّت هويته كمستخدم، لا تملأ نتيجة مورد User سوى name وtype للمستخدم.

الحقول
name

string

اسم المورد لـ user في Google Chat.

التنسيق: users/{user} يمكن استخدام "users/app" كاسم مستعار لتطبيق الاتصال bot.

بالنسبة إلى human users، يكون {user} هو معرّف المستخدم نفسه مثل:

  • id لـ Person في People API. على سبيل المثال، يمثّل users/123456789 في Chat API المستخدم نفسه الذي يمثّله 123456789 رقم تعريف الملف الشخصي للمستخدم في People API.

  • id لـ مستخدم في Admin SDK Directory API

  • يمكن استخدام عنوان البريد الإلكتروني الخاص بالمستخدم كعنوان بديل للبريد الإلكتروني {user} في طلبات البيانات من واجهة برمجة التطبيقات. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي لمستخدم user@example.com في People API هو 123456789، يمكنك استخدام users/user@example.com كاسم بديل للإشارة إلى users/123456789. ولن يتم عرض سوى اسم المورد الأساسي (على سبيل المثال users/123456789) من واجهة برمجة التطبيقات.
display_name

string

النتائج فقط. الاسم المعروض للمستخدم
domain_id

string

المعرّف الفريد لنطاق المستخدم على Google Workspace
type

Type

نوع المستخدِم.
is_anonymous

bool

النتائج فقط. عند true، يتم حذف المستخدم أو لا يظهر ملفه الشخصي.

النوع

عمليات التعداد
TYPE_UNSPECIFIED القيمة التلقائية لقائمة القيم المحدّدة يُرجى عدم استخدامها.
HUMAN مستخدم بشري.
BOT مستخدم تطبيق Chat

UserMentionMetadata

البيانات الوصفية للتعليق التوضيحي لذكر المستخدمين (@)

الحقول
user

User

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

Type

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

النوع

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

WidgetMarkup

التطبيق المصغّر هو عنصر واجهة مستخدم يعرض النصوص والصور.

الحقول
buttons[]

Button

قائمة بالأزرار الأزرار أيضًا oneof data ويجب ضبط حقل واحد فقط من هذه الحقول.
حقل الربط data لا يمكن أن يتضمّن WidgetMarkup سوى أحد العناصر التالية. يمكنك استخدام عدة حقول WidgetMarkup لعرض المزيد من العناصر. يمكن أن يكون data واحدًا فقط مما يلي:
text_paragraph

TextParagraph

عرض فقرة نصية في هذه الأداة المصغّرة
image

Image

يمكنك عرض صورة في هذا التطبيق المصغّر.
key_value

KeyValue

عرض عنصر مفتاح/قيمة في هذه الأداة المصغّرة

زرّ

زر يمكن أن يكون زرًا نصيًا أو زرًا مزوّدًا بصورة.

الحقول

حقل الربط type

يمكن أن يكون type واحدًا فقط مما يلي:
text_button

TextButton

زر يحتوي على نص وإجراء onclick.
image_button

ImageButton

زر يتضمّن صورة وإجراء onclick

FormAction

يصف إجراء النموذج السلوك عند إرسال النموذج. على سبيل المثال، يمكنك استدعاء Apps Script لمعالجة النموذج.

الحقول
action_method_name

string

يُستخدَم اسم الطريقة لتحديد الجزء من النموذج الذي أدّى إلى إرسال النموذج. تتم إعادة هذه المعلومات إلى تطبيق Chat كجزء من حدث النقر على البطاقة. يمكنك استخدام اسم الطريقة نفسه لعدة عناصر تؤدي إلى سلوك شائع.
parameters[]

ActionParameter

قائمة مَعلمات الإجراء

ActionParameter

قائمة بمعلَمات السلسلة التي سيتم تقديمها عند استدعاء طريقة الإجراء. على سبيل المثال، يمكنك التفكير في ثلاثة أزرار للتأجيل الآن، وتأجيل يوم واحد، وتأجيل من الأسبوع القادم. يمكنك استخدام action method = snooze()، مع تمرير نوع الغفوة ووقت الغفوة في قائمة مَعلمات السلاسل.

الحقول
key

string

اسم مَعلمة النص البرمجي للإجراء.
value

string

قيمة المَعلمة

الرمز

تمثّل هذه السمة مجموعة الرموز المتوافقة.

عمليات التعداد
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

صورة

صورة يتم تحديدها من خلال عنوان URL ويمكن أن تتضمّن إجراءً من النوع onclick

الحقول
image_url

string

عنوان URL للصورة
on_click

OnClick

إجراء onclick.
aspect_ratio

double

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

ImageButton

زر صورة يتضمّن إجراءً onclick

الحقول
on_click

OnClick

الإجراء onclick
name

string

اسم image_button هذا المستخدَم لتسهيل الاستخدام يتم توفير القيمة التلقائية في حال عدم تحديد هذا الاسم.
حقل الاتحاد icons. يمكن تحديد الرمز باستخدام Icon enum أو عنوان URL. يمكن أن يكون icons واحدًا فقط مما يلي:
icon

Icon

الرمز المحدّد بواسطة enum الذي يشير إلى رمز يوفّره Chat API
icon_url

string

هو الرمز الذي يتم تحديده من خلال عنوان URL.

KeyValue

يحتوي عنصر واجهة المستخدم على مفتاح (تصنيف) وقيمة (محتوى). يمكن أن يحتوي هذا العنصر أيضًا على بعض الإجراءات مثل الزر onclick.

الحقول
top_label

string

نص التصنيف العلوي. يمكن استخدام النص المنسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على مقالتَي تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
content

string

نص المحتوى يجب استخدام نص منسّق في كل الأوقات. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على المقالتَين تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
content_multiline

bool

ما إذا كان يجب أن يكون المحتوى متعدد الأسطر.
bottom_label

string

نص التصنيف السفلي النص المنسّق مسموح به. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على المقالتَين تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.
on_click

OnClick

إجراء onclick. لا يمكن النقر إلا على التصنيف العلوي والتصنيف السفلي ومنطقة المحتوى.
حقل الاتحاد icons. يجب تحديد رمز واحد على الأقل من الرموز top_label وbottom_label. يمكن أن يكون icons واحدًا فقط مما يلي:
icon

Icon

قيمة مصنّفة تم استبدالها من خلال Chat API بصورة الرمز المعنيّ.
icon_url

string

الرمز المحدّد من خلال عنوان URL
حقل الربط control تطبيق مصغّر للتحكّم يمكنك ضبط button أو switch_widget، ولكن ليس كليهما. يمكن أن يكون control واحدًا فقط مما يلي:
button

Button

زر يمكن النقر عليه لبدء إجراء

OnClick

إجراء onclick (على سبيل المثال، فتح رابط).

الحقول

حقل الاتحاد data.

يمكن أن يكون data واحدًا فقط مما يلي:
action

FormAction

يتم بدء إجراء نموذج من خلال إجراء onclick هذا إذا تم تحديده.

TextButton

زر يحتوي على نص وإجراء onclick.

الحقول
text

string

النص المكتوب على الزر.
on_click

OnClick

الإجراء onclick للزر.

TextParagraph

فقرة من النص يمكن استخدام النص المنسَّق. لمزيد من المعلومات عن تنسيق النص، يُرجى الاطّلاع على مقالتَي تنسيق النص في تطبيقات Google Chat وتنسيق النص في إضافات Google Workspace.

الحقول
text

string