Package google.chat.v1

الفهرس

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

يتطلّب ذلك مصادقة المستخدم والتفويض على مستوى النطاق باستخدام نطاق التفويض:

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

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

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

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

لإنشاء إيموجي مخصّص

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.customemojis
نطاقات الأذونات

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (لإضافة تطبيق الاتصال إلى المساحة)
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام نطاق التفويض التالي:
      • https://www.googleapis.com/auth/chat.admin.memberships

لا تتوفّر مصادقة التطبيقات لحالات الاستخدام التالية:

  • دعوة مستخدمين خارجيين إلى مؤسسة Workspace التي تملك المساحة
  • إضافة "مجموعة 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. للاطّلاع على مثال، يُرجى مراجعة إرسال رسالة.

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

  • مصادقة التطبيق مع نطاق التفويض:
    • https://www.googleapis.com/auth/chat.bot
  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)

ينسب Chat مُرسِل الرسالة بشكل مختلف استنادًا إلى نوع المصادقة التي تستخدمها في طلبك.

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

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

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

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

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

بالنسبة إلى طلبات webhook، لا يحتوي الردّ على الرسالة الكاملة. يملأ الردّ الحقلَين name وthread.name فقط بالإضافة إلى المعلومات التي كانت في الطلب.

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

يتطلب أحد نطاقات 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

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

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

تثبيت رسالة

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
نطاقات الأذونات

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

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

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

تنشئ تفاعلاً وتضيفه إلى رسالة. للاطّلاع على مثال، يُرجى مراجعة إضافة تفاعل إلى رسالة.

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
نطاقات الأذونات

يتطلب أحد نطاقات 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

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

rpc CreateSection(CreateSectionRequest) returns (Section)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
نطاقات الأذونات

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

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

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف وأحد نطاقات التفويض التالية:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)

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

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

تعتمد عضوية المساحة عند إنشائها على ما إذا تم إنشاء المساحة في 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)

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

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.customemojis
نطاقات الأذونات

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.memberships.app (لإزالة تطبيق الاتصال من المساحة)
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام نطاق التفويض التالي:
      • https://www.googleapis.com/auth/chat.admin.memberships

لا تتوفّر مصادقة التطبيقات لحالات الاستخدام التالية:

  • إزالة "مجموعة Google" من مساحة
  • إزالة تطبيق Chat من مساحة

لحذف اشتراكات مدراء المساحات، يجب أن يكون مقدّم الطلب مدير مساحة. إذا كنت تستخدم مصادقة التطبيق، يجب أن يكون تطبيق 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)

لحذف رسالة للاطّلاع على مثال، يُرجى مراجعة حذف رسالة.

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

  • مصادقة التطبيق باستخدام نطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)

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

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

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

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

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

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

تحذف هذه الطريقة رسالة مثبّتة.

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces
نطاقات الأذونات

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

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

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

تحذف هذه الطريقة تفاعلاً مع رسالة. للاطّلاع على مثال، يُرجى مراجعة حذف تفاعل.

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
نطاقات الأذونات

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

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

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

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

يؤدي هذا الإجراء إلى حذف قسم من النوع CUSTOM_SECTION.

إذا كان القسم يحتوي على عناصر، مثل المساحات، يتم نقل العناصر إلى الأقسام التلقائية في Google Chat ولا يتم حذفها.

لمعرفة التفاصيل، يُرجى الاطّلاع على كيفية إنشاء أقسام وتنظيمها في Google Chat.

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
نطاقات الأذونات

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

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

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض:

    • ‫https://www.googleapis.com/auth/chat.app.delete (في المساحات التي أنشأها التطبيق فقط)

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.delete
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام نطاق التفويض التالي:
      • https://www.googleapis.com/auth/chat.admin.delete
نطاقات الأذونات

يتطلب أحد نطاقات 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 الذي يرسل الطلب.

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

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

  • مصادقة التطبيق باستخدام نطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
نطاقات الأذونات

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

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

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

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

تعرض هذه الطريقة جميع المساحات التي تتضمّن spaceType == GROUP_CHAT، والتي تحتوي عضوياتها البشرية على المستخدم الذي يجري الطلب والمستخدمين المحدّدين في FindGroupChatsRequest.users. يمكن فقط للأعضاء الذين انضموا إلى المحادثة استخدام هذه الميزة. للاطّلاع على مثال، يُرجى مراجعة العثور على المحادثات الجماعية.

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

يجب أن تحتوي مجموعة المستخدمين المحدّدة على عضويات بشرية (غير تابعة للتطبيقات) فقط. لا يعرض الطلب الذي يتضمّن مستخدمين غير بشريين أي مساحات.

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships
نطاقات الأذونات

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

يتطلّب مصادقة التطبيق باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.bot
نطاقات الأذونات

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

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

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

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

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

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.users.availability.readonly
  • https://www.googleapis.com/auth/chat.users.availability
نطاقات الأذونات

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

تعرض هذه الطريقة تفاصيل حول إيموجي مخصّص.

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
نطاقات الأذونات

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

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

  • مصادقة التطبيق مع أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.bot
    • ‫https://www.googleapis.com/auth/chat.app.memberships (يتطلّب موافقة المشرف)

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام أحد نطاقات التفويض التالية:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
نطاقات الأذونات

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • 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)

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

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

  • مصادقة التطبيق مع أحد نطاقات التفويض التالية:

    • ‫https://www.googleapis.com/auth/chat.bot: عند استخدام نطاق التفويض هذا، تعرض هذه الطريقة تفاصيل عن رسالة يمكن لتطبيق Chat الوصول إليها، مثل الرسائل المباشرة والأوامر التي تبدأ بشرطة مائلة التي تستدعي تطبيق Chat.
    • https://www.googleapis.com/auth/chat.app.messages.readonly مع موافقة المشرف عند استخدام نطاق المصادقة هذا، تعرض هذه الطريقة تفاصيل حول رسالة عامة في مساحة.

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

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

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

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

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

  • مصادقة التطبيق مع أحد نطاقات التفويض التالية:

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام أحد نطاقات التفويض التالية:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

تخضع مصادقة التطبيق للقيود التالية:

  • لا تتم تعبئة السمة space.access_settings إلا عند استخدام نطاق chat.app.spaces.
  • لا تتم تعبئة space.predefind_permission_settings وspace.permission_settings إلا عند استخدام نطاق chat.app.spaces، وفقط للمساحات التي أنشأها التطبيق.
نطاقات الأذونات

يتطلب أحد نطاقات 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 في كائن "المساحة" لبيانات أحداث "المساحة" لهذا الطلب.

يتيح أنواع المصادقة التالية مع نطاق تفويض مناسب لقراءة البيانات المطلوبة:

  • مصادقة التطبيق من خلال موافقة المشرف باستخدام أحد نطاقات التفويض التالية:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.spacesettings
نطاقات الأذونات

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

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

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
نطاقات الأذونات

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
نطاقات الأذونات

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

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
نطاقات الأذونات

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

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

  • مصادقة التطبيق مع أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.bot
    • ‫https://www.googleapis.com/auth/chat.app.memberships (يتطلّب موافقة المشرف)

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام أحد نطاقات التفويض التالية:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
نطاقات الأذونات

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

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

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

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
نطاقات الأذونات

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف مع نطاق التفويض:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. عند استخدام نطاق المصادقة هذا، لا تعرض هذه الطريقة سوى الرسائل العامة في مساحة. ولا يشمل ذلك الرسائل الخاصة.

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
نطاقات الأذونات

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

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

تعرض هذه الطريقة قائمة بالتفاعلات مع رسالة. للاطّلاع على مثال، يُرجى مراجعة إدراج التفاعلات لرسالة.

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
نطاقات الأذونات

يتطلب أحد نطاقات 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

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

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

تعرض هذه السمة العناصر في قسم معيّن.

يمكن أن تكون المساحات فقط عناصر في الأقسام. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة كيفية إنشاء أقسام وتنظيمها في Google Chat.

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
نطاقات الأذونات

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

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

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

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly
نطاقات الأذونات

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

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

يتيح أنواع المصادقة التالية مع نطاق تفويض مناسب لقراءة البيانات المطلوبة:

  • مصادقة التطبيق من خلال موافقة المشرف باستخدام أحد نطاقات التفويض التالية:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.messages.readonly
  • https://www.googleapis.com/auth/chat.app.all.spaces.readonly
  • https://www.googleapis.com/auth/chat.app.all.memberships.readonly
  • 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)

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

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

  • مصادقة التطبيق باستخدام نطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

لإدراج جميع المساحات المُسمّاة حسب مؤسسة 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

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

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

يتم وضع علامة على المستخدم على أنّه ACTIVE في Google Chat.

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

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.availability
نطاقات الأذونات

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

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

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

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

يتم وضع علامة على المستخدم على أنّه AWAY في Google Chat.

يضبط حالة المستخدم على "بالخارج" ولا يتأثر بنشاط المستخدم.

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.availability
نطاقات الأذونات

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

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

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

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

يتم وضع علامة على المستخدم على أنّه DO_NOT_DISTURB في Google Chat.

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

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.availability
نطاقات الأذونات

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

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

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

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
نطاقات الأذونات

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

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

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

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

يغيّر نظام الترتيب في قسم معيّن. لمعرفة التفاصيل، يُرجى الاطّلاع على مقالة كيفية إنشاء أقسام وتنظيمها في Google Chat.

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
نطاقات الأذونات

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

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

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

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

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

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

إذا استبدل التطبيق البطاقات بقائمة فارغة، تتم إزالة البطاقات. بعد إزالة البطاقات، لا يمكن للتطبيق إضافتها مرة أخرى إلى الرسالة.

يتطلّب ذلك مصادقة التطبيق باستخدام نطاق التفويض: - https://www.googleapis.com/auth/chat.bot

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

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

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

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

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

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

للبحث في جميع المساحات التي يمكن للمستخدم الوصول إليها، اضبط parent على spaces/-. يؤدي استخدام أي قيمة أخرى لسمة parent إلى ظهور خطأ INVALID_ARGUMENT. يتم ملء حقل name في الرسائل التي يتم عرضها باسم المورد الكامل، والذي يتضمّن space المحدّد الذي تتوفّر فيه الرسالة.

لا تعرض واجهة برمجة التطبيقات هذه جميع أنواع الرسائل. لا يتم تضمين أنواع الرسائل المدرَجة أدناه في الردّ. استخدِم ListMessages لعرض جميع الرسائل.

  • الرسائل الخاصة التي تظهر للمستخدم الذي تمت مصادقته
  • الرسائل التي تنشرها تطبيقات Chat في المساحات أو المحادثات الجماعية
  • الرسائل في رسالة مباشرة في تطبيق Chat
  • الرسائل من المستخدمين المحظورين
  • الرسائل في المساحات التي تجاهلها المتصل

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
نطاقات الأذونات

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

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

تعرض هذه الطريقة قائمة بالمساحات في مؤسسة على Google Workspace. للاطّلاع على مثال، يُرجى مراجعة البحث عن المساحات وإدارتها.

عند ضبط use_admin_access على false، تقتصر النتائج على المساحات التي يكون فيها المستخدم المتصل عضوًا منضمًا. للبحث باستخدام امتيازات المشرف، اضبط use_admin_access على true.

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

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

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

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

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

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

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

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

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

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
نطاقات الأذونات

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

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

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

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

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

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

يتطلّب ذلك مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

  • https://www.googleapis.com/auth/chat.users.availability
نطاقات الأذونات

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • مصادقة التطبيق من خلال موافقة المشرف ونطاق التفويض:

    • ‫https://www.googleapis.com/auth/chat.app.memberships (في المساحات التي أنشأها التطبيق فقط)

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عند مصادقة حساب مشرف، وتكون قيمة use_admin_access هي true، ويتم استخدام نطاق التفويض التالي:
      • https://www.googleapis.com/auth/chat.admin.memberships
نطاقات الأذونات

يتطلب أحد نطاقات 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. للاطّلاع على مثال، يُرجى مراجعة مقالة تعديل رسالة.

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

  • مصادقة التطبيق باستخدام نطاق التفويض:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)

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

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

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

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

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

rpc UpdateSection(UpdateSectionRequest) returns (Section)

تعديل قسم يمكن تعديل الأقسام من النوع CUSTOM_SECTION فقط. لمعرفة التفاصيل، يُرجى الاطّلاع على كيفية إنشاء أقسام وتنظيمها في Google Chat.

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
نطاقات الأذونات

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

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

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

  • مصادقة التطبيق من خلال موافقة المشرف وأحد نطاقات التفويض التالية:

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

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.spaces
    • ‫https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)
    • تمنح مصادقة المستخدم امتيازات المشرف عندما تتم مصادقة حساب مشرف، ويكون use_admin_access هو true، ويتم استخدام نطاقات التفويض التالية:
      • https://www.googleapis.com/auth/chat.admin.spaces

تخضع مصادقة التطبيق للقيود التالية:

  • لتعديل space.predefined_permission_settings أو space.permission_settings، يجب أن يكون التطبيق هو منشئ المساحة.
  • لا يمكن تعديل space.access_settings.audience لمصادقة التطبيق.
نطاقات الأذونات

يتطلب أحد نطاقات 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)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.spacesettings
نطاقات الأذونات

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

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

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.readstate
نطاقات الأذونات

يجب توفير نطاق 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

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

الحقول
widget

string

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

SelectionItems

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

ActionStatus

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

الحقول
status_code

Code

رمز الحالة
user_facing_message

string

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

تعليق توضيحي

يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع ضبط start_index وlength على 0. لإضافة تنسيق أساسي إلى رسالة نصية، يُرجى الاطّلاع على تنسيق الرسائل النصية.

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

Hello @FooBot how are you!"

البيانات الوصفية للتعليقات التوضيحية المقابلة:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
الحقول
type

AnnotationType

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

int32

طول السلسلة الفرعية في نص الرسالة العادي الذي يتوافق معه هذا التعليق التوضيحي في حال عدم توفّرها، تشير إلى أنّ المدة هي 0.
start_index

int32

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

UserMentionMetadata

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

SlashCommandMetadata

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

CustomEmojiMetadata

البيانات الوصفية لإيموجي مخصّص

AnnotationType

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

عمليات التعداد
ANNOTATION_TYPE_UNSPECIFIED القيمة التلقائية للتعداد يجب عدم استخدامها.
USER_MENTION تمت الإشارة إلى مستخدم.
SLASH_COMMAND يتم استدعاء أمر يبدأ بشرطة مائلة.
CUSTOM_EMOJI تعليق توضيحي مخصّص للإيموجي

AppCommandMetadata

البيانات الوصفية حول أمر تطبيق Chat.

الحقول
app_command_id

int32

رقم تعريف الأمر المحدّد في إعدادات Chat API
app_command_type

AppCommandType

نوع أمر تطبيق Chat

AppCommandType

نوع أمر تطبيق Chat لمعرفة التفاصيل، يُرجى الاطّلاع على أنواع أوامر تطبيقات Chat.

عمليات التعداد
APP_COMMAND_TYPE_UNSPECIFIED القيمة التلقائية غير محدد
SLASH_COMMAND أمر يبدأ بشرطة مائلة يرسل المستخدم الأمر في رسالة محادثة.
QUICK_COMMAND أمر سريع يختار المستخدم الأمر من قائمة Chat في قسم الرد على الرسالة.
MESSAGE_ACTION إجراء مقترح يختار المستخدم الأمر من قائمة سياق الرسالة في Chat.

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 للصورة المصغّرة الذي يجب استخدامه لمعاينة المرفق لمستخدم بشري يجب ألا تستخدم تطبيقات Chat عنوان URL هذا لتنزيل محتوى المرفقات.
download_uri

string

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

Source

للعرض فقط. مصدر المرفق
حقل الربط data_ref مرجع البيانات للمرفق. يمكن أن يكون التعليق data_ref إحدى القيم التالية فقط:
attachment_data_ref

AttachmentDataRef

اختيارية: مرجع لبيانات المرفق يُستخدَم هذا الحقل لإنشاء رسائل تتضمّن مرفقات أو تعديلها، أو مع واجهة برمجة التطبيقات للوسائط لتنزيل بيانات المرفقات.
drive_data_ref

DriveDataRef

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

المصدر

مصدر المرفق

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

AttachmentDataRef

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

الحقول
resource_name

string

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

string

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

الجمهور

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

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

الحقول
name

string

اسم المورد للجمهور المستهدف الذي يمكنه العثور على المساحة أو الانضمام إليها. لمعرفة التفاصيل، يُرجى الاطّلاع على كيفية جعل مساحة قابلة للاكتشاف لجمهور مستهدف. التنسيق: audiences/{audience}

لاستخدام الجمهور المستهدف التلقائي لمؤسسة Google Workspace، اضبط القيمة على audiences/default.

مدى التوفّر

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

الحقول
name

string

المعرّف. اسم المورد الخاص بتوفّر المستخدم

التنسيق: users/{user}/availability

‫{user} هو رقم تعريف المستخدم في People API أو واجهة برمجة تطبيقات دليل SDK للمشرف. مثلاً: users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كعنوان بديل للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me.
state

State

للعرض فقط. حالة مدى توفّر المستخدم الحالية
custom_status

CustomStatus

اختيارية: الحالة المخصّصة للمستخدم
حقل الربط state_metadata بيانات وصفية إضافية مرتبطة بحالة توفّر المستخدم يمكن أن يكون التعليق state_metadata إحدى القيم التالية فقط:
do_not_disturb_metadata

DoNotDisturbMetadata

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

ولاية

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

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية لم يتم تحديد الحالة.
ACTIVE المستخدم نشط حاليًا، استنادًا إلى النشاط الأخير.
IDLE المستخدم غير نشط حاليًا. تشير هذه الحالة إلى فترة من عدم النشاط بعد أن كان المستخدم "نشطًا"، قبل الانتقال المحتمل إلى الحالة "غير متاح".
AWAY المستخدم غير متاح حاليًا. ويمكن ضبط هذه الحالة تلقائيًا بعد فترة من عدم النشاط في الحالة "نشط" أو "غير نشط"، أو يمكن ضبطها يدويًا من قِبل المستخدم. عند ضبط هذه الحالة يدويًا من خلال MarkAsAway، تظلّ الحالة كما هي بغض النظر عن نشاط المستخدم.
DO_NOT_DISTURB المستخدم في حالة "عدم الإزعاج" التي تم ضبطها يدويًا.

CalendarEventLinkData

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

الحقول
calendar_id

string

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

string

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

CardWithId

بطاقة في رسالة محادثة في Google Chat

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

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

صمِّم البطاقات وعايِنها باستخدام Card Builder.

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

الحقول
card_id

string

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

Card

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

User

للعرض فقط. التطبيق الذي يملك البطاقة

ChatSpaceLinkData

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

الحقول
space

string

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

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

string

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

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

string

رسالة مورد مساحة Chat المرتبطة

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

معلومات الكتاب

الاقتباسات هي مراجع مضمّنة يمكن أن توفّر للمستخدمين معلومات أكثر تفصيلاً عن المرجع المضمّن. يجب أن تظهر الاقتباسات المضمّنة المقابلة في نص الرسالة بتنسيق ترميز <chat-citation data-id="{id}">{text}</chat-citation>. لا تتوفّر الاقتباسات إلا عندما يتم ضبط markup_syntax للرسالة على MARKDOWN.

يتم تجاهل الاقتباسات غير المُشار إليها في Elements.citations (تلك التي لا تحتوي على علامة <chat-citation> مطابقة في نص الرسالة) ولا تؤدي إلى رفض الرسالة.

الحقول
id

string

الحقل مطلوب. معرّف محدّد من التطبيق يجب أن يحتوي على أحرف وأرقام ASCII فقط، وأقل من 63 حرفًا.
cited_sources[]

CitedSource

اختيارية: قائمة بالمصادر ذات الصلة بالاقتباس يتم عرض المصادر في بطاقة المعلومات الخاصة بالاقتباس.

CitedSource

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

الحقول
title

string

الحقل مطلوب. عنوان CitedSource بنص عادي لا يتيح هذا الحقل التنسيق.
uri

string

الحقل مطلوب. معرّف الموارد المنتظم (URI) الذي يشير إلى المورد المُشار إليه في CitedSource.
snippet

Snippet

اختيارية: مقتطف يحتوي على معلومات من المصدر مباشرةً
footer

Footer

اختيارية: معلومات إضافية تظهر بجانب المقتطف على شكل تذييل

تذييل لمصدر، يُستخدَم لتحديد المصدر

الحقول
text

string

اختيارية: النص المطلوب عرضه في التذييل

المقتطف

يشير هذا المصطلح إلى عنصر مقتطف يمثّل مقتطفًا من نص أكبر.

الحقول
text

string

اختيارية: مقتطف نصي قصير من النص الأساسي مباشرةً قد يتم عرضه في Chat لا يتيح تنسيق Markdown.
image_preview

ElementsImage

