User

Một người dùng trong Google Chat.

Khi được trả về dưới dạng đầu ra từ một yêu cầu, nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì đầu ra cho tài nguyên User (chẳng hạn như trong API Tin nhắn và API Thành viên) sẽ chỉ điền các trường name và type cho cả người dùng nội bộ và bên ngoài, trừ phi họ là thành viên của không gian hoặc có mối quan hệ thân thiết trước đó với người dùng gọi.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Trường
name

string

Tên tài nguyên cho một user Google Chat.

Định dạng: users/{user}. users/app có thể được dùng làm bí danh cho người dùng bot của ứng dụng gọi.

Đối với human users, {user} là giá trị nhận dạng người dùng giống như:

  • id cho Person trong People API. Ví dụ: users/123456789 trong Chat API đại diện cho cùng một người với mã hồ sơ 123456789 trong People API.

  • id cho một người dùng trong Admin SDK Directory API.

  • địa chỉ email của người dùng có thể được dùng làm email đại diện cho {user} trong các yêu cầu API. Ví dụ: nếu mã nhận dạng hồ sơ Người dùng của People API cho user@example.com là 123456789, thì bạn có thể dùng users/user@example.com làm biệt hiệu để tham chiếu đến users/123456789. Chỉ tên tài nguyên chuẩn (ví dụ: users/123456789) mới được trả về từ API.

displayName

string

Chỉ có đầu ra. Tên hiển thị của người dùng.

Được điền sẵn cho cả quy trình xác thực ứng dụng và xác thực người dùng. Trường này luôn được điền sẵn cho các yêu cầu được thực hiện bằng xác thực ứng dụng. Khi gọi API Tin nhắn và API Thành viên bằng xác thực người dùng, trường này sẽ được điền sẵn cho cả người dùng nội bộ và bên ngoài cho sender của một tin nhắn, người dùng trong annotations (chẳng hạn như lượt đề cập người dùng) và trong các tài nguyên Membership, miễn là người dùng là thành viên của không gian hoặc có mối quan hệ thân thiết trước đó với người dùng gọi.

avatarUrl

string

Chỉ có đầu ra. URL hình ảnh đại diện của người dùng.

Khi gọi API Tin nhắn và API Thành viên bằng xác thực người dùng, trường này sẽ được điền sẵn cho cả người dùng nội bộ và bên ngoài cho sender của một tin nhắn, người dùng trong annotations (chẳng hạn như lượt đề cập người dùng) và trong các tài nguyên Membership, miễn là người dùng là thành viên của không gian hoặc có mối quan hệ thân thiết trước đó với người dùng gọi.

email

string

Chỉ có đầu ra. Địa chỉ email của người dùng.

Khi gọi API Tin nhắn và API Thành viên bằng xác thực người dùng, trường này sẽ được điền sẵn cho cả người dùng nội bộ và bên ngoài cho sender của một tin nhắn, người dùng trong annotations (chẳng hạn như lượt đề cập người dùng) và trong các tài nguyên Membership, miễn là người dùng là thành viên của không gian hoặc có mối quan hệ thân thiết trước đó với người dùng gọi.

domainId

string

Giá trị nhận dạng riêng biệt của miền Google Workspace của người dùng.

type

enum (Type)

Loại người dùng.

isAnonymous

boolean

Chỉ có đầu ra. Khi true, người dùng sẽ bị xoá hoặc hồ sơ của họ không xuất hiện, chẳng hạn như khi một người dùng được đề cập trong một không gian mà không phải là thành viên và không có mối quan hệ thân thiết trước đó với người dùng gọi.

Loại

Enum
TYPE_UNSPECIFIED Giá trị mặc định cho enum. KHÔNG SỬ DỤNG.
HUMAN Người dùng thực.
BOT Người dùng ứng dụng Chat.