Google Chat-Nutzer identifizieren und spezifizieren

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

Für die folgenden Aufgaben muss in einer Chat-App ein Nutzer angegeben werden:

Identifizierung von Nutzern in Google Chat

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

  • name ist der Ressourcenname für die Ressource im Format users/{user}, wobei {user} für eine eindeutige und stabile Kennung steht. users/app kann als Alias für die aufrufende Chat-App verwendet werden.
  • type ist der Typ des Nutzers. Dieser Typ teilt Chat mit, ob der Nutzer eine Chat-App oder eine Person ist. Für Chat-Apps ist der Wert BOT. Für Personen lautet der Wert HUMAN.

Nutzer in einem Aufruf der Google Chat API angeben

Verwenden Sie die folgenden Werte für {user}, um einen Nutzer anzugeben:

  • Verwenden Sie für Nutzer in Ihrer Google Workspace-Organisation einen der folgenden Ansätze:

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

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

Nutzer über ein Interaktionsereignis identifizieren

Jedes Mal, wenn ein Nutzer mit einer Chat-Anwendung interagiert, sendet 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 über die Interaktion, einschließlich der Nachricht und des Absenders. Chat-Apps verweisen beim Abrufen von Informationen zu Chat-Ressourcen auf Nutzer.

Um den Nutzer zu identifizieren, der mit einer Chat-App interagiert hat, rufen Sie den Wert des Attributs name in der Ressource User ab, den Sie über Event.user.name abrufen können.

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

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

Eine Nachricht ist eine bestimmte Art der Interaktion. Wenn Sie einen Nutzer identifizieren möchten, der eine Nachricht an eine Chat-App gesendet hat, rufen Sie den Wert des Attributs name in der Ressource User mit einer der folgenden Methoden ab: