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)

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

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

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

يعتمد اشتراك المساحة عند إنشائها على ما إذا تم إنشاء المساحة في Import mode:

  • وضع الاستيراد: لا يتم إنشاء أي أعضاء.
  • جميع الأوضاع الأخرى: تتم إضافة المستخدم المتصل كعضو. وهي:
    • التطبيق نفسه عند استخدام مصادقة التطبيق
    • المستخدم البشري عند استخدام مصادقة المستخدم

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

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

يتطلب أحد نطاقات 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 الوصول إليها، ولكنّه يستثني الاشتراكات في تطبيق 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

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

CardHeader

الحقول
title

string

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

string

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

ImageStyle

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

string

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

ImageStyle

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

القسم

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

الحقول
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. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم user@example.com في People API هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/user@example.com أو users/123456789.

تتطلّب دعوة مستخدمين من خارج مؤسسة Workspace التي تملك المساحة مصادقة المستخدم.

عندما ينشئ تطبيق 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 وSpaceType.GROUP_CHAT. لا يمكن استخدام SpaceType.GROUP_CHAT إلا إذا تم ضبط importMode على "صحيح".

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

يتم تخصيص المساحة 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.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 وفي "المساحات".

تتطلّب هذه الوظيفة chat.admin.memberships نطاق OAuth 2.0.

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

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

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

التنسيق: spaces/{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 وفي "المساحات".

يتطلب هذا الحقل إما chat.admin.memberships.readonly أو chat.admin.memberships نطاق OAuth 2.0.

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

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: ولا ينطبق ذلك على رموز الإيموجي بتنسيق Unicode، مثل 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 API باستخدام مصادقة التطبيق وحذف ما يلي:

لمعرفة التفاصيل، يُرجى الاطّلاع على إرسال رسالة بشكل خاص.
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 وفي "المساحات".

يتطلب هذا الحقل إما chat.admin.spaces.readonly أو chat.admin.spaces نطاق OAuth 2.0.

لا تتيح هذه الطريقة حاليًا سوى إذن وصول المشرف، وبالتالي لا يتم قبول سوى 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

النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة التي تتضمّن تطبيق 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) للمستخدم للوصول إلى المساحة
import_mode_expire_time

Timestamp

النتائج فقط. الوقت الذي سيحذف فيه النظام المساحة تلقائيًا إذا بقيت في وضع الاستيراد

يجب أن تخرج كل مساحة تم إنشاؤها في وضع الاستيراد من هذا الوضع قبل انتهاء صلاحيته باستخدام spaces.completeImport.

لا تتم تعبئة هذا الحقل إلا للمساحات التي تم إنشاؤها باستخدام وضع الاستيراد.
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 آخر، حدِّد حقل سلسلة المحادثات 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. يجب أن يكون معرّف الرسالة المحدّد من تحديد العميل وإلا سيتعذّر تنفيذ الطلب.

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 وفي "المساحات".

تتطلّب هذه الوظيفة chat.admin.spaces نطاق OAuth 2.0.

لا تتوفّر بعض قيم FieldMask باستخدام إذن وصول المشرف. لمعرفة التفاصيل، يُرجى الاطّلاع على وصف update_mask.

المستخدم

مستخدم في Google Chat عند عرضها كنتيجة من طلب، إذا كان تطبيق Chat يُثبِّت هويته كمستخدم، لا تملأ نتيجة مورد User سوى name وtype للمستخدم.

الحقول
name

string

اسم المورد لـ user في Google Chat

التنسيق: users/{user} يمكن استخدام users/app كاسم بديل لمستخدم تطبيق الاتصال bot.

بالنسبة إلى human users، يكون {user} هو معرّف المستخدم نفسه في ما يلي:

  • ‫id لعنصر المستخدم في 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

قائمة بالأزرار Buttons هو أيضًا 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