User

یک کاربر در گوگل چت.

وقتی به عنوان خروجی از یک درخواست برگردانده می‌شود، اگر برنامه چت شما به عنوان یک کاربر احراز هویت شود ، خروجی برای یک منبع User (مانند APIهای پیام‌ها و عضویت‌ها) فقط فیلدهای name و type را برای کاربران داخلی و خارجی پر می‌کند، مگر اینکه آنها عضو آن فضا باشند یا از قبل با کاربر فراخواننده ارتباط داشته باشند.

نمایش JSON 
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
فیلدها
name

string

نام منبع برای یک user گوگل چت.

فرمت: users/{user} . users/app می‌تواند به عنوان نام مستعار برای کاربر bot برنامه فراخوانی کننده استفاده شود.

برای human users ، {user} همان شناسه کاربری زیر است:

  • id شخص در People API. برای مثال، users/123456789 در Chat API همان شخصی را نشان می‌دهد که شناسه‌ی پروفایل Person با شناسه‌ی 123456789 در People API دارد.

  • id یک کاربر در API دایرکتوری SDK مدیریت.

  • آدرس ایمیل کاربر می‌تواند به عنوان نام مستعار برای {user} در درخواست‌های API استفاده شود. برای مثال، اگر شناسه پروفایل Person در API People برای user@example.com برابر با 123456789 باشد، می‌توانید users/user@example.com به عنوان نام مستعار برای ارجاع به users/123456789 استفاده کنید. فقط نام منبع متعارف (برای مثال users/123456789 ) از API بازگردانده می‌شود.

displayName

string

فقط خروجی. نام نمایشی کاربر.

برای احراز هویت برنامه و احراز هویت کاربر پر می‌شود. این فیلد همیشه برای درخواست‌های انجام شده با احراز هویت برنامه پر می‌شود. هنگام فراخوانی APIهای پیام‌ها و عضویت‌ها با احراز هویت کاربر ، این فیلد برای کاربران داخلی و خارجی برای sender پیام، کاربران درون annotations (مانند اشاره‌های کاربر) و درون منابع Membership ، در صورتی که کاربر عضو فضا باشد یا ارتباط قبلی با کاربر فراخواننده داشته باشد، پر می‌شود.

avatarUrl

string

فقط خروجی. آدرس اینترنتی تصویر آواتار کاربر.

هنگام فراخوانی APIهای پیام‌ها و عضویت‌ها با احراز هویت کاربر ، این فیلد برای کاربران داخلی و خارجی برای sender پیام، کاربران درون annotations (مانند اشاره‌های کاربر) و درون منابع Membership ، در صورتی که کاربر عضو آن فضا باشد یا از قبل با کاربر فراخواننده ارتباط داشته باشد، پر می‌شود.

email

string

فقط خروجی. آدرس ایمیل کاربر.

هنگام فراخوانی APIهای پیام‌ها و عضویت‌ها با احراز هویت کاربر ، این فیلد برای کاربران داخلی و خارجی برای sender پیام، کاربران درون annotations (مانند اشاره‌های کاربر) و درون منابع Membership ، در صورتی که کاربر عضو آن فضا باشد یا از قبل با کاربر فراخواننده ارتباط داشته باشد، پر می‌شود.

domainId

string

شناسه منحصر به فرد دامنه Google Workspace کاربر.

type

enum ( Type )

نوع کاربر.

isAnonymous

boolean

فقط خروجی. وقتی true ، کاربر حذف می‌شود یا پروفایل او قابل مشاهده نیست، مانند زمانی که از کاربری در یک فاصله بدون عضویت و بدون ارتباط قبلی با کاربر فراخواننده نام برده می‌شود.

نوع

انوم‌ها
TYPE_UNSPECIFIED مقدار پیش‌فرض برای enum. استفاده نکنید.
HUMAN کاربر انسانی.
BOT کاربر برنامه چت