اختيارية: معاينة صورة المقتطف المقدَّم كإدخال عند إنشاء الاقتباس

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

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

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. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للمستخدم في People API لـ "user@example.com" هو "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 وفي "المساحات".

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

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

CreateMessageNotificationOptions

خيارات سلوك الإشعار عند نشر الرسالة

الحقول
notification_type

NotificationType

نوع الإشعار للرسالة

NotificationType

خيارات أنواع الإشعارات للرسالة

عمليات التعداد
NOTIFICATION_TYPE_NONE الإعداد التلقائي يكون سلوك الإشعارات مشابهًا لما يحدث عندما يرسل المستخدم البشري الرسالة باستخدام واجهة مستخدم Chat: لا يتم إرسال أي إشعار إلى المُرسِل البشري.
NOTIFICATION_TYPE_FORCE_NOTIFY

فرض إرسال إشعارات إلى المستلِمين يؤدي ذلك إلى تجاوز إعدادات إشعارات المساحة لدى المستخدمين وإعدادات "عدم الإزعاج" في Chat. لا يتجاوز هذا الخيار إعدادات "عدم الإزعاج" على مستوى الجهاز.

يتطلّب ذلك مصادقة التطبيق.
NOTIFICATION_TYPE_SILENT

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

يتطلّب ذلك مصادقة التطبيق.

CreateMessagePinRequest

رسالة طلب لتثبيت رسالة

الحقول
parent

string

الحقل مطلوب. المساحة الرئيسية التي سيتم إنشاء الرسالة المثبّتة فيها التنسيق: spaces/{space}
message_pin

MessagePin

الحقل مطلوب. تمثّل هذه السمة MessagePin المطلوب إنشاؤها.

CreateMessageRequest

تنشئ رسالة.

الحقول
parent

string

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

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

Message

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

string

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

string

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

لاستخدام هذا الحقل بفعالية:

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

MessageReplyOption

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

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

string

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

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

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

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

CreateMessageNotificationOptions

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

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

الحقل مطلوب. التفاعل المطلوب إنشاؤه

CreateSectionRequest

رسالة طلب لإنشاء قسم

الحقول
parent

string

الحقل مطلوب. اسم المرجع الرئيسي الذي تم إنشاء القسم فيه

التنسيق: users/{user}
section

Section

الحقل مطلوب. القسم المطلوب إنشاؤه

CreateSpaceRequest

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

الحقول
space

Space

الحقل مطلوب. يجب ملء الحقلَين displayName وspaceType. يُسمح فقط بالقيمة SpaceType.SPACE وSpaceType.GROUP_CHAT. لا يمكن استخدام SpaceType.GROUP_CHAT إلا إذا تم ضبط importMode على "صحيح".

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

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

string

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

لاستخدام هذا الحقل بفعالية:

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

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.

CustomEmojiMetadata

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

الحقول
custom_emoji

CustomEmoji

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

CustomStatus

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

الحقول
text

string

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

Emoji

الحقل مطلوب. الإيموجي الخاص بالحالة المخصّصة يمكن استخدام رموز الإيموجي المتوافقة مع Unicode فقط، ولا يمكن استخدام رموز الإيموجي المخصّصة.
حقل الربط expiration وقت انتهاء صلاحية الحالة المخصّصة ويمكن تحديدها إما كطابع زمني مطلق أو كمدة صلاحية. يمكن أن يكون التعليق expiration إحدى القيم التالية فقط:
expire_time

Timestamp

الطابع الزمني لانتهاء صلاحية الحالة المخصّصة
ttl

Duration

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

DeleteCustomEmojiRequest

طلب حذف إيموجي مخصّص

الحقول
name

string

الحقل مطلوب. اسم المورد الخاص بالإيموجي المخصّص المطلوب حذفه

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

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

DeleteMembershipRequest

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

الحقول
name

string

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

عند حذف عضوية مستخدم، يتطلب ذلك نطاق chat.memberships مع مصادقة المستخدم أو نطاق chat.memberships.app مع مصادقة التطبيق وتنسيق spaces/{space}/members/{member}. يمكنك استخدام عنوان البريد الإلكتروني كعنوان بديل لـ {member}. على سبيل المثال، spaces/{space}/members/example@gmail.com حيث يمثّل example@gmail.com عنوان البريد الإلكتروني لمستخدم Google Chat.

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

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

bool

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

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

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

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

DeleteMessagePinRequest

رسالة طلب لإزالة تثبيت رسالة

الحقول
name

string

الحقل مطلوب. اسم مورد الرسالة المثبّتة المطلوب إزالتها التنسيق: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

طلب حذف رسالة

الحقول
name

string

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

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

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

bool

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

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

DeleteReactionRequest

تحذف هذه الطريقة تفاعلاً مع رسالة.

الحقول
name

string

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

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

DeleteSectionRequest

رسالة طلب لحذف قسم

الحقول
name

string

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

التنسيق: users/{user}/sections/{section}

DeleteSpaceRequest

طلب حذف مساحة

الحقول
name

string

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

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

bool

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

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

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

DeletionMetadata

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

الحقول
deletion_type

DeletionType

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

DeletionType

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

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

مربّع حوار

Wrapper around the card body of the dialog.

الحقول
body

Card

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

DialogAction

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

الحقول
action_status

ActionStatus

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

Dialog

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

DoNotDisturbMetadata

البيانات الوصفية المرتبطة بحالة توفّر DO_NOT_DISTURB، والتي تحدّد وقت انتهاء صلاحية الحالة.

الحقول
expiration_time

Timestamp

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

DriveDataRef

مرجع لبيانات مرفق في Drive

الحقول
drive_file_id

string

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

DriveLinkData

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

الحقول
drive_data_ref

DriveDataRef

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

string

نوع mime لمرجع Google Drive المرتبط

العناصر

العناصر هي مكوّنات إضافية قد تكون مرتبطة بنص الرسالة المقدَّم أثناء إنشاء الرسالة أو لا تكون مرتبطة به.

الحقول
cited_sources[]

CitedSource

قائمة بالمصادر التي سيتم عرضها أسفل الرسالة كروابط تذييل لا تتم الإشارة إليها بشكل مضمّن. بالنسبة إلى المراجع المضمّنة، استخدِم citations.
citations[]

Citation

قائمة بالاقتباسات المضمّنة المُشار إليها في نص الرسالة (عبر علامات <chat-citation>) والتي تظهر كبطاقات معلومات تفاعلية

ElementsImage

عنصر يضم طرقًا مختلفة لتمثيل صورة التمثيلات المتاحة حاليًا: - صورة تم جلبها من معرّف موارد منتظم (URI). وقد تتم إتاحة تمثيلات إضافية في المستقبل.

الحقول
حقل الربط image الحقل مطلوب. أحد تمثيلات الصور المتوافقة يمكن أن يكون التعليق image إحدى القيم التالية فقط:
image_uri

string

الحقل مطلوب. معرّف موارد منتظم (URI) متاح للجميع لصورة معيّنة

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

إيموجي يُستخدم للتفاعل مع رسالة

الحقول
حقل الربط 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.

FindGroupChatsRequest

طلب للحصول على مساحات محادثات جماعية استنادًا إلى موارد المستخدمين

الحقول
users[]

string

اختيارية: أسماء الموارد لجميع المستخدمين في المحادثة الجماعية مع المستخدم الذي يجري المكالمة. لا يمكن تضمين تطبيقات Chat في الطلب.

الحد الأقصى لعدد المستخدمين الذين يمكن تحديدهم في طلب واحد هو 49.

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

int32

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

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

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

تؤدي القيم السالبة إلى ظهور الخطأ INVALID_ARGUMENT.
page_token

string

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

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

SpaceView

نوع عرض المساحة المطلوب وفي حال ترك السياسة بدون ضبط، يتم ضبطها تلقائيًا على SPACE_VIEW_RESOURCE_NAME_ONLY. يجب أن تتضمّن الطلبات التي تحدّد SPACE_VIEW_EXPANDED نطاقات تسمح بقراءة بيانات المساحة، مثل https://www.googleapis.com/auth/chat.spaces أو https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

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

الحقول
spaces[]

Space

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

string

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

ForwardedMetadata

البيانات الوصفية حول المساحة المصدر التي تمت إعادة توجيه رسالة منها

الحقول
space

string

للعرض فقط. اسم المورد للمساحة المصدر التنسيق: spaces/{space}
space_display_name

string

للعرض فقط. الاسم المعروض لمساحة المصدر أو الرسالة المباشرة في وقت إعادة التوجيه بالنسبة إلى SPACE، هذا هو اسم المساحة. بالنسبة إلى DIRECT_MESSAGE، هذا هو اسم المشارك الآخر (مثلاً، "المستخدم أ"). بالنسبة إلى GROUP_CHAT، هذا اسم يتم إنشاؤه استنادًا إلى الأسماء الأولى للأعضاء، ويقتصر على 5 أسماء بما في ذلك صانع المحتوى (مثلاً، "المستخدم أ، المستخدم ب").

GetAttachmentRequest

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

الحقول
name

string

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

GetAvailabilityRequest

تمثّل هذه السمة رسالة الطلب لطريقة GetAvailability.

الحقول
name

string

الحقل مطلوب. اسم مورد مدى التوفّر المطلوب استرداده

التنسيق: users/{user}/availability

‫{user} هو رقم تعريف المستخدم في People API أو واجهة برمجة تطبيقات دليل SDK للمشرف. مثلاً: users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كعنوان بديل للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me.

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}. لمعرفة التفاصيل، يُرجى الاطّلاع على تسمية رسالة.
markup_syntax

MarkupSyntax

اختيارية: تحدّد هذه المَعلمة البنية المطلوبة لإخراج حقل formatted_text في رسالة محادثة.

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 API

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

يتطلّب ذلك استخدام نطاق OAuth 2.0‏ chat.admin.memberships.readonly أو chat.admin.memberships.

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

ListMembershipsResponse

الردّ على قائمة العضويات في المساحة

الحقول
memberships[]

Membership

قائمة بدون ترتيب قائمة بالاشتراكات في الصفحة المطلوبة (أو الأولى)
next_page_token

string

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

ListMessagePinsRequest

رسالة طلب لعرض الرسائل المثبَّتة

الحقول
parent

string

الحقل مطلوب. المساحة الرئيسية التي تملك مجموعة العناصر المثبَّتة بالتنسيق: spaces/{space}
page_size

int32

اختيارية: الحد الأقصى لعدد الرسائل المثبّتة التي يتم عرضها. قد تعرض الخدمة عدد رسائل أقل من هذه القيمة. الحد الأقصى للقيمة هو 100. إذا استخدمت قيمة أكبر من 100، سيتم تغييرها تلقائيًا إلى 100. إذا لم يتم تحديدها، سيتم عرض 100 رسالة مثبّتة كحد أقصى. تؤدي القيم السالبة إلى ظهور الخطأ INVALID_ARGUMENT.
page_token

string

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

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

ListMessagePinsResponse

رسالة استجابة لإدراج الرسائل المثبّتة

الحقول
message_pins[]

MessagePin

الرسائل المثبَّتة من المساحة المحدّدة
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

اختيارية: ما إذا كان سيتم تضمين الرسائل المحذوفة أم لا تتضمّن الرسائل المحذوفة وقت الحذف والبيانات الوصفية المتعلّقة بحذفها، ولكن محتوى الرسالة غير متاح.
markup_syntax

MarkupSyntax

اختيارية: تحدّد هذه المَعلمة البنية المطلوبة لإخراج حقل formatted_text في رسالة محادثة.

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

رمز المتابعة لاسترداد الصفحة التالية من النتائج ويكون فارغًا في الصفحة الأخيرة من النتائج.

ListSectionItemsRequest

رسالة طلب لإدراج عناصر القسم

الحقول
parent

string

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

عند الفلترة حسب المساحة، استخدِم حرف البدل - للبحث في جميع الأقسام. مثلاً: users/{user}/sections/-

التنسيق: users/{user}/sections/{section}
page_size

int32

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

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

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

تؤدي القيم السالبة إلى ظهور الخطأ INVALID_ARGUMENT.
page_token

string

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

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

string

اختيارية: فلتر طلب البحث

لا تتيح حاليًا سوى الفلترة حسب المساحة.

مثلاً: space = spaces/{space}

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

ListSectionItemsResponse

رسالة الردّ على طلب عرض عناصر القسم

الحقول
section_items[]

SectionItem

عناصر القسم من القسم المحدّد
next_page_token

string

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

ListSectionsRequest

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

الحقول
parent

string

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

  • الاسم المستعار لـ "me" مثلاً: users/me

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

  • رقم تعريف المستخدم مثلاً: users/123456789

التنسيق: users/{user}
page_size

int32

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

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

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

تؤدي القيم السالبة إلى ظهور الخطأ INVALID_ARGUMENT.
page_token

string

اختيارية: رمز مميّز للصفحة، يتم تلقّيه من طلب سابق لإدراج الأقسام يجب تقديم هذه القيمة لاسترداد الصفحة التالية.

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

ListSectionsResponse

رسالة الردّ لإدراج الأقسام

الحقول
sections[]

Section

الأقسام من المستخدم المحدّد
next_page_token

string

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

ListSpaceEventsRequest

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

الحقول
parent

string

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

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

int32

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

تؤدي القيم السالبة إلى ظهور الخطأ INVALID_ARGUMENT.
page_token

string

اختيارية: رمز مميّز للصفحة، يتم تلقّيه من طلب سابق لإدراج أحداث المساحة يجب تقديم هذه القيمة لاسترداد الصفحة التالية.

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

string

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

يجب تحديد نوع حدث واحد على الأقل (event_type) باستخدام عامل التشغيل :. للفلترة حسب أنواع أحداث متعددة، استخدِم عامل التشغيل 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 في عنصر "المساحة" لطلبات القائمة.
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 في عنصر "المساحة" لطلبات القائمة.
next_page_token

string

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

MarkAsActiveRequest

تمثّل هذه السمة رسالة الطلب لطريقة MarkAsActive.

الحقول
name

string

الحقل مطلوب. اسم مورد مدى التوفّر المطلوب وضع علامة "نشط" عليه التنسيق: users/{user}/availability

‫{user} هو رقم تعريف المستخدم في People API أو واجهة برمجة تطبيقات دليل SDK للمشرف. مثلاً: users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كعنوان بديل للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me.
حقل الربط expiration تاريخ انتهاء صلاحية حالة التوفّر "نشط" سيتم وضع علامة على المستخدم على أنه "غير متاح" بعد انتهاء الصلاحية. إذا لم يتم تحديد تاريخ انتهاء الصلاحية، ستنتهي صلاحية الحالة "نشط" بعد 30 دقيقة من الوقت الحالي. يمكن أن يكون التعليق expiration إحدى القيم التالية فقط:
expire_time

Timestamp

الطابع الزمني المطلق لانتهاء صلاحية الحالة "نشط"
ttl

Duration

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

MarkAsAwayRequest

تمثّل هذه السمة رسالة الطلب لطريقة MarkAsAway.

الحقول
name

string

الحقل مطلوب. اسم مورد حالة التوفّر المطلوب وضع علامة "غير متاح" عليها التنسيق: users/{user}/availability

‫{user} هو رقم تعريف المستخدم في People API أو واجهة برمجة تطبيقات دليل SDK للمشرف. مثلاً: users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كعنوان بديل للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me.

MarkAsDoNotDisturbRequest

تمثّل هذه السمة رسالة الطلب لطريقة MarkAsDoNotDisturb.

الحقول
name

string

الحقل مطلوب. اسم مورد حالة التوفّر المطلوب وضع علامة "عدم الإزعاج" عليها التنسيق: users/{user}/availability

‫{user} هو رقم تعريف المستخدم في People API أو واجهة برمجة تطبيقات دليل SDK للمشرف. مثلاً: users/123456789

يمكن أيضًا استخدام عنوان البريد الإلكتروني للمستخدم أو me كعنوان بديل للإشارة إلى المتصل. على سبيل المثال، users/user@example.com أو users/me.
حقل الربط expiration الحقل مطلوب. تاريخ انتهاء صلاحية حالة توفّر ميزة "عدم الإزعاج" سيتم وضع علامة على المستخدم على أنه "غير متاح" بعد انتهاء الصلاحية. يمكن أن يكون هذا التاريخ بعد عام واحد على الأكثر من الوقت الحالي. يمكن أن يكون التعليق expiration إحدى القيم التالية فقط:
expire_time

Timestamp

الطابع الزمني المطلق لانتهاء صلاحية حالة "عدم الإزعاج"
ttl

Duration

المدة من الوقت الحالي حتى انتهاء صلاحية حالة "عدم الإزعاج"

MarkupSyntax

تحدّد بنية الترميز المستخدَمة لتنسيق نص رسالة Chat. تنطبق هذه السمة على الحقل text للمورد Message.

عمليات التعداد
MARKUP_SYNTAX_UNSPECIFIED تمثّل القيمة غير المحدّدة.
MARKUP_SYNTAX_CHAT يستخدم هذا الحقل بنية الترميز في Google Chat. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN يستخدم بنية Markdown. تستند هذه البنية إلى مواصفات CommonMark، مع إضافات أخرى. لمزيد من المعلومات، يُرجى الانتقال إلى https://developers.google.com/workspace/chat/format-messages#format-texts.

MatchedUrl

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

الحقول
url

string

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

MeetSpaceLinkData

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

الحقول
meeting_code

string

رمز الاجتماع لمساحة Meet المرتبطة
type

Type

يشير إلى نوع مساحة Meet.
huddle_status

HuddleStatus

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

HuddleStatus

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

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

النوع

نوع مساحة Meet

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

العضوية

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

الحقول
name

string

المعرّف. اسم مورد العضوية، الذي يحدّده الخادم

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

MembershipState

للعرض فقط. حالة العضوية
role

MembershipRole

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

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

Timestamp

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

Timestamp

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

Affiliation

للعرض فقط. علاقة المستخدم بمؤسسة Workspace التي تملك المساحة في المساحات التي تملكها حسابات المستهلكين، يكون انتماء جميع الأعضاء هو EXTERNAL.
حقل الربط memberType العضو المرتبط بهذا الاشتراك وقد تتم إتاحة أنواع أخرى من الأعضاء في المستقبل. يمكن أن يكون التعليق memberType إحدى القيم التالية فقط:
member

User

اختيارية: مستخدم Google Chat أو التطبيق الذي يتوافق معه الاشتراك إذا كان تطبيق Chat يُجري المصادقة كمستخدم، لن يعرض الناتج سوى الحقلَين name وtype في user لكل من المستخدمين الداخليين والخارجيين، ما لم يكونوا أعضاء في المساحة أو لديهم صلة سابقة، مثل محادثة عبر رسالة مباشرة، مع المستخدم الذي يجري المكالمة.
group_member

Group

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

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

الارتباط

تمثّل انتماء مستخدم إلى مؤسسة Google Workspace التي تملك المساحة. قد تتم إضافة المزيد من القيم إلى هذا التعداد في المستقبل.

عمليات التعداد
AFFILIATION_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
INTERNAL حساب تديره مؤسسة Google Workspace نفسها التي تملك المساحة
EXTERNAL حساب خارجي لمؤسسة Google Workspace التي تملك المساحة (على سبيل المثال، حساب مستهلك أو حساب تديره مؤسسة Workspace مختلفة).
MANAGED_EXTERNAL حساب تديره مؤسسة Workspace التي تملك المساحة، ولكن تم توفيره لمستخدم خارجي (مثل مستخدم ضيف). لمزيد من المعلومات عن الضيوف، يُرجى الاطّلاع على https://support.google.com/chat/answer/16997417.

MembershipRole

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

عمليات التعداد
MEMBERSHIP_ROLE_UNSPECIFIED القيمة التلقائية بالنسبة إلى users: ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى Google Groups: يتم دائمًا إسناد هذا الدور إليهم (قد يتم استخدام قيم تعداد أخرى في المستقبل).
ROLE_MEMBER

عضو في المساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "عضو".

لدى المستخدم أذونات أساسية، مثل إرسال الرسائل إلى المساحة. يمكن للمدراء والمالكين منح الأعضاء أذونات إضافية في مساحة، بما في ذلك:

  • إضافة أعضاء أو إزالتهم
  • تعديل تفاصيل المساحة
  • تفعيل السجلّ أو إيقافه
  • يمكنك الإشارة إلى جميع المشاركين في المساحة باستخدام @all.
  • إدارة تطبيقات Chat وخطافات الويب المثبَّتة في المساحة

في الرسائل المباشرة والمحادثات الجماعية بدون اسم، يحصل الجميع على هذا الدور.
ROLE_MANAGER

مالك المساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "المالك".

لدى المستخدم مجموعة كاملة من أذونات المساحة لإدارتها، بما في ذلك:

  • تغيير دور الأعضاء الآخرين في المساحة إلى عضو أو مدير أو مالك
  • حذف المساحة

لا تتوفّر هذه الميزة إلا في SpaceType.SPACE (المساحات المُسمّاة).

لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مزيد من المعلومات عن دور مالك المساحة أو مديرها.
ROLE_ASSISTANT_MANAGER

مدير مساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "المدير".

يحصل المستخدم على جميع الأذونات الأساسية في "ROLE_MEMBER"، ويمكن للمالك منحه مجموعة فرعية من الأذونات الإدارية. بشكل تلقائي، يحصل المدراء على جميع أذونات المالك باستثناء القدرة على:

  • حذف المساحة
  • اختيار عضو آخر ليكون مالك المساحة
  • تغيير دور مالك

تشمل أذونات المدراء تلقائيًا ما يلي، على سبيل المثال لا الحصر:

  • منح عضو آخر دور مدير
  • حذف الرسائل في المساحة
  • إدارة أذونات المساحة
  • تلقّي إشعارات بشأن طلبات الانضمام إلى المساحة إذا كان المدير لديه إذن "إدارة الأعضاء" في إعدادات المساحة
  • جعل مساحة قابلة للاكتشاف

لا تتوفّر هذه الميزة إلا في 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 في user لكل من المستخدمين الداخليين والخارجيين، ما لم يكونوا أعضاء في المساحة أو لديهم صلة سابقة، مثل محادثة عبر رسالة مباشرة، مع المستخدم الذي يجري المكالمة.
create_time

Timestamp

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

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

Timestamp

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

Timestamp

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

string

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

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

string

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

  • بنية الترميز للنص الغامق والمائل والمشطوب والأحادي المسافة والكتلة الأحادية المسافة والقائمة النقطية والاقتباس المقتطع

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

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

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

  • استخدِم علامات النجمة (*) لإنشاء قائمة نقطية، على سبيل المثال: * item.

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

Card

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

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

CardWithId

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

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

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

صمِّم البطاقات وعايِنها باستخدام Card Builder.

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

Annotation

للعرض فقط. يمكن ربط التعليقات التوضيحية بالنص العادي للرسالة أو بشرائح ترتبط بمراجع Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع start_index وlength بقيمة 0.
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 في حقل "رسالة المحادثة" text يتطابق مع نمط معاينة الرابط لمزيد من المعلومات، يُرجى الاطّلاع على معاينة الروابط.
thread_reply

bool

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

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

bool

للعرض فقط. ما إذا كانت هذه رسالة صامتة الرسائل الصامتة هي رسائل يحجب فيها Chat الإشعارات الفورية للمستلِمين.
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

اختيارية: معلومات حول رسالة تقتبسها رسالة أخرى

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

عند تعديل رسالة، لا يمكنك إضافة الحقل quotedMessageMetadata أو استبداله، ولكن يمكنك إزالته.

للاطّلاع على مثال على الاستخدام، يُرجى مراجعة اقتباس رسالة أخرى.
attached_gifs[]

AttachedGif

للعرض فقط. صور GIF المرفقة بالرسالة
accessory_widgets[]

AccessoryWidget

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

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

Elements

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

markup_syntax

MarkupSyntax

اختيارية: تحدّد هذه السمة كيفية تفسير الخادم لمحتوى حقل الرسالة text.

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 وdeletionMetadata فقط.

MessagePin

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

الحقول
name

string

المعرّف. اسم مورد الرسالة المثبّتة التنسيق: spaces/{space}/messagePins/{message_pin} يتطابق مكوّن معرّف المورد مع مكوّن معرّف المورد للرسالة. على سبيل المثال، تتوافق رسالة تتضمّن spaces/AAA/messages/bbb.ccc مع تثبيت الرسالة التي تحمل اسم المورد spaces/AAA/messagePins/bbb.ccc.
message

string

الحقل مطلوب. غير قابل للتغيير اسم مورد الرسالة المثبّتة التنسيق: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

الحقول
message

Message

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

MoveSectionItemRequest

رسالة طلب لنقل عنصر من قسم إلى آخر

الحقول
name

string

الحقل مطلوب. اسم المورد لعنصر القسم المطلوب نقله

التنسيق: users/{user}/sections/{section}/items/{item}
target_section

string

الحقل مطلوب. اسم المورد الخاص بالقسم الذي سيتم نقل عنصر القسم إليه

التنسيق: users/{user}/sections/{section}

MoveSectionItemResponse

رسالة الردّ لنقل عنصر في قسم

الحقول
section_item

SectionItem

عنصر القسم المعدَّل

PositionSectionRequest

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

الحقول
name

string

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

التنسيق: users/{user}/sections/{section}
حقل الربط position الحقل مطلوب. الموضع الجديد للقسم يمكن أن يكون التعليق position إحدى القيم التالية فقط:
sort_order

int32

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

Position

اختيارية: تمثّل هذه السمة الموضع النسبي للقسم في قائمة الأقسام.

الموضع

تمثّل هذه السمة موضع القسم.

عمليات التعداد
POSITION_UNSPECIFIED لم يتم تحديد الموضع.
START بداية قائمة الأقسام
END نهاية قائمة الأقسام

PositionSectionResponse

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

الحقول
section

Section

القسم المعدَّل

QuotedMessageMetadata

معلومات حول رسالة تقتبسها رسالة أخرى

عند تعديل رسالة، لا يمكنك إضافة الحقل quotedMessageMetadata أو استبداله، ولكن يمكنك إزالته.

للاطّلاع على مثال على الاستخدام، يُرجى مراجعة اقتباس رسالة أخرى.

الحقول
name

string

الحقل مطلوب. اسم مورد الرسالة المقتبَسة

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

Timestamp

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

إذا تم تعديل الرسالة، استخدِم هذا الحقل: last_update_time. إذا لم يتم تعديل الرسالة مطلقًا، استخدِم create_time.

إذا لم يتطابق last_update_time مع أحدث إصدار من الرسالة المقتبسة، سيتعذّر تنفيذ الطلب.
quote_type

QuoteType

اختيارية: تحدّد هذه السمة نوع الاقتباس. في حال عدم ضبطه، يتم ضبطه تلقائيًا على REPLY في مسار قراءة/كتابة الرسالة للتوافق مع الأنظمة القديمة.
quoted_message_snapshot

QuotedMessageSnapshot

للعرض فقط. لقطة من محتوى الرسالة المقتبَسة
forwarded_metadata

ForwardedMetadata

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

QuoteType

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

عمليات التعداد
QUOTE_TYPE_UNSPECIFIED محجوزة هذه القيمة غير مستخدَمة.
REPLY

عندما يكون quote_type REPLY، يمكنك إجراء ما يلي:

  • إذا كنت تردّ في سلسلة محادثات، يمكنك اقتباس رسالة أخرى في تلك السلسلة.

  • إذا كنت تنشئ رسالة جذرية، يمكنك اقتباس رسالة جذرية أخرى في تلك المساحة.
FORWARD

عندما يكون quote_type هو FORWARD، يمكنك اقتباس:

  • رسالة من مساحة مختلفة

  • ردّ على رسالة من سلسلة محادثات مختلفة في المساحة نفسها

QuotedMessageSnapshot

يوفّر لقطة لمحتوى الرسالة المقتبَسة في وقت الاقتباس أو إعادة التوجيه

الحقول
sender

string

للعرض فقط. اسم مؤلف الرسالة المقتبسة يتم ملؤها لكل من نوعَي الاقتباس "رد" و"إعادة توجيه".
text

string

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

string

للعرض فقط. تحتوي على الرسالة المقتبَسة text مع إضافة ترميزات لإتاحة التنسيق المتقدّم، مثل الروابط التشعّبية ورموز الإيموجي المخصّصة والترميز وما إلى ذلك. تتم تعبئتها فقط لنوع الاقتباس "إعادة توجيه".
annotations[]

Annotation

للعرض فقط. التعليقات التوضيحية التي تم تحليلها من نص الرسالة المقتبسة. تتم تعبئة هذا الحقل فقط لنوع عرض الأسعار FORWARD.
attachments[]

Attachment

للعرض فقط. المرفقات التي كانت جزءًا من الرسالة المقتبَسة هذه نُسخ من البيانات الوصفية لمرفقات الرسالة المقتبسة. تتم تعبئة هذا الحقل لنوع عرض الأسعار FORWARD فقط.

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

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

الحقول
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

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

ReplaceMessageCardsRequest

رسالة طلب لطريقة ReplaceMessageCards في واجهة برمجة التطبيقات

الحقول
name

string

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

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

CardWithId

اختيارية: مصفوفة من البطاقات التي سيتم تضمينها في الرسالة. ستحلّ هذه البطاقات محلّ البطاقات الحالية للرسالة. إذا كان الحقل فارغًا، ستتم إزالة البطاقات الأصلية المضمّنة في الرسالة.

ReplaceMessageCardsResponse

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

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

RichLinkMetadata

رابط منسَّق يؤدي إلى مرجع يمكن ربط الروابط المنسَّقة بنص الرسالة العادي أو تمثيل شرائح ترتبط بموارد Google Workspace، مثل "مستندات Google" أو "جداول بيانات Google"، مع ضبط start_index وlength على 0.

الحقول
uri

string

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

RichLinkType

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

عمليات التعداد
DRIVE_FILE نوع رابط منسَّق في Google Drive
CHAT_SPACE نوع رابط غني لمساحة Chat على سبيل المثال، شريحة ذكية لمساحة.
GMAIL_MESSAGE نوع رابط منسَّق لرسالة Gmail على وجه التحديد، شريحة Gmail من المشاركة في Chat. تتيح واجهة برمجة التطبيقات قراءة الرسائل التي تحتوي على روابط GMAIL_MESSAGE الغنية فقط.
MEET_SPACE نوع رابط غني برسالة Meet على سبيل المثال، شريحة Meet.
CALENDAR_EVENT نوع رابط منسَّق لرسالة في "تقويم Google" على سبيل المثال، شريحة "تقويم Google".

SearchMessageResult

عنصر نتيجة واحد من عملية بحث عن رسالة

الحقول
message

Message

الرسالة المطابقة
space_mute_setting

MuteSetting

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

لا يتم عرضها إلا إذا كان عرض الطلب هو SEARCH_MESSAGES_VIEW_FULL وكانت بيانات اعتماد الاتصال تتضمّن نطاق التفويض التالي:

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

bool

يشير إلى ما إذا كان المستخدم الذي يجري المكالمة قد قرأ الرسالة المطابقة.

يتم عرضها فقط إذا كان عرض الطلب هو SEARCH_MESSAGES_VIEW_FULL وكانت بيانات اعتماد الاتصال تتضمّن أحد نطاقات التفويض التالية:

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

SearchMessagesRequest

رسالة طلب للبحث عن الرسائل

الحقول
parent

string

الحقل مطلوب. اسم المورد للمساحة المطلوب البحث فيها

للبحث في جميع المساحات التي يمكن للمستخدم الوصول إليها، اضبط هذا الحقل على spaces/-. يؤدي استخدام أي قيمة أخرى لسمة parent إلى ظهور خطأ INVALID_ARGUMENT.

لحصر البحث في مساحة واحدة أو أكثر، استخدِم space.name أو space.display_name في filter.
filter

string

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

يمكن أن يحدّد طلب البحث كلمة بحث رئيسية واحدة أو أكثر، والتي تُستخدم لفلترة النتائج،

يمكنك أيضًا فلترة النتائج باستخدام حقول الرسائل التالية:

  • ‫create_time: يقبل طابعًا زمنيًا بتنسيق RFC-3339، وعوامل المقارنة المتوافقة هي: < و>=.
  • ‫sender.name: اسم المورد الخاص بالمُرسِل (users/{user}). لا يتوافق إلا مع =. يمكنك استخدام عنوان البريد الإلكتروني كعنوان بديل لـ {user}. على سبيل المثال، users/example@gmail.com، حيث يمثّل example@gmail.com البريد الإلكتروني لمستخدم Google Chat.
  • ‫space.name: اسم المورد للمساحة التي تم نشر الرسالة فيها (spaces/{space}). يُسمح باستخدام = فقط. في حال عدم ضبط هذا الفلتر، يتم إجراء البحث في جميع الرسائل المباشرة والمساحات التي يمكن للمستخدم الوصول إليها كعضو في المساحة.
  • ‫space.display_name: تتيح استخدام عامل التشغيل : (has) وتفلتر المساحات استنادًا إلى تطابق جزئي لاسمها المعروض. تقتصر النتائج على أفضل خمس مساحات مطابقة. على سبيل المثال، يبحث space.display_name:Project عن الرسائل في أهم خمس مساحات تحتوي على كلمة "مشروع" في أسمائها المعروضة.
  • ‫space.space_type: نوع المساحة هذه الخطة متاحة مع = فقط. على سبيل المثال، يعرض عامل التشغيل space.space_type="DIRECT_MESSAGE" الرسائل من الرسائل المباشرة فقط. القيم المحتمَلة هي DIRECT_MESSAGE وGROUP_CHAT وSPACE.
  • attachment: تتيح استخدام عامل التشغيل :* (has any) للتحقّق من وجود مرفقات. في حال تحديد attachment:*، يتم عرض الرسائل التي تحتوي على مرفق واحد على الأقل فقط.
  • ‫annotations.user_mentions.user.name: اسم المورد للمستخدم المذكور (users/{user}). يتوافق فقط مع : (has). على سبيل المثال: يعرض annotations.user_mentions.user.name:"users/1234567890" الرسائل التي تتضمّن إشارة إلى المستخدم المحدّد فقط. بدلاً من ذلك، يمكن استخدام الاسم المستعار me لفلترة الرسائل التي تشير إلى المستخدم المتصل، على سبيل المثال: annotations.user_mentions.user.name:users/me. يمكنك أيضًا استخدام عنوان البريد الإلكتروني كعنوان بديل لـ {user}، على سبيل المثال، users/example@gmail.com.

للفلترة المتقدّمة، تتوفّر أيضًا الدوال التالية:

  • ‫has_link(): تعرض هذه السمة الرسائل التي تحتوي على رابط تشعّبي واحد على الأقل في نص الرسالة.
  • is_unread(): لفلترة الرسائل التي قرأها المستخدم الذي يجري المكالمة

يتطلب استخدام الفلترَين space.display_name أو space.space_type أن تتضمّن بيانات اعتماد الاتصال أحد نطاقات التفويض التالية:

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

يتطلب استخدام فلتر is_unread() أن تتضمن بيانات اعتماد الاتصال أحد نطاقات التفويض التالية:

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

في الحقول المختلفة، لا يُسمح إلا بعوامل التشغيل AND. مثال صالح: sender.name = "users/1234567890" AND is_unread(). الكلمة AND اختيارية ويتم تضمينها في حال حذفها. على سبيل المثال، السمة sender.name = "users/1234567890" is_unread() صالحة وتعادل المثال السابق. ومن الأمثلة غير الصالحة sender.name = "users/1234567890" OR is_unread() لأنّ OR غير متاح بين الحقول المختلفة.

في المجال نفسه:

  • لا تتيح السمة create_time سوى استخدام AND، ولا يمكن استخدامها إلا لتمثيل فترة زمنية، مثل create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00".
  • يتوافق sender.name مع عامل التشغيل OR فقط، على سبيل المثال: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
  • يتوافق space.name مع عامل التشغيل OR فقط، على سبيل المثال: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
  • يتيح space.display_name استخدام عاملَي التشغيل AND وOR، ولكن ليس مزيجًا منهما. على سبيل المثال: يعرض space.display_name:Project AND space.display_name:Tasks الرسائل الموجودة في المساحات التي تحتوي أسماؤها المعروضة على كل من Project وTasks، بينما يعرض space.display_name:Project OR space.display_name:Tasks الرسائل الموجودة في المساحات التي تحتوي أسماؤها المعروضة على Project أو Tasks أو كليهما.
  • يتوافق space.space_type مع عامل التشغيل OR فقط، على سبيل المثال: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
  • يتيح annotations.user_mentions.user.name استخدام عاملَي التشغيل AND وOR، ولكن ليس مزيجًا منهما. على سبيل المثال: يعرض annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" الرسائل التي تذكر كلا المستخدمَين فقط، بينما يعرض annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" الرسائل التي تذكر أيًا من المستخدمَين أو كليهما.

يجب استخدام الأقواس لتوضيح أولوية عوامل التشغيل عند الجمع بين عاملَي التشغيل AND وOR في طلب البحث نفسه. على سبيل المثال: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). وإلا، فإن الأقواس اختيارية.

طلبات البحث النموذجية التالية صالحة:

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

الحد الأقصى لطول طلب البحث هو 1,000 حرف.

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

int32

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

إذا لم يتم تحديدها، سيتم عرض 25 نتيجة كحد أقصى.

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

string

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

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

string

اختيارية: كيفية ترتيب قائمة النتائج

السمات المتوافقة للترتيب حسبها هي:

  • ‫create_time: لترتيب النتائج حسب وقت إنشاء الرسالة القيمة التلقائية
  • ‫relevance: لترتيب النتائج حسب مدى صلتها بموضوع البحث (معاينة المطوّر في )

الترتيب التلقائي هو create_time desc. يُسمح بترتيب واحد فقط لكل طلب بحث (create_time أو relevance). لا يتوفّر سوى الترتيب التنازلي (desc)، ويجب تحديده بعد سمة الترتيب.
markup_syntax

MarkupSyntax

اختيارية: تحدّد هذه المَعلمة البنية المطلوبة لإخراج حقل formatted_text في رسالة محادثة.
view

SearchMessagesView

اختيارية: يحدّد نوع عرض نتائج البحث المطلوب عرضه. القيمة التلقائية هي SEARCH_MESSAGES_VIEW_BASIC.

SearchMessagesView

أنواع العرض المتاحة لنتائج البحث الجزئية

عمليات التعداد
SEARCH_MESSAGES_VIEW_UNSPECIFIED القيمة التلقائية / غير المحدّدة ستستخدم واجهة برمجة التطبيقات العرض BASIC تلقائيًا.
SEARCH_MESSAGES_VIEW_BASIC يتضمّن الرسائل المطابقة فقط في النتائج، ولكن بدون بيانات وصفية إضافية. هذه هي القيمة الافتراضية.
SEARCH_MESSAGES_VIEW_FULL يتضمّن كل ما في النتائج: الرسائل المطابقة والبيانات الوصفية الإضافية.

SearchMessagesResponse

رسالة الردّ للبحث عن الرسائل

الحقول
results[]

SearchMessageResult

قائمة نتائج البحث التي تطابقت مع طلب البحث.
next_page_token

string

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

SearchSpacesRequest

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

الحقول
use_admin_access

bool

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

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

يتطلّب ذلك استخدام نطاق OAuth 2.0‏ chat.admin.spaces.readonly أو chat.admin.spaces.
page_size

int32

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

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

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

string

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

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

string

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

يمكنك البحث باستخدام المَعلمات التالية عندما يتم ضبط useAdminAccess على true:

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

عند ضبط useAdminAccess على false:

  • display_name
  • external_user_allowed
  • space_type

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

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

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

يقبل 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".

تكون أمثلة طلبات البحث التالية صالحة عند ضبط useAdminAccess على true:

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")

تكون أمثلة طلبات البحث التالية صالحة عند ضبط useAdminAccess على false:

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

الحد الأقصى لطول طلب البحث هو 1,000 حرف.

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

string

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

السمات المتوافقة للترتيب حسبها هي:

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

عندما تكون قيمة useAdminAccess هي false، يمكن استخدام create_time وrelevance فقط للترتيب. يُسمح فقط باستخدام DESC لهذه الحقول في عمليات البحث التي لا يجريها المشرفون.

في ما يلي القيم الصالحة لعملية الترتيب:

  • ‫ASC للترتيب التصاعدي القيمة التلقائية

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

في ما يلي الصيغ المتوافقة عندما يتم ضبط useAdminAccess على true:

  • 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

عند ضبط "useAdminAccess" على "false":

SearchSpacesResponse

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

الحقول
spaces[]
(deprecated)

Space

تم إيقاف هذه السمة نهائيًا: يُرجى استخدام حقل results الجديد بدلاً منها. صفحة من المساحات المطلوبة ستتم تعبئة هذا الحقل فقط عندما يتم ضبط useAdminAccess على true، وسيتم إيقافه نهائيًا لصالح حقل results الجديد.
next_page_token

string

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

لا تتم تعبئة هذا الحقل إلا عند ضبط useAdminAccess على true.
total_size

int32

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

لا تتم تعبئة هذا الحقل إلا عند ضبط useAdminAccess على true.
results[]

SearchSpaceResult

للعرض فقط. قائمة نتائج البحث التي تطابقت مع طلب البحث

SearchSpaceResult

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

الحقول
space

Space

للعرض فقط. المساحة المطابقة

القسم

تمثّل قسمًا في Google Chat. تساعد الأقسام المستخدمين في تنظيم مساحاتهم. هناك نوعان من الأقسام:

  1. أقسام النظام: هي أقسام محدّدة مسبقًا يديرها Google Chat. تكون أسماء الموارد ثابتة، ولا يمكن إنشاؤها أو حذفها أو تعديل display_name. تشمل الأمثلة ما يلي:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. الأقسام المخصّصة: هي أقسام ينشئها المستخدم ويديرها. يتطلب إنشاء قسم مخصّص باستخدام CreateSection display_name. يمكن تعديل الأقسام المخصّصة باستخدام UpdateSection وحذفها باستخدام DeleteSection.

الحقول
name

string

المعرّف. اسم المورد للقسم

بالنسبة إلى أقسام النظام، يكون معرّف القسم عبارة عن سلسلة ثابتة:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

التنسيق: users/{user}/sections/{section}
display_name

string

اختيارية: الاسم المعروض للقسم تتم تعبئة هذا الحقل فقط للأقسام من النوع CUSTOM_SECTION. يمكن أن يتضمّن ما يصل إلى 80 حرفًا. مطلوب عند إنشاء CUSTOM_SECTION.
sort_order

int32

للعرض فقط. ترتيب القسم بالنسبة إلى الأقسام الأخرى تظهر الأقسام التي لها قيمة sort_order أقل قبل الأقسام التي لها قيمة أعلى.
type

SectionType

الحقل مطلوب. تمثّل هذه السمة نوع القسم.

SectionType

أنواع الأقسام

عمليات التعداد
SECTION_TYPE_UNSPECIFIED نوع القسم غير محدّد.
CUSTOM_SECTION قسم مخصّص
DEFAULT_DIRECT_MESSAGES القسم التلقائي الذي يحتوي على DIRECT_MESSAGE بين مستخدمَين أو مساحات GROUP_CHAT التي لا تنتمي إلى أي قسم مخصّص.
DEFAULT_SPACES المساحات التلقائية التي لا تنتمي إلى أي قسم مخصّص
DEFAULT_APPS قسم تلقائي يحتوي على التطبيقات المثبّتة لدى المستخدم

SectionItem

عنصر قسم محدّد من قِبل المستخدم يُستخدَم هذا لتمثيل عناصر القسم، مثل المساحات، المجمّعة ضمن قسم.

الحقول
name

string

المعرّف. اسم المورد لعنصر القسم

التنسيق: users/{user}/sections/{section}/items/{item}
حقل الربط item الحقل مطلوب. عنصر القسم يمكن أن يكون التعليق item إحدى القيم التالية فقط:
space

string

اختيارية: اسم مورد المساحة

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

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

لاستخدام هذا الحقل بفعالية:

  • تأكَّد من أنّ الطلبات اللاحقة متطابقة وتستخدم بيانات اعتماد المصادقة نفسها المستخدَمة في الطلب الأصلي.
  • إذا سبق أن تم إنشاء مساحة باستخدام معرّف الطلب المقدَّم، يعرض الطلب تلك المساحة. يُرجى العِلم أنّ المساحة التي يتم عرضها قد لا تكون مكتملة، إذ تعرض واجهة برمجة التطبيقات المساحة في طلبك مع اسم المورد الذي عيّنه النظام. لاسترداد أحدث البيانات الوصفية للمساحة، يمكنك طلب GetSpace.
  • تؤدي إعادة استخدام معرّف طلب حالي مع مستخدم مختلف تمّت مصادقته إلى حدوث خطأ.
memberships[]

Membership

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

تسمح المجموعة حاليًا بما يصل إلى 49 عضوية (بالإضافة إلى المتصل).

بالنسبة إلى عضوية المستخدمين، يجب أن يحتوي الحقل 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 للمشرف. يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المستعار customers/my_customer لإنشاء المساحة في مؤسسة Google Workspace نفسها التي يتوفّر فيها التطبيق.

لا تتم تعبئة هذا الحقل للرسائل المباشرة أو عندما يتم إنشاء المساحة بواسطة مستخدمين غير تابعين لـ Google Workspace.
حقل الربط space_permission_settings تمثّل إعدادات الأذونات الخاصة بمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. يمكن أن يكون التعليق space_permission_settings إحدى القيم التالية فقط:
predefined_permission_settings

PredefinedPermissionSettings

اختيارية: الإدخال فقط إعدادات أذونات المساحة المحدّدة مسبقًا، يتم إدخالها فقط عند إنشاء مساحة. إذا لم يتم ضبط الحقل، يتم إنشاء مساحة تعاون. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل PermissionSettings.

يتيح ضبط إعدادات الأذونات المحدّدة مسبقًا ما يلي:
permission_settings

PermissionSettings

اختيارية: إعدادات أذونات المساحات الحالية إدخال لتعديل إعدادات أذونات المساحة الدقيقة، حيث يتم استبدال إعدادات الأذونات الحالية. يعرض الناتج إعدادات الأذونات الحالية.

تتيح قراءة إعدادات الأذونات وتعديلها ما يلي:

AccessPermissionSetting

إعداد إذن الوصول

الحقول
principals[]

Principal

اختيارية: قائمة بدون ترتيب المستخدمون المسموح لهم بهذا الإذن

AccessPermissionSettings

الوصول إلى إعدادات الأذونات الخاصة بمساحة

الحقول
discover_space_setting

AccessPermissionSetting

اختيارية: إعداد إذن الوصول لاكتشاف المساحة
join_space_setting

AccessPermissionSetting

اختيارية: إعدادات إذن الوصول للانضمام إلى المساحة
view_space_membership_setting

AccessPermissionSetting

اختيارية: إعداد إذن الوصول لعرض عضوية المساحة يجب تحديد هذا الحقل مع PermissionSettings.view_space_membership في قناع التعديل ونص الطلب عند تعديل المستخدمين الذين يمكنهم الاطّلاع على عضوية المساحة. عند منح الإذن بالاطّلاع لجمهور مستهدف، يجب أيضًا منح PermissionSettings.view_space_membership لجميع الأعضاء في الطلب نفسه. لإزالة جمهور مستهدف حالي (على سبيل المثال، لتقييد إذن الاطّلاع على مدراء المساحات أو المدراء المساعدين فقط)، حدِّد AccessPermissionSetting فارغًا (بدون principals).

AccessSettings

يمثّل إعداد الوصول إلى المساحة.

الحقول
access_state

AccessState

للعرض فقط. يشير إلى حالة الوصول إلى المساحة.
audience

string

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

التنسيق: audiences/{audience}

لاستخدام الجمهور المستهدف التلقائي لمؤسسة Google Workspace، اضبط القيمة على audiences/default.

تتيح قراءة الجمهور المستهدف ما يلي:

لا تتم تعبئة هذا الحقل عند استخدام نطاق chat.bot مع مصادقة التطبيق.

يتطلب إعداد الجمهور المستهدف مصادقة المستخدم.
access_permission_settings

AccessPermissionSettings

اختيارية: الوصول إلى إعدادات الأذونات الخاصة بالمساحة

لضبط الجمهور المستهدف عند إنشاء مساحة، حدِّد الحقل accessSettings.audience في طلبك.

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

اختيارية: ما إذا كان مالكو المساحات (ROLE_MANAGER) لديهم هذا الإذن
members_allowed

bool

اختيارية: ما إذا كان هذا الإذن متاحًا لأعضاء المساحة الأساسيين (ROLE_MEMBER).
assistant_managers_allowed

bool

اختيارية: ما إذا كان مدراء المساحة (ROLE_ASSISTANT_MANAGER) لديهم هذا الإذن

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

اختيارية: إعدادات الردّ على الرسائل في مساحة
view_space_membership

PermissionSetting

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

PredefinedPermissionSettings

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

عمليات التعداد
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED غير محدد يجب عدم استخدامها.
COLLABORATION_SPACE إعداد لجعل المساحة مساحة تعاون يمكن لجميع الأعضاء نشر الرسائل فيها
ANNOUNCEMENT_SPACE إعداد لجعل المساحة مخصّصة للإشعارات حيث يمكن لمدراء المساحة فقط نشر الرسائل

أساسي

مستخدِم رئيسي يمثّل جهة تم منحها إذن الوصول

الحقول
حقل الربط principal_type نوع المستخدم المفوَّض يمكن أن يكون التعليق principal_type إحدى القيم التالية فقط:
audience

Audience

جمهور

SpaceDetails

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

الحقول
description

string

اختيارية: وصف المساحة على سبيل المثال، يمكنك وصف موضوع المناقشة في المساحة أو الغرض الوظيفي أو المشاركين.

يمكن استخدام ما يصل إلى 4,096 حرفًا.
guidelines

string

اختيارية: قواعد المساحة وتوقعاتها وآدابها

يمكن إدخال ما يصل إلى 5,000 حرف.

SpaceThreadingState

تحدّد نوع حالة سلسلة المحادثات في مساحة Chat.

عمليات التعداد
SPACE_THREADING_STATE_UNSPECIFIED محجوزة
THREADED_MESSAGES المساحات التي تتيح سلاسل المحادثات عندما يردّ المستخدمون على رسالة، يمكنهم الردّ ضمن سلسلة المحادثات، ما يحافظ على سياق الرسالة الأصلية في ردّهم.
GROUPED_MESSAGES المساحات المُسمّاة التي يتم فيها تنظيم المحادثة حسب الموضوع يتم تجميع المواضيع والردود عليها معًا.
UNTHREADED_MESSAGES

المساحات التي لا تتيح سلاسل المحادثات لا يتم استخدام حالة سلاسل المحادثات هذه في المساحة إلا في حالات خاصة، بما في ذلك:

  • مواصلة محادثة الاجتماع مع إيقاف سلاسل المحادثات عمدًا
  • المحادثات الجماعية القديمة التي تم إنشاؤها قبل عام 2022

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

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

SpaceView

عرض يحدّد الحقول التي يجب ملؤها في مورد Space. لضمان التوافق مع الإصدارات المستقبلية، ننصحك بأن يتضمّن الرمز قيمًا إضافية.

عمليات التعداد
SPACE_VIEW_UNSPECIFIED القيمة التلقائية / غير المحدّدة
SPACE_VIEW_RESOURCE_NAME_ONLY يتم ملء اسم مورد المساحة فقط.
SPACE_VIEW_EXPANDED تعبئة حقول موارد المساحة ملاحظة: لن تتم تعبئة الحقل permissionSettings. يجب أن تتضمّن الطلبات التي تحدّد SPACE_VIEW_EXPANDED نطاقات تسمح بقراءة بيانات المساحة، مثل https://www.googleapis.com/auth/chat.spaces أو https://www.googleapis.com/auth/chat.spaces.readonly.

Thread

سلسلة محادثات في مساحة Google Chat للاطّلاع على مثال على الاستخدام، يُرجى مراجعة بدء سلسلة رسائل أو الردّ عليها.

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

الحقول
name

string

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

مثلاً: spaces/{space}/threads/{thread}
thread_key

string

اختيارية: إدخال لإنشاء سلسلة محادثات أو تعديلها وفي الحالات الأخرى، يكون الحقل مخصّصًا للعرض فقط. رقم تعريف سلسلة المحادثات يمكنك إدخال ما يصل إلى 4,000 حرف.

يكون هذا المعرّف فريدًا لتطبيق Chat الذي يضبطه. على سبيل المثال، إذا أنشأت عدة تطبيقات في Chat رسالة باستخدام مفتاح سلسلة المحادثات نفسه، يتم نشر الرسائل في سلاسل محادثات مختلفة. للردّ في سلسلة محادثات أنشأها مستخدم أو تطبيق Chat آخر، حدِّد حقل سلسلة المحادثات name بدلاً من ذلك.

ThreadReadState

حالة قراءة المستخدم ضمن سلسلة محادثات، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة.

الحقول
name

string

اسم مورد حالة قراءة سلسلة المحادثات

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

Timestamp

الوقت الذي تم فيه تعديل حالة قراءة سلسلة المحادثات للمستخدم يتوافق هذا عادةً مع الطابع الزمني لآخر رسالة مقروءة في سلسلة محادثات.

UpdateAvailabilityRequest

تمثّل هذه السمة رسالة الطلب لطريقة UpdateAvailability.

الحقول
availability

Availability

الحقل مطلوب. مدى توفّر التحديث
update_mask

FieldMask

الحقل مطلوب. قائمة الحقول التي سيتم تعديلها. الحقل الوحيد الذي يمكن تعديله هو custom_status.

UpdateMembershipRequest

رسالة طلب لتعديل اشتراك

الحقول
membership

Membership

الحقل مطلوب. العضوية المطلوب تعديلها يتم تعديل الحقول المحدّدة في update_mask فقط.
update_mask

FieldMask

الحقل مطلوب. مسارات الحقول المطلوب تعديلها افصل بين القيم المتعددة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول.

مسارات الحقول المتوافقة حاليًا:

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

طلب تعديل رسالة

الحقول
message

Message

الحقل مطلوب. رسالة تحتوي على حقول معدَّلة
update_mask

FieldMask

الحقل مطلوب. مسارات الحقول المطلوب تعديلها افصل بين القيم المتعددة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول.

مسارات الحقول المتوافقة حاليًا:
allow_missing

bool

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

UpdateSectionRequest

رسالة طلب لتعديل قسم

الحقول
section

Section

الحقل مطلوب. القسم المطلوب تعديله
update_mask

FieldMask

الحقل مطلوب. القناع لتحديد الحقول المطلوب تعديلها.

مسارات الحقول المتوافقة حاليًا:

  • display_name

UpdateSpaceNotificationSettingRequest

طلب تعديل إعدادات الإشعارات في المساحة لا يتيح هذا الإجراء سوى تعديل إعدادات الإشعارات للمستخدم الذي يجري المكالمة.

الحقول
space_notification_setting

SpaceNotificationSetting

الحقل مطلوب. يجب ملء اسم المورد لإعدادات إشعارات المساحة على شكل users/{user}/spaces/{space}/spaceNotificationSetting. يتم تعديل الحقول المحدّدة في update_mask فقط.
update_mask

FieldMask

الحقل مطلوب. مسارات الحقول المتوافقة:

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

رسالة طلب لواجهة برمجة التطبيقات UpdateSpaceReadState API

الحقول
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: لتعديل وصف المساحة وإرشاداتها يجب تمرير كل من الوصف والإرشادات في طلب التعديل على النحو التالي: SpaceDetails. إذا أردت تعديل أحد الحقلَين فقط، أدخِل القيمة الحالية للحقل الآخر.

‫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".

‫access_settings.access_permission_settings: لتعديل إعدادات أذونات الوصول الخاصة بالمستخدمين الذين يمكنهم العثور على المساحة والانضمام إليها، حيث يكون الحقل spaceType هو SPACE. يجب أيضًا السماح للمستخدمين المسموح لهم بالانضمام إلى المساحة باكتشافها. لتعديل إعدادات أذونات الوصول إلى مساحة، يجب أن يكون المستخدم الذي تتم مصادقته مدير مساحة أو مساعد مدير وأن يحذف جميع أقنعة الحقول الأخرى في الطلب. لا يمكنك تعديل هذا الحقل إذا كانت المساحة في وضع الاستيراد. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة كيفية جعل مساحة قابلة للاكتشاف لمستخدمين محدّدين. لا يمكن استخدام "access_settings.access_permission_settings" مع "useAdminAccess". تشمل أقنعة الحقول المتوافقة ما يلي:

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

permission_settings: يتيح تغيير إعدادات الأذونات لمساحة معيّنة. عند تعديل إعدادات الأذونات، يمكنك فقط تحديد أقنعة الحقول permissionSettings، ولا يمكنك تعديل أقنعة الحقول الأخرى في الوقت نفسه. تشمل أقنعة الحقول المتوافقة ما يلي:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
  • permission_settings.viewSpaceMembership
use_admin_access

bool

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

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

يتطلّب ذلك نطاق OAuth 2.0 chat.admin.spaces.

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

المستخدم

مستخدم في Google Chat

عند عرضها كمخرجات من طلب، إذا كان تطبيق Chat يُجري المصادقة كمستخدم، فإنّ مخرجات مورد User (مثل واجهات برمجة التطبيقات للرسائل والاشتراكات) تملأ فقط الحقلَين name وtype لكل من المستخدمين الداخليين والخارجيين، ما لم يكونوا أعضاء في المساحة أو لديهم تقارب سابق مع المستخدم المتصل.

الحقول
name

string

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

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

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

  • ‫id لـ Person في People API. على سبيل المثال، يمثّل users/123456789 في Chat API الشخص نفسه الذي يمثّله معرّف الملف الشخصي 123456789 في People API.

  • ‫id لمستخدم في Admin SDK Directory API.

  • يمكن استخدام عنوان البريد الإلكتروني للمستخدم كعنوان بديل لـ {user} في طلبات البيانات من واجهة برمجة التطبيقات. على سبيل المثال، إذا كان معرّف الملف الشخصي للمستخدم في People API لـ "user@example.com" هو "123456789"، يمكنك استخدام "users/user@example.com" كاسم مستعار للإشارة إلى "users/123456789". ستعرض واجهة برمجة التطبيقات اسم المورد الأساسي فقط (على سبيل المثال users/123456789).
display_name

string

للعرض فقط. الاسم المعروض للمستخدم

يتم ملؤه لكل من مصادقة التطبيق ومصادقة المستخدم. تتم تعبئة هذا الحقل دائمًا للطلبات التي يتم إجراؤها باستخدام مصادقة التطبيق. عند طلب واجهتَي برمجة التطبيقات Messages API وMemberships API باستخدام مصادقة المستخدم، تتم تعبئة هذا الحقل لكل من المستخدمين الداخليين والخارجيين في sender الرسالة، والمستخدمين ضمن annotations (مثل الإشارات إلى المستخدمين)، وضمن موارد Membership، شرط أن يكون المستخدم عضوًا في المساحة أو لديه صلة سابقة بالمستخدم الذي يطلب البيانات.
avatar_url

string

للعرض فقط. عنوان URL لصورة الأفاتار الخاصة بالمستخدم

عند طلب واجهتَي برمجة التطبيقات Messages API وMemberships API باستخدام مصادقة المستخدم، تتم تعبئة هذا الحقل لكل من المستخدمين الداخليين والخارجيين في sender الرسالة، والمستخدمين ضمن annotations (مثل الإشارات إلى المستخدمين)، وضمن موارد Membership، شرط أن يكون المستخدم عضوًا في المساحة أو لديه صلة سابقة بالمستخدم الذي يطلب البيانات.
email

string

للعرض فقط. عنوان البريد الإلكتروني للمستخدِم.

عند طلب واجهتَي برمجة التطبيقات Messages API وMemberships API باستخدام مصادقة المستخدم، تتم تعبئة هذا الحقل لكل من المستخدمين الداخليين والخارجيين في sender الرسالة، والمستخدمين ضمن annotations (مثل الإشارات إلى المستخدمين)، وضمن موارد Membership، شرط أن يكون المستخدم عضوًا في المساحة أو لديه صلة سابقة بالمستخدم الذي يطلب البيانات.
domain_id

string

المعرّف الفريد لنطاق Google Workspace الخاص بالمستخدم
type

Type

نوع المستخدم
is_anonymous

bool

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

النوع

عمليات التعداد
TYPE_UNSPECIFIED القيمة التلقائية للتعداد DO NOT USE.
HUMAN مستخدم بشري
BOT مستخدم تطبيق Chat

UserMentionMetadata

البيانات الوصفية للتعليقات التوضيحية للإشارات إلى المستخدمين (@).

الحقول
user

User

المستخدم الذي تمت الإشارة إليه
type

Type

نوع الإشارة إلى المستخدم

النوع

عمليات التعداد
TYPE_UNSPECIFIED القيمة التلقائية للتعداد يجب عدم استخدامها.
ADD إضافة مستخدم إلى المساحة
MENTION الإشارة إلى مستخدم في مساحة

WidgetMarkup

الأداة هي عنصر في واجهة المستخدم يعرض النصوص والصور.

الحقول
buttons[]

Button

قائمة بالأزرار oneof dataيجب ضبط حقل واحد فقط من هذين الحقلَين.
حقل الربط data يمكن أن يحتوي WidgetMarkup على عنصر واحد فقط من العناصر التالية. يمكنك استخدام حقول WidgetMarkup متعدّدة لعرض المزيد من العناصر. يمكن أن يكون التعليق data إحدى القيم التالية فقط:
text_paragraph

TextParagraph

لعرض فقرة نصية في هذا التطبيق المصغّر
image

Image

عرض صورة في هذه الأداة
key_value

KeyValue

عرض عنصر قيمة مفتاح في هذه الأداة

زرّ

الزر A يمكن أن يكون زرًا نصيًا أو زر صورة.

الحقول

حقل الربط type

يمكن أن يكون التعليق type إحدى القيم التالية فقط:
text_button

TextButton

زر يتضمّن نصًا وإجراء onclick.
image_button

ImageButton

زر يتضمّن صورة وإجراء onclick.

FormAction

يصف إجراء النموذج السلوك عند إرسال النموذج. على سبيل المثال، يمكنك استدعاء "برمجة تطبيقات Google" لمعالجة النموذج.

الحقول
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