User

مستخدم في Google Chat

عندما يتم عرضها كنتيجة لطلب، إذا كان تطبيق Chat يصادق على المستخدم، لن يتم ملء الحقلَين name وtype في نتيجة مصدر User (مثل واجهات برمجة التطبيقات "الرسائل" و"العضويات") إلا للمستخدمين الداخليين والخارجيين، ما لم يكونوا أعضاء في المساحة أو لديهم علاقة سابقة مع المستخدم الذي أرسل الطلب.

تمثيل JSON
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
الحقول
name

string

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

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

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

  • id الخاص بـ Person في People API على سبيل المثال، يمثّل المعرّف users/123456789 في Chat API الشخص نفسه الذي يمثّله معرّف ملف شخصي 123456789 في People API.

  • id للمستخدم في Admin SDK Directory API

  • يمكن استخدام عنوان البريد الإلكتروني للمستخدم كاسم مستعار لـ {user} في طلبات واجهة برمجة التطبيقات. على سبيل المثال، إذا كان معرّف الملف الشخصي user@example.com في People API هو 123456789، يمكنك استخدام users/user@example.com كاسم مستعار للإشارة إلى users/123456789. سيتم عرض اسم المورد الأساسي فقط (مثل users/123456789) من واجهة برمجة التطبيقات.

displayName

string

النتائج فقط. الاسم المعروض للمستخدم

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

avatarUrl

string

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

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

email

string

النتائج فقط. عنوان البريد الإلكتروني للمستخدِم.

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

domainId

string

المعرّف الفريد لنطاق Google Workspace الخاص بالمستخدم.

type

enum (Type)

نوع المستخدم

isAnonymous

boolean

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

النوع

عمليات التعداد
TYPE_UNSPECIFIED القيمة التلقائية للتعداد لا تستخدم هذا الحقل.
HUMAN مستخدم بشري
BOT مستخدم تطبيق Chat