User

Użytkownik w Google Chat.

Jeśli aplikacja do czatu uwierzytelnia się jako użytkownik, dane wyjściowe żądania dotyczące zasobu User (np. w interfejsach Messages API i Memberships API) wypełniają tylko pola name i type w przypadku użytkowników wewnętrznych i zewnętrznych, chyba że są oni członkami pokoju lub mają wcześniejsze powiązania z użytkownikiem wywołującym.

Zapis JSON
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Pola
name

string

Nazwa zasobu w Google Chat user.

Format: users/{user}. users/app może być używany jako alias użytkownika aplikacji do dzwonienia bot.

W przypadku human users identyfikator użytkownika {user} jest taki sam jak:

  • id dla osoby w interfejsie People API. Na przykład users/123456789 w interfejsie Chat API reprezentuje tę samą osobę co 123456789 identyfikator profilu osoby w interfejsie People API.

  • id dla użytkownika w interfejsie Admin SDK Directory API.

  • Adres e-mail użytkownika może być używany jako alias dla {user} w żądaniach interfejsu API. Jeśli na przykład identyfikator profilu osoby w interfejsie People API dla user@example.com to 123456789, możesz użyć users/user@example.com jako aliasu, aby odwoływać się do users/123456789. Interfejs API zwróci tylko kanoniczną nazwę zasobu (np. users/123456789).

displayName

string

Tylko dane wyjściowe. Wyświetlana nazwa użytkownika.

Wypełniane zarówno w przypadku uwierzytelniania aplikacji, jak i użytkownika. To pole jest zawsze wypełniane w przypadku żądań wysyłanych z uwierzytelnianiem aplikacji. Podczas wywoływania interfejsów API wiadomości i członkostwa z uwierzytelnianiem użytkownika to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązania z użytkownikiem wywołującym.

avatarUrl

string

Tylko dane wyjściowe. Adres URL obrazu awatara użytkownika.

Podczas wywoływania interfejsów API wiadomości i członkostwa z uwierzytelnianiem użytkownika to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązania z użytkownikiem wywołującym.

email

string

Tylko dane wyjściowe. Adres e-mail użytkownika.

Podczas wywoływania interfejsów API wiadomości i członkostwa z uwierzytelnianiem użytkownika to pole jest wypełniane zarówno w przypadku użytkowników wewnętrznych, jak i zewnętrznych w przypadku sender wiadomości, użytkowników w annotations (np. wzmianek o użytkownikach) i w zasobach Membership, pod warunkiem że użytkownik jest członkiem pokoju lub ma wcześniejsze powiązania z użytkownikiem wywołującym.

domainId

string

Unikalny identyfikator domeny Google Workspace użytkownika.

type

enum (Type)

Typ użytkownika.

isAnonymous

boolean

Tylko dane wyjściowe. Gdy true, użytkownik jest usuwany lub jego profil jest niewidoczny, np. gdy użytkownik jest wymieniony w pokoju, ale nie jest jego członkiem i nie ma wcześniejszego powiązania z użytkownikiem dzwoniącym.

Typ

Wartości w polu enum
TYPE_UNSPECIFIED Wartość domyślna wyliczenia. NIE UŻYWAJ.
HUMAN użytkownik będący osobą fizyczną,
BOT użytkownik aplikacji do obsługi czatu,