User

Ein Nutzer in Google Chat.

Wenn Ihre Chat-App als Nutzer authentifiziert wird und als Ausgabe einer Anfrage zurückgegeben wird, werden die Felder name und type für eine User-Ressource (z. B. in den Messages- und Memberships-APIs) nur für interne und externe Nutzer ausgefüllt, sofern sie Mitglieder des Gruppenbereichs sind oder eine frühere Beziehung zum aufrufenden Nutzer haben.

JSON-Darstellung
{
  "name": string,
  "displayName": string,
  "avatarUrl": string,
  "email": string,
  "domainId": string,
  "type": enum (Type),
  "isAnonymous": boolean
}
Felder
name

string

Ressourcenname für ein Google Chat-user.

Format: users/{user}. users/app kann als Alias für den Nutzer der Anruf-App bot verwendet werden.

Für human users ist {user} dieselbe Nutzer-ID wie:

  • die id für die Person in der People API. So steht users/123456789 in der Chat API für dieselbe Person wie die Personenprofil-ID 123456789 in der People API.

  • die id für einen Nutzer in der Admin SDK Directory API.

  • Die E-Mail-Adresse des Nutzers kann in API-Anfragen als Alias für {user} verwendet werden. Wenn die Personenprofil-ID der People API für user@example.com beispielsweise 123456789 ist, können Sie users/user@example.com als Alias verwenden, um auf users/123456789 zu verweisen. Von der API wird nur der kanonische Ressourcenname zurückgegeben, z. B. users/123456789.

displayName

string

Nur Ausgabe. Der Anzeigename des Nutzers.

Wird sowohl für die App- als auch für die Nutzerauthentifizierung ausgefüllt. Dieses Feld wird immer für Anfragen ausgefüllt, die mit der App-Authentifizierung gestellt werden. Wenn die Messages API und die Memberships API mit Nutzerauthentifizierung aufgerufen werden, wird dieses Feld sowohl für interne als auch für externe Nutzer für die sender einer Nachricht, für Nutzer in annotations (z. B. Nutzererwähnungen) und für Membership-Ressourcen ausgefüllt, sofern der Nutzer Mitglied des Gruppenbereichs ist oder eine frühere Beziehung zum aufrufenden Nutzer hat.

avatarUrl

string

Nur Ausgabe. Die URL des Avatarbilds des Nutzers.

Wenn die Messages API und die Memberships API mit Nutzerauthentifizierung aufgerufen werden, wird dieses Feld sowohl für interne als auch für externe Nutzer für die sender einer Nachricht, für Nutzer in annotations (z. B. Nutzererwähnungen) und für Membership-Ressourcen ausgefüllt, sofern der Nutzer Mitglied des Bereichs ist oder eine frühere Beziehung zum aufrufenden Nutzer hat.

email

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers.

Wenn die Messages API und die Memberships API mit Nutzerauthentifizierung aufgerufen werden, wird dieses Feld sowohl für interne als auch für externe Nutzer für die sender einer Nachricht, für Nutzer in annotations (z. B. Nutzererwähnungen) und für Membership-Ressourcen ausgefüllt, sofern der Nutzer Mitglied des Bereichs ist oder eine frühere Beziehung zum aufrufenden Nutzer hat.

domainId

string

Eindeutige Kennung der Google Workspace-Domain des Nutzers.

type

enum (Type)

Nutzertyp.

isAnonymous

boolean

Nur Ausgabe. Wenn true, wird der Nutzer gelöscht oder sein Profil ist nicht sichtbar, z. B. wenn ein Nutzer in einem Gruppenbereich erwähnt wird, ohne Mitglied zu sein und ohne dass der anrufende Nutzer eine Beziehung zu ihm hat.

Typ

Enums
TYPE_UNSPECIFIED Standardwert für das Enum. NICHT VERWENDEN.
HUMAN Menschlicher Nutzer.
BOT Nutzer der Chat-App.