Google Chat-Nutzer identifizieren und spezifizieren

Auf dieser Seite wird beschrieben, wie Google Chat-Apps Chat-Nutzer identifizieren oder angeben können.

Für die folgenden Aktionen muss eine Chat-App einen Nutzer angeben:

So werden Nutzer in Google Chat identifiziert

Die Google Chat API generiert für jede Person, die Google Chat verwendet, eine UserRessource. Im Folgenden finden Sie zwei wichtige User-Felder:

  • name ist der Ressourcenname der Ressource, formatiert als users/{user}, wobei {user} eine eindeutige und stabile Kennung darstellt. users/app kann als Alias für die anrufende Chat-App verwendet werden.
  • type ist der Nutzertyp. Dieser Typ gibt an, ob es sich bei dem Nutzer um eine Chat-App oder eine Person handelt. Bei Chat-Apps ist der Wert BOT. Bei Personen ist der Wert HUMAN.

Nutzer in einem Aufruf der Google Chat API angeben

Wenn Sie einen Nutzer angeben möchten, verwenden Sie die folgenden Werte für {user}:

  • Für Nutzer in Ihrer Google Workspace-Organisation haben Sie folgende Möglichkeiten:

    • Die name der User-Ressource in der Chat API, z. B. users/123456789.
    • {person_id} für den Namen einer Person-Ressource in der People API, wobei resourceName people/{person_id} ist. Beispiel: users/123456789 in der Chat API steht für dieselbe Person wie people/123456789 in der People API.
    • Die id für eine User-Ressource in der Directory API. Beispiel: users/123456789 in der Chat API steht für dieselbe Person wie users/123456789 in der Directory API.

  • Verwenden Sie für einen Nutzer in einer externen Google Workspace-Organisation oder für einen Nutzer, der ein Google-Konto verwendet, einen E-Mail-Alias, z. B. users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com oder users/EMAIL_USERNAME@gmail.com.

Nutzer anhand eines Interaktionsereignisses identifizieren

Jedes Mal, wenn ein Nutzer mit einer Chat-App interagiert, sendet Google Chat ein Interaktionsereignis mit Informationen zur Interaktion und zum Nutzer. Wenn ein Nutzer beispielsweise eine Chat-App in einer Nachricht erwähnt, erhält die Chat-App Informationen zur Interaktion, einschließlich des Inhalts der Nachricht und des Absenders. Chat-Apps verweisen auf Nutzer, wenn sie Informationen zu Chat-Ressourcen abrufen.

Wenn Sie den Nutzer identifizieren möchten, der mit einer Chat-App interagiert hat, rufen Sie den Wert der Property name für die Ressource User ab. Diese Ressource können Sie über Event.user.name abrufen.

Das folgende JSON-Beispiel zeigt das erwartete Format der Nutzeridentität bei einer Interaktion mit einer Chat-App:

{
  ...,
  "user": {
    "name": "users/12345678901234567890",
    "displayName": "Sasha",
    "avatarUrl": "https://lh3.googleusercontent.com/.../photo.jpg",
    "email": "sasha@example.com"
  }
}

Eine Nachricht ist eine bestimmte Art von Interaktion. Wenn Sie einen Nutzer identifizieren möchten, der eine Nachricht an eine Chat-App gesendet hat, rufen Sie den Wert des Attributs name für die Ressource User auf.