Identificare e specificare gli utenti di Google Chat

Questa pagina illustra i modi in cui le app Google Chat possono identificare o specificare gli utenti di Chat.

Per eseguire una delle seguenti operazioni, un'app di chat deve specificare un utente:

In che modo Chat identifica gli utenti

L'API Google Chat genera una risorsa User per ogni persona che utilizza Chat. Ecco due importanti campi User:

  • name è il nome della risorsa, nel formato users/{user}, dove {user} rappresenta un identificatore univoco e stabile. users/app può essere utilizzato come alias per l'app Chat per le chiamate.
  • type è il tipo di utente. Questo tipo indica a Chat se l'utente è un'app o una persona. Per le app di Chat, il valore è BOT. Per gli utenti, il valore è HUMAN.

Specifica un utente in una chiamata all'API Google Chat

Per specificare un utente, utilizza i seguenti valori per il valore {user}:

  • Per gli utenti della tua organizzazione Google Workspace, utilizza uno dei seguenti approcci:

    • name della risorsa User nell'API Chat, ad esempio users/123456789.
    • {person_id} per il nome di una risorsa Person nell'API People, dove resourceName è people/{person_id}, ad esempio users/123456789 nell'API Chat rappresenta la stessa persona di people/123456789 nell'API People.
    • id per una risorsa User nell'API Directory, ad esempio users/123456789 nell'API Chat rappresenta la stessa persona di users/123456789 nell'API Directory.

  • Per un utente di un'organizzazione Google Workspace esterna o che utilizza un Account Google, utilizza un alias email, ad esempio users/EMAIL_USERNAME@WORKSPACE_DOMAIN.com o users/EMAIL_USERNAME@gmail.com.

Identificare un utente da un evento di interazione

Ogni volta che un utente interagisce con un'app di Chat, Chat invia un evento di interazione con informazioni sull'interazione e sull'utente. Ad esempio, quando un utente menziona un'app di Chat in un messaggio, l'app Chat riceve informazioni sull'interazione, tra cui cosa dice il messaggio e chi l'ha inviato. Le app di Chat fanno riferimento agli utenti quando recuperano informazioni sulle risorse di Chat.

Per identificare l'utente che ha interagito con un'app di Chat, ricevi il valore della proprietà name nella risorsa User, che puoi ottenere da Event.user.name.

Il seguente esempio JSON mostra il formato previsto dell'identità utente in un'interazione con un'app di chat:

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

Un messaggio è un tipo specifico di interazione. Per identificare un utente che ha inviato un messaggio a un'app di Chat, recupera il valore della proprietà name nella risorsa User utilizzando uno dei seguenti: