Package google.chat.v1

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

ContextualAddOnMarkup

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

الترميز الذي يتيح للمطوّرين تحديد محتوى AddOn السياقي

بطاقة

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

الحقول
`header`	`CardHeader` تمثّل هذه السمة عنوان البطاقة. يحتوي العنوان عادةً على عنوان وصورة.
`sections[]`	`Section` يتم الفصل بين الأقسام باستخدام فاصل خطي.
`card_actions[]`	`CardAction` تمثّل هذه السمة إجراءات البطاقة.
`name`	`string` اسم البطاقة

CardAction

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

غير متاح في تطبيقات Google Chat

الحقول

action_label

string

كان التصنيف يظهر في عنصر قائمة الإجراءات.

on_click

OnClick

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

CardHeader

الحقول
`title`	`string` يجب تحديد العنوان. يبلغ ارتفاع العنوان قيمة ثابتة: إذا تم تحديد كل من العنوان والعنوان الفرعي، سيشغل كل منهما سطرًا واحدًا. إذا تم تحديد العنوان فقط، سيشغل كلا السطرين.
`subtitle`	`string` تمثّل هذه السمة العنوان الفرعي لعنوان البطاقة.
`image_style`	`ImageStyle` نوع الصورة (على سبيل المثال، حدود مربّعة أو حدود دائرية)
`image_url`	`string` عنوان URL الخاص بالصورة في عنوان البطاقة

ImageStyle

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

القسم

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

الحقول

header

string

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

widgets[]

WidgetMarkup

يجب أن يحتوي القسم على أداة واحدة على الأقل.

CreateCustomEmojiRequest

طلب لإنشاء رمز إيموجي مخصّص

الحقول

custom_emoji

الحقل مطلوب. رمز الإيموجي المخصّص الذي تريد إنشاءه

CreateMembershipRequest

طلب إنشاء عضوية

الحقول

parent

string

الحقل مطلوب. تمثّل هذه السمة الاسم الكامل للمساحة التي سيتم إنشاء العضوية فيها.

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

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 Person هو 123456789 لـ user@example.com، يمكنك إضافة المستخدم إلى المساحة عن طريق ضبط 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.admin.memberships نطاق OAuth 2.0.

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

CreateMessageRequest

تنشئ هذه الطريقة رسالة.

الحقول
`parent`	`string` الحقل مطلوب. اسم المورد للمساحة التي سيتم إنشاء الرسالة فيها. التنسيق: `spaces/{space}`
`message`	`Message` الحقل مطلوب. نص الرسالة
`thread_key (deprecated)`	`string` تم إيقاف هذا العنصر نهائيًا. اختيارية: تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة `thread.thread_key` بدلاً منها. معرّف سلسلة المحادثات يمكن أن يتضمّن ما يصل إلى 4,000 حرف. لبدء سلسلة محادثات أو إضافة رسالة إليها، أنشئ رسالة وحدِّد `threadKey` أو `thread.name`. للاطّلاع على أمثلة على الاستخدام، يُرجى الانتقال إلى بدء سلسلة محادثات أو الردّ عليها.
`request_id`	`string` اختيارية: معرّف طلب فريد لهذه الرسالة. يؤدي تحديد رقم تعريف طلب حالي إلى عرض الرسالة التي تم إنشاؤها باستخدام رقم التعريف هذا بدلاً من إنشاء رسالة جديدة.
`message_reply_option`	`MessageReplyOption` اختيارية: تحدّد هذه السمة ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة. عند الردّ على تفاعلات المستخدمين، يتم تجاهل هذا الحقل. بالنسبة إلى التفاعلات داخل سلسلة محادثات، يتم إنشاء الرد في سلسلة المحادثات نفسها. بخلاف ذلك، يتم إنشاء الرد كسلسلة محادثات جديدة.
`message_id`	`string` اختيارية: معرّف مخصّص للرسالة. تتيح تطبيقات Lets Chat الحصول على رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين المعرّف الذي يحدّده النظام في اسم مورد الرسالة (الممثّل في حقل الرسالة `name`). يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية: يبدأ بـ "`client-`". على سبيل المثال، `client-custom-name` هو معرّف مخصّص صالح، ولكن `custom-name` ليس كذلك. يحتوي على ما يصل إلى 63 حرفًا وأحرف صغيرة وأرقام وواصلات فقط. أن يكون فريدًا ضمن مساحة لا يمكن لتطبيق Chat استخدام المعرّف المخصّص نفسه لرسائل مختلفة. لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة.

MessageReplyOption

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

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

CreateReactionRequest

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

الحقول

parent

string

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

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

reaction

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

CreateSectionRequest

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

الحقول

parent

string

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

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

section

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

CreateSpaceRequest

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

الحقول

space

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

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

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

request_id

string

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

CustomEmoji

يمثّل هذا النوع رمز إيموجي مخصّص.

الحقول
`name`	`string` المعرّف اسم مصدر الإيموجي المخصّص، الذي يحدّده الخادم التنسيق: `customEmojis/{customEmoji}`
`uid`	`string` النتائج فقط. مفتاح فريد لمصدر رموز الإيموجي المخصّصة.
`emoji_name`	`string` اختيارية: غير قابل للتغيير اسم الإيموجي المخصّص الذي يقدّمه المستخدم، وهو اسم فريد داخل المؤسسة. مطلوب عند إنشاء رمز الإيموجي المخصّص، ويكون الناتج فقط في الحالات الأخرى. يجب أن تبدأ أسماء الرموز التعبيرية وتنتهي بنقطتين رأسيتين، ويجب أن تكون بأحرف صغيرة ويمكن أن تحتوي فقط على أحرف أبجدية رقمية وواصلات وشرطات سفلية. يجب استخدام الواصلات والشرطات السفلية لفصل الكلمات ولا يمكن استخدامها بشكل متتابع. مثال: `:valid-emoji-name:`
`temporary_image_uri`	`string` النتائج فقط. عنوان URL مؤقت للصورة الخاصة برمز الإيموجي المخصّص، ويكون صالحًا لمدة 10 دقائق على الأقل. يُرجى العِلم أنّه لا تتم تعبئة هذا الحقل في الرد عند إنشاء رمز الإيموجي المخصّص.
`payload`	`CustomEmojiPayload` اختيارية: الإدخال فقط بيانات الحمولة مطلوب عند إنشاء رمز الإيموجي المخصّص.

CustomEmojiPayload

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

الحقول

file_content

bytes

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

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

filename

string

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

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

CustomEmojiMetadata

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

الحقول

custom_emoji

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

DeleteCustomEmojiRequest

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

الحقول

name

string

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

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

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

DeleteMembershipRequest

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

الحقول

name

string

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

عند حذف عضوية مستخدم، يجب توفُّر نطاق 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.admin.memberships نطاق OAuth 2.0.

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

DeleteMessageRequest

طلب حذف رسالة

الحقول

name

string

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

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

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

force

bool

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

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

DeleteReactionRequest

يحذف هذا الإجراء تفاعلاً مع رسالة.

الحقول

name

string

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

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

DeleteSectionRequest

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

الحقول

name

string

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

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

DeleteSpaceRequest

طلب حذف مساحة

الحقول

name

string

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

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

use_admin_access

bool

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

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

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

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`	حذف أحد أعضاء المساحة الرسالة. يمكن للمستخدمين حذف الرسائل التي ترسلها التطبيقات.

مربّع حوار

حاوية حول نص بطاقة مربّع الحوار

الحقول

body

Card

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

DialogAction

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

الحقول

action_status

ActionStatus

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

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

dialog

Dialog

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

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 المرتبط

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

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

الحقول

حقل الدمج content الحقل مطلوب. محتوى الإيموجي يمكن أن تكون content إحدى القيم التالية فقط:

unicode

string

اختيارية: إيموجي أساسي ممثّل بسلسلة يونيكود

custom_emoji

رمز إيموجي مخصّص

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

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

الحقول
`user[]`	`string` أسماء الموارد لجميع المستخدمين من البشر في محادثة جماعية مع المستخدم الذي يجري المكالمة لا يمكن تضمين تطبيقات المحادثة في الطلب. التنسيق: `users/{user}`، حيث يمثّل `{user}` إما `id` الشخص من People API أو `id` المستخدم في Directory API. على سبيل المثال، للعثور على جميع المحادثات الجماعية التي تضم المستخدم الذي يجري المكالمة ومستخدمَين آخرَين، مع أرقام تعريف الملف الشخصي `123456789` و`987654321` في People API، يمكنك استخدام `users/123456789` و`users/987654321`. يمكنك أيضًا استخدام عنوان البريد الإلكتروني كاسم مستعار لـ `{user}`. على سبيل المثال، `users/example@gmail.com` حيث `example@gmail.com` هو البريد الإلكتروني لمستخدم Google Chat. عندما يكون المستخدم الذي يجري المكالمة من مستخدمي Google Workspace، يجب أن يكون جميع المستخدمين المطلوبين أعضاءً في مؤسسة Google Workspace نفسها التي ينتمي إليها المستخدم الذي يجري المكالمة.
`page_size`	`int32` اختيارية: الحد الأقصى لعدد المسافات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 100 مساحة على الأكثر. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة الخطأ `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[]

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

next_page_token

string

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

GetAttachmentRequest

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

الحقول

name

string

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

GetCustomEmojiRequest

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

الحقول

name

string

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

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

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.admin.memberships أو chat.admin.memberships.readonly نطاقات OAuth 2.0.

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

GetMessageRequest

طلب تلقّي رسالة

الحقول

name

string

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

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

GetSpaceEventRequest

طلب رسالة للحصول على حدث في مساحة

الحقول

name

string

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

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

GetSpaceNotificationSettingRequest

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

الحقول

name

string

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

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

GetSpaceReadStateRequest

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

الحقول

name

string

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

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

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

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

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

GetSpaceRequest

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

الحقول

name

string

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

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

use_admin_access

bool

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

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

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

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

Format: 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[]

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

next_page_token

string

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 لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب ذلك نطاق OAuth 2.0 `chat.admin.memberships.readonly` أو `chat.admin.memberships`. لا تتوفّر إمكانية إدراج عضويات التطبيقات في مساحة عند استخدام إذن الوصول كمشرف.

ListMembershipsResponse

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

الحقول

memberships[]

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

next_page_token

string

ListMessagesRequest

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

الحقول
`parent`	`string` الحقل مطلوب. اسم المورد للمساحة التي سيتم عرض الرسائل منها. التنسيق: `spaces/{space}`
`page_size`	`int32` اختيارية: الحدّ الأقصى لعدد الرسائل التي يتم عرضها قد تُرجع الخدمة عددًا من الرسائل أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 25 نتيجة على الأكثر. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000. تعرض القيم السالبة الخطأ `INVALID_ARGUMENT`.
`page_token`	`string` اختيارية: رمز مميز للصفحة تم استلامه من طلب سابق لعرض قائمة بالرسائل. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة. قد يؤدي تمرير قيم مختلفة إلى المَعلمات الأخرى إلى نتائج غير متوقّعة.
`filter`	`string` اختيارية: فلتر طلب البحث يمكنك فلترة الرسائل حسب التاريخ (`create_time`) وسلسلة المحادثات (`thread.name`). لفلترة الرسائل حسب تاريخ إنشائها، حدِّد `create_time` باستخدام طابع زمني بالتنسيق RFC-3339 وعلامات اقتباس مزدوجة. على سبيل المثال، `"2023-04-21T11:30:00-04:00"`. يمكنك استخدام عامل التشغيل "أكبر من" `>` لعرض قائمة بالرسائل التي تم إنشاؤها بعد طابع زمني معيّن، أو عامل التشغيل "أصغر من" `<` لعرض قائمة بالرسائل التي تم إنشاؤها قبل طابع زمني معيّن. لفلترة الرسائل ضمن فاصل زمني، استخدِم عامل التشغيل `AND` بين طابعَين زمنيَّين. للتصفية حسب سلسلة المحادثات، حدِّد `thread.name` بالتنسيق `spaces/{space}/threads/{thread}`. يمكنك تحديد `thread.name` واحد فقط لكل طلب بحث. للفلترة حسب كل من السلسلة والتاريخ، استخدِم عامل التشغيل `AND` في طلب البحث. على سبيل المثال، الاستعلامات التالية صالحة: `create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123` يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ `INVALID_ARGUMENT`.
`order_by`	`string` اختيارية: كيفية ترتيب قائمة الرسائل تحديد قيمة للترتيب حسب عملية ترتيب في ما يلي قيم عملية الترتيب الصالحة: `ASC` للترتيب التصاعدي `DESC` للترتيب التنازلي الترتيب التلقائي هو `create_time ASC`.
`show_deleted`	`bool` اختيارية: تحديد ما إذا كان سيتم تضمين الرسائل المحذوفة تتضمّن الرسائل المحذوفة وقت الحذف والبيانات الوصفية المتعلقة به، ولكن لا يتوفّر محتوى الرسائل.

ListMessagesResponse

رسالة الردّ لعرض الرسائل

الحقول

messages[]

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

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[]

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

next_page_token

string

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

ListSectionItemsRequest

رسالة الطلب لعناصر قسم بيانات المؤسسة

الحقول
`parent`	`string` الحقل مطلوب. تمثّل هذه السمة القسم الرئيسي، وهو اسم مورد القسم الذي يملك هذه المجموعة من عناصر القسم. لا يتيح سوى عناصر قسم قائمة المستخدم الذي يجري الاتصال. التنسيق: `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[]

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

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`) باستخدام عامل التشغيل has `:`. للفلترة حسب أنواع أحداث متعدّدة، استخدِم عامل التشغيل `OR`. احذف أنواع أحداث الدفعات من الفلتر. يعرض الطلب تلقائيًا أي أحداث دفعات ذات صلة. على سبيل المثال، إذا كنت تريد فلترة النتائج حسب التفاعلات الجديدة (`google.workspace.chat.reaction.v1.created`)، سيعرض الخادم أيضًا أحداث التفاعلات الجديدة المجمّعة (`google.workspace.chat.reaction.v1.batchCreated`). للاطّلاع على قائمة بأنواع الأحداث المتوافقة، راجِع المستندات المرجعية `SpaceEvents`. يمكنك أيضًا فلترة البيانات حسب وقت البدء (`start_time`) ووقت الانتهاء (`end_time`): ‫`start_time`: الطابع الزمني الحصري الذي سيتم بدء إدراج أحداث المساحة منه. يمكنك إدراج الأحداث التي وقعت قبل ما يصل إلى 28 يومًا. في حال عدم تحديدها، تعرض القوائم أحداث المساحة من آخر 28 يومًا. `end_time`: الطابع الزمني الشامل الذي يتم عرض أحداث المساحة حتى تاريخه. في حال عدم تحديدها، يتم عرض الأحداث حتى وقت الطلب. لتحديد وقت البدء أو الانتهاء، استخدِم عامل التشغيل يساوي `=` والتنسيق RFC-3339. للفلترة حسب كل من `start_time` و`end_time`، استخدِم عامل التشغيل `AND`. على سبيل المثال، الاستعلامات التالية صالحة: `start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"` `start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")` طلبات البحث التالية غير صالحة: `start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"` `event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"` يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ `INVALID_ARGUMENT`.

ListSpaceEventsResponse

رسالة الردّ لعرض أحداث المساحة

الحقول

space_events[]

SpaceEvent

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

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[]

MembershipCreatedEventData

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

next_page_token

string

MatchedUrl

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

الحقول

url

string

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

MeetSpaceLinkData

بيانات روابط مساحة الاجتماع في Meet

الحقول

meeting_code

string

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

type

Type

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

huddle_status

HuddleStatus

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

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` اختيارية: غير قابل للتغيير وقت حذف العضوية، مثلاً عندما غادر عضو مساحة أو تمت إزالته منها هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه لاستيراد العضويات السابقة في مساحات وضع الاستيراد.
حقل الدمج `memberType` تمثّل هذه السمة العضو المرتبط بهذه العضوية. قد تتم إتاحة أنواع أخرى من الأعضاء في المستقبل. يمكن أن تكون `memberType` إحدى القيم التالية فقط:
`member`	`User` اختيارية: مستخدم Google Chat أو تطبيق Google Chat الذي يتوافق معه الاشتراك إذا كان تطبيق Chat يصادق على المستخدم، ستملأ النتيجة المستخدم `name` و`type`.
`group_member`	`Group` اختيارية: مجموعة Google التي تتوافق مع العضوية تتطلّب قراءة العضويات في "مجموعات Google" أو تعديلها مصادقة المستخدم.

MembershipRole

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

عمليات التعداد
`MEMBERSHIP_ROLE_UNSPECIFIED`	القيمة التلقائية بالنسبة إلى `users`: هذا المستخدم ليس عضوًا في المساحة، ولكن يمكن دعوته. بالنسبة إلى `Google Groups`: يتم دائمًا تعيين هذا الدور له (قد يتم استخدام قيم تعداد أخرى في المستقبل).
`ROLE_MEMBER`	عضو في المساحة في واجهة مستخدم Chat، يُطلق على هذا الدور اسم "عضو". لدى المستخدم أذونات أساسية، مثل إرسال رسائل إلى المساحة. يمكن للمدراء والمالكين منح الأعضاء أذونات إضافية في مساحة، بما في ذلك: إضافة أعضاء أو إزالتهم تعديل تفاصيل المساحة فعِّل السجلّ أو أوقِفه. الإشارة إلى جميع المشاركين في المساحة باستخدام `@all` إدارة تطبيقات Chat وخطافات الويب المثبَّتة في المساحة في الرسائل المباشرة والمحادثات الجماعية بدون اسم، يتم منح هذا الدور لجميع المشاركين.
`ROLE_MANAGER`	مالك مساحة في واجهة مستخدم "المحادثة"، يُطلق على هذا الدور اسم "المالك". لدى المستخدم مجموعة كاملة من أذونات المساحة لإدارتها، بما في ذلك: تغيير دور الأعضاء الآخرين في المساحة إلى عضو أو مدير أو مالك احذف المساحة. لا تتوفّر هذه الميزة إلا في `SpaceType.SPACE` (المساحات المُسمّاة). لمزيد من المعلومات، يُرجى الاطّلاع على مقالة مزيد من المعلومات عن دور مالك المساحة أو مديرها.
`ROLE_ASSISTANT_MANAGER`	مدير مساحة في واجهة مستخدم "المحادثة"، يُطلق على هذا الدور اسم "مدير". يملك المستخدم جميع الأذونات الأساسية في `ROLE_MEMBER`، ويمكن للمالك منحه مجموعة فرعية من أذونات المشرف. بشكل تلقائي، يحصل المدراء على جميع أذونات المالك باستثناء القدرة على: احذف المساحة. اختيار عضو آخر ليكون مالك المساحة تغيير دور المالك تتضمّن أذونات المدراء تلقائيًا ما يلي، على سبيل المثال لا الحصر: منح عضو آخر دور مدير حذف الرسائل في المساحة إدارة أذونات المساحة تلقّي إشعارات بطلبات الانضمام إلى المساحة إذا كان لدى المدير إذن "إدارة الأعضاء" في إعدادات المساحة جعل مساحة قابلة للاكتشاف لا تتوفّر هذه الميزة إلا في `SpaceType.SPACE` (المساحات المُسمّاة). لمزيد من المعلومات، يُرجى الاطّلاع على إدارة إعدادات المساحة.

MembershipState

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

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

MembershipBatchCreatedEventData

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

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

الحقول

memberships[]

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

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

الاشتراك الجديد

MembershipDeletedEventData

حمولة الحدث الخاصة باشتراك محذوف

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

الحقول

membership

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

MembershipUpdatedEventData

حمولة الحدث الخاصة باشتراك تم تعديله

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

الحقول

membership

MessageCreatedEventData

العضوية المعدَّلة

رسالة

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

الحقول
`name`	`string` المعرّف اسم مورد الرسالة التنسيق: `spaces/{space}/messages/{message}` حيث `{space}` هو رقم تعريف المساحة التي تتم مشاركة الرسالة فيها، و`{message}` هو رقم تعريف الرسالة الذي يحدّده النظام. على سبيل المثال، `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. إذا ضبطت معرّفًا مخصّصًا عند إنشاء رسالة، يمكنك استخدام هذا المعرّف لتحديد الرسالة في طلب من خلال استبدال `{message}` بالقيمة من الحقل `clientAssignedMessageId`. على سبيل المثال، `spaces/AAAAAAAAAAA/messages/client-custom-name`. لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة.
`sender`	`User` النتائج فقط. المستخدم الذي أنشأ الرسالة إذا كان تطبيق Chat يصادق على المستخدم، ستملأ النتيجة المستخدم `name` و`type`.
`create_time`	`Timestamp` اختيارية: غير قابل للتغيير بالنسبة إلى المساحات التي تم إنشاؤها في Chat، يشير هذا الحقل إلى الوقت الذي تم فيه إنشاء الرسالة. هذا الحقل مخصّص للإخراج فقط، باستثناء استخدامه في مساحات وضع الاستيراد. بالنسبة إلى المساحات في وضع الاستيراد، اضبط هذا الحقل على الطابع الزمني السابق الذي تم فيه إنشاء الرسالة في المصدر من أجل الحفاظ على وقت الإنشاء الأصلي.
`last_update_time`	`Timestamp` النتائج فقط. الوقت الذي عدّل فيه أحد المستخدمين الرسالة آخر مرة إذا لم يتم تعديل الرسالة مطلقًا، سيكون هذا الحقل فارغًا.
`delete_time`	`Timestamp` النتائج فقط. الوقت الذي تم فيه حذف الرسالة في Google Chat إذا لم يتم حذف الرسالة مطلقًا، يكون هذا الحقل فارغًا.
`text`	`string` اختيارية: نص الرسالة العادي يؤدي الرابط الأول إلى صورة أو فيديو أو صفحة ويب إلى إنشاء شريحة معاينة. يمكنك أيضًا الإشارة إلى مستخدم Google Chat باستخدام@ أو الإشارة إلى جميع المستخدمين في المساحة. لمعرفة المزيد عن إنشاء الرسائل النصية، يُرجى الاطّلاع على إرسال رسالة.
`formatted_text`	`string` النتائج فقط. يحتوي على الرسالة `text` مع إضافة علامات لتحديد التنسيق. قد لا يعرض هذا الحقل كل التنسيق المرئي في واجهة المستخدم، ولكنّه يتضمّن ما يلي: بنية الترميز للخط الغامق والمائل والمسطّر والخط الأحادي المسافة وكتلة الخط الأحادي المسافة والقائمة النقطية إشارات المستخدمين بالتنسيق `<users/{user}>` روابط تشعّبية مخصّصة باستخدام التنسيق `<{url}\|{rendered_text}>` حيث تكون السلسلة الأولى هي عنوان URL والثانية هي النص المعروض، مثلاً `<http://example.com\|custom text>` رموز إيموجي مخصّصة باستخدام التنسيق `:{emoji_name}:`، مثل `:smile:` لا ينطبق ذلك على رموز الإيموجي بتنسيق Unicode، مثل `U+1F600` لوجه مبتسم. عناصر القائمة النقطية باستخدام علامات النجمة (``)، مثل ` item` لمزيد من المعلومات، يُرجى الاطّلاع على عرض تنسيق النص المُرسَل في رسالة.
`cards[] (deprecated)`	`Card` تم إيقاف هذا العنصر نهائيًا. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة `cards_v2` بدلاً منها. بطاقات تفاعلية ومنسَّقة وغنية بالمعلومات يمكنك استخدامها لعرض عناصر واجهة المستخدم، مثل النصوص المنسَّقة والأزرار والصور القابلة للنقر يتم عادةً عرض البطاقات أسفل نص الرسالة العادي. يمكن أن يصل حجم `cards` و`cards_v2` إلى 32 كيلوبايت كحد أقصى.
`cards_v2[]`	`CardWithId` اختيارية: صفيف من البطاقات يمكن لتطبيقات Chat فقط إنشاء بطاقات. إذا كان تطبيق Chat يصادق على هوية المستخدم، لا يمكن أن تحتوي الرسائل على بطاقات. للتعرّف على كيفية إنشاء رسالة تحتوي على بطاقات، اطّلِع على إرسال رسالة. تصميم البطاقات ومعاينتها باستخدام "أداة إنشاء البطاقات" فتح "أداة إنشاء البطاقات"
`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 في `spaces.messages.text` يتطابق مع نمط معاينة الرابط لمزيد من المعلومات، يُرجى الاطّلاع على معاينة الروابط.
`thread_reply`	`bool` النتائج فقط. عندما تكون القيمة `true`، تكون الرسالة ردًا في سلسلة ردود. عند `false`، تظهر الرسالة في المحادثة الرئيسية للمساحة إما كأول رسالة في سلسلة محادثات أو كرسالة بدون ردود في سلاسل محادثات. إذا كانت المساحة لا تتيح الردود في سلاسل محادثات، تكون قيمة هذا الحقل دائمًا `false`.
`client_assigned_message_id`	`string` اختيارية: معرّف مخصّص للرسالة. يمكنك استخدام الحقل لتحديد رسالة أو للحصول على رسالة أو حذفها أو تعديلها. لضبط معرّف مخصّص، حدِّد الحقل `messageId` عند إنشاء الرسالة. لمزيد من التفاصيل، يُرجى الاطّلاع على تسمية رسالة.
`emoji_reaction_summaries[]`	`EmojiReactionSummary` النتائج فقط. قائمة بملخّصات التفاعلات باستخدام رموز الإيموجي على الرسالة
`private_message_viewer`	`User` اختيارية: غير قابل للتغيير يُستخدم لإدخال البيانات لإنشاء رسالة، وإلا سيتم عرض الناتج فقط. المستخدم الذي يمكنه الاطّلاع على الرسالة عند ضبط هذا الحقل، تكون الرسالة خاصة ولا يراها سوى المستخدم المحدّد وتطبيق Chat. لتضمين هذا الحقل في طلبك، عليك طلب بيانات من Chat API باستخدام مصادقة التطبيق وحذف ما يلي: المرفقات أدوات الملحقات لمزيد من التفاصيل، يُرجى الاطّلاع على إرسال رسالة بشكل خاص.
`deletion_metadata`	`DeletionMetadata` النتائج فقط. معلومات حول رسالة محذوفة يتم حذف الرسالة عند ضبط `delete_time`.
`quoted_message_metadata`	`QuotedMessageMetadata` اختيارية: معلومات حول رسالة تقتبس منها رسالة أخرى عند إنشاء رسالة، يمكنك اقتباس رسائل ضمن سلسلة المحادثات نفسها، أو اقتباس رسالة أصلية لإنشاء رسالة أصلية جديدة. ومع ذلك، لا يمكنك اقتباس ردّ على رسالة من سلسلة محادثات مختلفة. عند تعديل رسالة، لا يمكنك إضافة الحقل `quotedMessageMetadata` أو استبداله، ولكن يمكنك إزالته. للاطّلاع على مثال على الاستخدام، يُرجى الانتقال إلى اقتباس رسالة أخرى.
`attached_gifs[]`	`AttachedGif` النتائج فقط. صور GIF المرفقة بالرسالة
`accessory_widgets[]`	`AccessoryWidget` اختيارية: عنصر تفاعلي واحد أو أكثر يظهر في أسفل الرسالة. يمكنك إضافة أدوات مصغّرة خاصة بالملحقات إلى الرسائل التي تحتوي على نص أو بطاقات أو كليهما. لا تتوافق مع الرسائل التي تحتوي على مربّعات حوار. لمزيد من التفاصيل، يُرجى الاطّلاع على إضافة أدوات تفاعلية في أسفل الرسالة. يتطلّب إنشاء رسالة باستخدام أدوات ملحقة مصادقة التطبيق.

MessageBatchCreatedEventData

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

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

الحقول

messages[]

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

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

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

MessageDeletedEventData

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

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

الحقول

message

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

MessageUpdatedEventData

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

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

الحقول

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

ReactionCreatedEventData

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

QuotedMessageMetadata

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

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

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

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

الحقول

name

string

الحقل مطلوب. اسم مصدر الرسالة التي تم اقتباسها

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

last_update_time

Timestamp

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

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

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

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

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

الحقول

name

string

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

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

user

User

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

emoji

Emoji

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

ReactionBatchCreatedEventData

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

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

الحقول

reactions[]

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

ReactionBatchDeletedEventData

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

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

الحقول

reactions[]

ReactionDeletedEventData

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

ReactionCreatedEventData

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

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

الحقول

reaction

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

ReactionDeletedEventData

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

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

الحقول

reaction

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

RichLinkMetadata

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

الحقول
`uri`	`string` معرّف الموارد المنتظم (URI) لهذا الرابط.
`rich_link_type`	`RichLinkType` تمثّل هذه السمة نوع الرابط الغني بصريًا.
حقل الدمج `data` بيانات المرجع المرتبط يمكن أن تكون `data` إحدى القيم التالية فقط:
`drive_link_data`	`DriveLinkData` بيانات رابط في Drive
`chat_space_link_data`	`ChatSpaceLinkData` بيانات رابط مساحة Chat
`meet_space_link_data`	`MeetSpaceLinkData` بيانات رابط مساحة Meet
`calendar_event_link_data`	`CalendarEventLinkData` تمثّل هذه السمة بيانات رابط حدث في "تقويم Google".

RichLinkType

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

عمليات التعداد
`RICH_LINK_TYPE_UNSPECIFIED`	القيمة التلقائية للتعداد لا تستخدِمها.
`DRIVE_FILE`	نوع رابط غني في Google Drive
`CHAT_SPACE`	نوع رابط غني بصريًا لمساحة Chat على سبيل المثال، شريحة ذكية لمساحة.
`GMAIL_MESSAGE`	نوع رابط غني لرسالة Gmail على وجه التحديد، شريحة Gmail من المشاركة في Chat. تتيح واجهة برمجة التطبيقات قراءة الرسائل التي تحتوي على روابط غنية ببيانات GMAIL_MESSAGE فقط.
`MEET_SPACE`	نوع رابط غني بصريًا لرسالة Meet على سبيل المثال، شريحة Meet.
`CALENDAR_EVENT`	نوع رابط غني برسالة في "تقويم Google" على سبيل المثال، شريحة "تقويم Google".

SearchSpacesRequest

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

الحقول
`use_admin_access`	`bool` عند `true`، يتم تنفيذ الطريقة باستخدام امتيازات مشرف Google Workspace الخاصة بالمستخدم. يجب أن يكون المستخدم الذي يجري المكالمة مشرفًا في Google Workspace لديه امتياز إدارة المحادثات ومحادثات المساحات. يتطلّب ذلك نطاق OAuth 2.0 `chat.admin.spaces.readonly` أو `chat.admin.spaces`. تتيح هذه الطريقة حاليًا الوصول الإداري فقط، وبالتالي يتم قبول `true` فقط لهذا الحقل.
`page_size`	`int32` الحد الأقصى لعدد المسافات المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 100 مساحة على الأكثر. الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.
`page_token`	`string` رمز مميّز تم استلامه من طلب مساحات البحث السابق. قدِّم هذه المَعلمة لاسترداد الصفحة التالية. عند تقسيم النتائج إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة. قد يؤدي تمرير قيم مختلفة إلى المَعلمات الأخرى إلى نتائج غير متوقّعة.
`query`	`string` الحقل مطلوب. طلب بحث يمكنك البحث باستخدام المَعلمات التالية: `create_time` `customer` `display_name` `external_user_allowed` `last_active_time` `space_history_state` `space_type` تقبل السمتان `create_time` و`last_active_time` طابعًا زمنيًا بتنسيق RFC-3339، وعوامل المقارنة المتوافقة هي: `=` و`<` و`>` و`<=` و`>=`. `customer` مطلوبة وتُستخدَم لتحديد العميل الذي سيتم استرداد المساحات منه. القيمة الوحيدة المسموح بها هي `customers/my_customer`. لا تقبل السمة `display_name` سوى عامل التشغيل `HAS` (`:`). يتم أولاً تقسيم النص المطلوب مطابقته إلى رموز مميزة، ثم تتم مطابقة كل رمز مميز بشكل مستقل وبدون مراعاة حالة الأحرف كجزء من سلسلة فرعية في أي مكان في `display_name` للمساحة. على سبيل المثال، يتطابق `Fun Eve` مع `Fun event` أو `The evening was fun`، ولكن ليس مع `notFun event` أو `even`. يقبل الحقل `external_user_allowed` القيمة `true` أو `false`. لا يقبل المتغيّر `space_history_state` سوى القيم من الحقل `historyState` الخاص بمورد `space`. السمة `space_type` مطلوبة والقيمة الصالحة الوحيدة هي `SPACE`. في الحقول المختلفة، لا يُسمح إلا باستخدام عوامل التشغيل `AND`. مثال صالح هو `space_type = "SPACE" AND display_name:"Hello"` ومثال غير صالح هو `space_type = "SPACE" OR display_name:"Hello"`. في الحقل نفسه، لا يتيح `space_type` استخدام عاملَي التشغيل `AND` أو `OR`. لا تتوافق السمة `display_name` وspace_history_state وexternal_user_allowed إلا مع عوامل التشغيل `OR`. يتوافق `last_active_time` و`create_time` مع عاملَي التشغيل `AND` و`OR`. لا يمكن استخدام `AND` إلا لتمثيل فاصل زمني، مثل `last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"`. طلبات البحث التالية صالحة: customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
`order_by`	`string` اختيارية: كيفية ترتيب قائمة المساحات في ما يلي السمات المتوافقة التي يمكن ترتيب النتائج حسبها: `membership_count.joined_direct_human_user_count`: يشير إلى عدد المستخدمين من البشر الذين انضموا مباشرةً إلى مساحة. `last_active_time`: يشير إلى الوقت الذي تمت فيه إضافة آخر عنصر مؤهَّل إلى أي موضوع في هذه المساحة. `create_time`: يشير إلى وقت إنشاء المساحة. في ما يلي قيم عمليات الترتيب الصالحة: `ASC` للترتيب التصاعدي القيمة التلقائية `DESC` للترتيب التنازلي بناء الجملة المتوافق هو: `membership_count.joined_direct_human_user_count DESC` `membership_count.joined_direct_human_user_count ASC` `last_active_time DESC` `last_active_time ASC` `create_time DESC` `create_time ASC`

SearchSpacesResponse

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

الحقول

spaces[]

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

next_page_token

string

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

total_size

int32

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

القسم

تمثّل هذه السمة قسمًا في Google Chat. تساعد الأقسام المستخدمين في تنظيم مساحاتهم. هناك نوعان من الأقسام:

أقسام النظام: هي أقسام محدّدة مسبقًا يديرها Google Chat. أسماء الموارد ثابتة، ولا يمكن إنشاؤها أو حذفها أو تعديل display_name. تشمل الأمثلة ما يلي:
- users/{user}/sections/default-direct-messages
- users/{user}/sections/default-spaces
- users/{user}/sections/default-apps
الأقسام المخصّصة: هي أقسام ينشئها المستخدم ويديرها. يتطلّب إنشاء قسم مخصّص باستخدام CreateSection display_name. يمكن تعديل الأقسام المخصّصة باستخدام UpdateSection وحذفها باستخدام DeleteSection.
إصدار تجريبي للمطوّرين: يتوفّر كجزء من برنامج الإصدار التجريبي للمطوّرين في Google Workspace، الذي يتيح الوصول المبكر إلى ميزات معيّنة.

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

memberships[]

اختيارية: مستخدمو 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` من مصدر بيانات العميل في Admin SDK. يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المستعار `customers/my_customer` لإنشاء المساحة في مؤسسة Google Workspace نفسها التي يتوفّر فيها التطبيق. لا تتم تعبئة هذا الحقل للرسائل المباشرة أو عندما ينشئ المساحة مستخدمون ليسوا من Google Workspace.
حقل الدمج `space_permission_settings` تمثّل هذه السمة إعدادات الأذونات الخاصة بمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة `space_type` هي `SPACE`. يمكن أن تكون `space_permission_settings` إحدى القيم التالية فقط:
`predefined_permission_settings`	`PredefinedPermissionSettings` اختيارية: الإدخال فقط إعدادات أذونات المساحة المحدّدة مسبقًا، ويجب إدخالها فقط عند إنشاء مساحة في حال عدم ضبط الحقل، يتم إنشاء مساحة تعاون. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل `PermissionSettings`. يتيح ضبط إعدادات الأذونات المحدّدة مسبقًا ما يلي: مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاقين `chat.app.spaces` أو `chat.app.spaces.create` مصادقة المستخدم
`permission_settings`	`PermissionSettings` اختيارية: إعدادات أذونات المساحة للمساحات الحالية إدخال لتعديل إعدادات أذونات المساحة المحدّدة، حيث يتم استبدال إعدادات الأذونات الحالية. تعرض هذه السمة إعدادات الأذونات الحالية للقوائم. تتيح قراءة إعدادات الأذونات وتعديلها ما يلي: مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاق `chat.app.spaces` لا تتم تعبئة هذا الحقل ولا يمكن ضبطه إلا عندما ينشئ تطبيق Chat المساحة. مصادقة المستخدم

AccessSettings

تمثّل هذه السمة إعدادات الوصول إلى المساحة.

الحقول

access_state

AccessState

النتائج فقط. تشير هذه السمة إلى حالة الوصول إلى المساحة.

audience

string

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

التنسيق: audiences/{audience}

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

تتيح قراءة الجمهور المستهدَف ما يلي:

مصادقة المستخدم
مصادقة التطبيق من خلال موافقة المشرف باستخدام النطاق chat.app.spaces

لا يتم ملء هذا الحقل عند استخدام النطاق chat.bot مع مصادقة التطبيق.

يتطلّب ضبط الجمهور المستهدف مصادقة المستخدم.

AccessState

تمثّل هذه السمة حالة الوصول إلى المساحة.

عمليات التعداد

ACCESS_STATE_UNSPECIFIED حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه.

PRIVATE يمكن فقط للمستخدمين أو "مجموعات Google" التي تمت إضافتها أو دعوتها بشكل فردي من قِبل مستخدمين آخرين أو مشرفي Google Workspace العثور على المساحة والوصول إليها.

DISCOVERABLE

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

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

MembershipCount

تمثّل هذه السمة عدد عضويات المساحة، ويتم تجميعها في فئات.

الحقول

joined_direct_human_user_count

int32

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

joined_group_count

int32

النتائج فقط. عدد جميع المجموعات التي انضمّت مباشرةً إلى المساحة

PermissionSetting

تمثّل هذه السمة إعدادات أذونات المساحة.

الحقول

managers_allowed

bool

اختيارية: تُستخدَم لتحديد ما إذا كان مالكو المساحات (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` اختيارية: إعداد للردّ على الرسائل في مساحة

PredefinedPermissionSettings

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

عمليات التعداد
`PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED`	غير محدد لا تستخدِمها.
`COLLABORATION_SPACE`	إعداد لجعل المساحة مساحة تعاون يمكن لجميع الأعضاء نشر الرسائل فيها
`ANNOUNCEMENT_SPACE`	إعداد لجعل المساحة مساحة إشعارات يمكن فيها لمدراء المساحة فقط نشر الرسائل

SpaceDetails

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

الحقول

description

string

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

يمكن أن يتضمّن ما يصل إلى 150 حرفًا.

guidelines

string

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

يمكن أن تتضمّن ما يصل إلى 5,000 حرف.

SpaceThreadingState

تحدّد هذه السمة نوع حالة سلاسل المحادثات في مساحة Chat.

عمليات التعداد
`SPACE_THREADING_STATE_UNSPECIFIED`	محجوز
`THREADED_MESSAGES`	المساحات المُسمّاة التي تتيح سلاسل المحادثات عندما يردّ المستخدمون على رسالة، يمكنهم الردّ في سلسلة المحادثات، ما يحافظ على ردّهم في سياق الرسالة الأصلية.
`GROUPED_MESSAGES`	مساحات تحمل أسماءً ويتم فيها تنظيم المحادثة حسب الموضوع يتم تجميع المواضيع وردودها معًا.
`UNTHREADED_MESSAGES`	الرسائل المباشرة بين شخصين والمحادثات الجماعية بين 3 أشخاص أو أكثر

SpaceType

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

عمليات التعداد
`SPACE_TYPE_UNSPECIFIED`	محجوز
`SPACE`	مكان يرسل فيه المستخدمون الرسائل ويشاركون الملفات ويتعاونون. يمكن أن تتضمّن `SPACE` تطبيقات Chat.
`GROUP_CHAT`	المحادثات الجماعية بين 3 أشخاص أو أكثر يمكن أن تتضمّن `GROUP_CHAT` تطبيقات Chat.
`DIRECT_MESSAGE`	الرسائل بين مستخدمَين أو بين مستخدم وتطبيق Chat

النوع

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

عمليات التعداد
`TYPE_UNSPECIFIED`	محجوز
`ROOM`	المحادثات بين شخصين أو أكثر
`DM`	رسالة مباشرة بين مستخدم بشري وتطبيق Chat، حيث تكون جميع الرسائل مسطّحة. يُرجى العِلم أنّ هذا لا يشمل الرسائل المباشرة بين شخصين.

SpaceBatchUpdatedEventData

حمولة الحدث لعمليات تعديل متعدّدة على مساحة

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

الحقول

spaces[]

SpaceUpdatedEventData

قائمة بمساحات العمل المعدَّلة

SpaceEvent

حدث يمثّل تغييرًا أو نشاطًا في مساحة Google Chat لمزيد من المعلومات، راجِع العمل مع الأحداث من Google Chat.

الحقول
`name`	`string` اسم المورد لحدث المساحة التنسيق: `spaces/{space}/spaceEvents/{spaceEvent}`
`event_time`	`Timestamp` الوقت الذي وقع فيه الحدث
`event_type`	`string` نوع حدث المساحة يحتوي كل نوع حدث على إصدار مجمّع يمثّل عدة مثيلات من نوع الحدث تحدث في فترة زمنية قصيرة. بالنسبة إلى طلبات `spaceEvents.list()`، احذف أنواع الأحداث المجمّعة في فلتر طلب البحث. يعرض الخادم تلقائيًا نوع الحدث ونسخته المجمّعة. أنواع الأحداث المتوافقة مع الرسائل: رسالة جديدة: `google.workspace.chat.message.v1.created` الرسالة المعدَّلة: `google.workspace.chat.message.v1.updated` رسالة محذوفة: `google.workspace.chat.message.v1.deleted` رسائل جديدة متعددة: `google.workspace.chat.message.v1.batchCreated` رسائل معدَّلة متعددة: `google.workspace.chat.message.v1.batchUpdated` رسائل محذوفة متعددة: `google.workspace.chat.message.v1.batchDeleted` أنواع الأحداث المتوافقة مع العضويات: اشتراك جديد: `google.workspace.chat.membership.v1.created` العضوية المعدَّلة: `google.workspace.chat.membership.v1.updated` تم حذف العضوية: `google.workspace.chat.membership.v1.deleted` اشتراكات جديدة متعددة: `google.workspace.chat.membership.v1.batchCreated` عضويات متعدّدة تم تعديلها: `google.workspace.chat.membership.v1.batchUpdated` عضويات متعددة محذوفة: `google.workspace.chat.membership.v1.batchDeleted` أنواع الأحداث المتوافقة مع التفاعلات: تفاعل جديد: `google.workspace.chat.reaction.v1.created` التفاعل المحذوف: `google.workspace.chat.reaction.v1.deleted` تفاعلات جديدة متعددة: `google.workspace.chat.reaction.v1.batchCreated` تفاعلات متعدّدة محذوفة: `google.workspace.chat.reaction.v1.batchDeleted` أنواع الأحداث المتوافقة بشأن المساحة: مساحة معدَّلة: `google.workspace.chat.space.v1.updated` تعديلات متعددة على المساحة: `google.workspace.chat.space.v1.batchUpdated`
حقل الدمج `payload` يمكن أن تكون `payload` إحدى القيم التالية فقط:
`message_created_event_data`	`MessageCreatedEventData` حمولة الحدث لرسالة جديدة نوع الحدث: `google.workspace.chat.message.v1.created`
`message_updated_event_data`	`MessageUpdatedEventData` حمولة الحدث لرسالة معدَّلة نوع الحدث: `google.workspace.chat.message.v1.updated`
`message_deleted_event_data`	`MessageDeletedEventData` حمولة الحدث لرسالة محذوفة نوع الحدث: `google.workspace.chat.message.v1.deleted`
`message_batch_created_event_data`	`MessageBatchCreatedEventData` حمولة الحدث لرسائل جديدة متعددة نوع الحدث: `google.workspace.chat.message.v1.batchCreated`
`message_batch_updated_event_data`	`MessageBatchUpdatedEventData` حمولة الحدث لعدة رسائل معدَّلة نوع الحدث: `google.workspace.chat.message.v1.batchUpdated`
`message_batch_deleted_event_data`	`MessageBatchDeletedEventData` حمولة الحدث لرسائل متعدّدة تم حذفها نوع الحدث: `google.workspace.chat.message.v1.batchDeleted`
`space_updated_event_data`	`SpaceUpdatedEventData` حمولة الحدث لتعديل مساحة نوع الحدث: `google.workspace.chat.space.v1.updated`
`space_batch_updated_event_data`	`SpaceBatchUpdatedEventData` حمولة الحدث لعمليات تعديل متعدّدة على مساحة نوع الحدث: `google.workspace.chat.space.v1.batchUpdated`
`membership_created_event_data`	`MembershipCreatedEventData` حمولة الحدث لاشتراك جديد نوع الحدث: `google.workspace.chat.membership.v1.created`
`membership_updated_event_data`	`MembershipUpdatedEventData` حمولة الحدث الخاصة باشتراك تم تعديله نوع الحدث: `google.workspace.chat.membership.v1.updated`
`membership_deleted_event_data`	`MembershipDeletedEventData` حمولة الحدث الخاصة باشتراك محذوف نوع الحدث: `google.workspace.chat.membership.v1.deleted`
`membership_batch_created_event_data`	`MembershipBatchCreatedEventData` حمولة الحدث الخاصة بالاشتراكات الجديدة المتعددة نوع الحدث: `google.workspace.chat.membership.v1.batchCreated`
`membership_batch_updated_event_data`	`MembershipBatchUpdatedEventData` حمولة الحدث لعدة اشتراكات معدَّلة نوع الحدث: `google.workspace.chat.membership.v1.batchUpdated`
`membership_batch_deleted_event_data`	`MembershipBatchDeletedEventData` حمولة الحدث للعضويات المحذوفة المتعددة نوع الحدث: `google.workspace.chat.membership.v1.batchDeleted`
`reaction_created_event_data`	`ReactionCreatedEventData` حمولة الحدث لتفاعل جديد نوع الحدث: `google.workspace.chat.reaction.v1.created`
`reaction_deleted_event_data`	`ReactionDeletedEventData` حمولة الحدث لتفاعل محذوف نوع الحدث: `google.workspace.chat.reaction.v1.deleted`
`reaction_batch_created_event_data`	`ReactionBatchCreatedEventData` حمولة الحدث لعدّة تفاعلات جديدة نوع الحدث: `google.workspace.chat.reaction.v1.batchCreated`
`reaction_batch_deleted_event_data`	`ReactionBatchDeletedEventData` حمولة الحدث لعدة تفاعلات محذوفة نوع الحدث: `google.workspace.chat.reaction.v1.batchDeleted`

SpaceNotificationSetting

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

الحقول

name

string

المعرّف تمثّل هذه السمة اسم مورد إعدادات إشعارات المساحة. التنسيق: users/{user}/spaces/{space}/spaceNotificationSetting

notification_setting

NotificationSetting

إعدادات الإشعارات

mute_setting

MuteSetting

إعداد تجاهل الإشعارات في المساحة

MuteSetting

أنواع إعدادات كتم إشعارات المساحة

عمليات التعداد
`MUTE_SETTING_UNSPECIFIED`	محجوز
`UNMUTED`	سيتلقّى المستخدم إشعارات بشأن المساحة استنادًا إلى إعدادات الإشعارات.
`MUTED`	لن يتلقّى المستخدم أي إشعارات بشأن المساحة، بغض النظر عن إعدادات الإشعارات.

NotificationSetting

أنواع إعدادات الإشعارات وقد يتم توفير أنواع أخرى في المستقبل.

عمليات التعداد
`NOTIFICATION_SETTING_UNSPECIFIED`	محجوز
`ALL`	يتم إرسال الإشعارات عند الإشارة إلى شخص باستخدام @أو عند متابعة سلاسل المحادثات أو عند إرسال الرسالة الأولى في سلاسل المحادثات الجديدة. تتم متابعة جميع سلاسل المحادثات الجديدة تلقائيًا، ما لم يلغِ المستخدم متابعتها يدويًا.
`MAIN_CONVERSATIONS`	يتم تشغيل الإشعار عند الإشارة إلى شخص باستخدام @أو في سلاسل المحادثات التي تتم متابعتها أو عند إرسال أول رسالة في سلاسل المحادثات الجديدة. لا تتوفّر للرسائل المباشرة بين شخصين.
`FOR_YOU`	يتم تشغيل الإشعار عند الإشارة إليك باستخدام @أو في سلاسل المحادثات التي تتابعها. لا تتوفّر للرسائل المباشرة بين شخصين.
`OFF`	الإشعار غير مفعّل.

SpaceReadState

حالة القراءة الخاصة بالمستخدم في مساحة، تُستخدَم لتحديد الرسائل المقروءة وغير المقروءة

الحقول

name

string

اسم المورد لحالة القراءة في المساحة

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

last_read_time

Timestamp

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

SpaceUpdatedEventData

حمولة الحدث لمساحة تم تعديلها

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

الحقول

space

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

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

الوقت الذي تم فيه تعديل حالة قراءة سلسلة المحادثات للمستخدم يتطابق هذا الحقل عادةً مع الطابع الزمني لآخر رسالة تمت قراءتها في سلسلة محادثات.

UpdateMembershipRequest

رسالة طلب تعديل اشتراك

الحقول

membership

الحقل مطلوب. الاشتراك المطلوب تعديله. يتم تعديل الحقول المحدّدة بواسطة update_mask فقط.

update_mask

الحقل مطلوب. مسارات الحقول المطلوب تعديلها. افصل بين القيم المتعددة بفواصل أو استخدِم * لتعديل جميع مسارات الحقول.

مسارات الحقول المتوافقة حاليًا:

role

use_admin_access

bool

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

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

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

UpdateMessageRequest

طلب تعديل رسالة

الحقول

message

الحقل مطلوب. رسالة تحتوي على حقول معدَّلة

update_mask

مسارات الحقول المتوافقة حاليًا:

text
attachment
cards (يتطلّب مصادقة التطبيق)
cards_v2 (يتطلّب مصادقة التطبيق)
accessory_widgets (يتطلّب مصادقة التطبيق)
quoted_message_metadata (يسمح فقط بإزالة الرسالة المُقتبَسة).

allow_missing

bool

اختيارية: إذا لم يتم العثور على الرسالة التي تحمل true، سيتم إنشاء رسالة جديدة وسيتم تجاهل updateMask. يجب أن يكون معرّف الرسالة المحدّد معرّفًا يحدّده العميل، وإلا سيتعذّر تنفيذ الطلب.

UpdateSectionRequest

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

الحقول

section

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

update_mask

SpaceNotificationSetting

الحقل مطلوب. القناع لتحديد الحقول المطلوب تعديلها.

مسارات الحقول المتوافقة حاليًا:

display_name

UpdateSpaceNotificationSettingRequest

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

الحقول

space_notification_setting

الحقل مطلوب. يجب ملء اسم المورد لإعدادات إشعارات المساحة بالتنسيق users/{user}/spaces/{space}/spaceNotificationSetting. يتم تعديل الحقول المحدّدة بواسطة update_mask فقط.

update_mask

الحقل مطلوب. مسارات الحقول المتوافقة:

notification_setting
mute_setting

UpdateSpaceReadStateRequest

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

الحقول

space_read_state

SpaceReadState

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

يتيح هذا الحقل تعديل حالة القراءة للمستخدم الذي يجري المكالمة فقط.

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

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

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

update_mask

الحقل مطلوب. مسارات الحقول المطلوب تعديلها. مسارات الحقول المتوافقة حاليًا:

last_read_time

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

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

UpdateSpaceRequest

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

الحقول

space

الحقل مطلوب. مساحة تتضمّن الحقول المطلوب تعديلها يجب ملء السمة Space.name بالتنسيق spaces/{space}. يتم تعديل الحقول المحدّدة بواسطة update_mask فقط.

update_mask