Iscriviti agli eventi di Google Chat

Questa pagina descrive gli eventi di Chat a cui un'app di Chat può abbonarsi utilizzando l'API Google Workspace Events. Dopo aver deciso quali tipi di eventi ti servono, crea un abbonamento per iniziare a ricevere eventi da Chat.

Oltre ad abbonarti agli eventi, puoi anche eseguire query sugli eventi chiamando l'API Google Chat. La chiamata all'API Chat ti consente di recuperare gli eventi periodicamente o di recuperare gli eventi che potresti aver perso da un abbonamento a causa di un'interruzione. Per scoprire i modi in cui puoi ricevere e rispondere agli eventi di Chat, consulta la sezione Lavorare con gli eventi di Chat nella documentazione di Chat.

Eventi di Chat supportati

Gli abbonamenti a Google Workspace ti consentono di ricevere eventi sui seguenti tipi di modifiche in Chat:

• Messaggi nuovi, aggiornati o eliminati nello spazio.
• Reazioni nuove o rimosse a un messaggio.
• Membri nuovi, aggiornati o rimossi nello spazio.
• Modifiche allo spazio a cui hai sottoscritto l'abbonamento, ad esempio un nome o una descrizione dello spazio aggiornati.

Risorse che puoi monitorare per gli eventi

Per ricevere eventi, devi specificare una risorsa di Chat da monitorare, chiamata risorsa di destinazione dell'abbonamento.

L'API Google Workspace Events supporta le seguenti risorse di destinazione per Chat:

Tipi di eventi per la creazione di abbonamenti

Quando crei un abbonamento, utilizza il eventTypes[] campo per specificare i tipi di eventi che vuoi ricevere. I tipi di eventi sono formattati in base alla specifica CloudEvents, ad esempio google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

Ad esempio, per ricevere eventi sugli utenti che partecipano a uno spazio di Chat, specifica lo spazio come risorsa di destinazione e il tipo di evento come google.workspace.chat.membership.v1.created. Per ricevere eventi su un determinato utente che partecipa a qualsiasi spazio, specifica l'utente come risorsa di destinazione e il tipo di evento come google.workspace.chat.membership.v1.created. Per saperne di più sul funzionamento degli eventi, consulta Struttura degli eventi di Google Workspace events.

La tabella seguente mostra i tipi di eventi supportati per gli abbonamenti agli spazi e agli utenti. Per scoprire le eccezioni relative a cosa attiva un evento, consulta Limitazioni.

Tipi di eventi batch (solo output)

Oltre a ricevere i tipi di eventi a cui ti abboni, la tua app di Chat potrebbe ricevere anche eventi batch. Un evento batch è un evento che rappresenta molti eventi dello stesso tipo che si verificano in un breve periodo di tempo. Il payload di un evento batch contiene un elenco di tutte le risorse modificate.

Ad esempio, se un utente aggiunge 20 utenti a uno spazio contemporaneamente, la tua app di Chat potrebbe ricevere un evento batch (google.workspace.chat.membership.v1.batchCreated). Il payload dell'evento contiene un elenco di tutte le nuove risorse Membership create quando l'utente ha aggiunto i membri allo spazio.

Ricevi un evento batch per qualsiasi tipo di evento a cui ti abboni, quindi non devi specificare gli eventi batch quando crei un abbonamento. Ad esempio, se ti abboni alle nuove reazioni (google.workspace.chat.reaction.v1.created), la tua app di Chat viene configurata automaticamente per ricevere eventi batch di reazione (google.workspace.chat.reaction.v1.batchCreated).

La tabella seguente mostra i possibili eventi batch per un abbonamento:

Dati sugli eventi

Questa sezione descrive i dati sugli eventi e i payload di esempio per gli eventi in Chat.

Quando il tuo abbonamento a Google Workspace riceve un evento da Chat, il data campo contiene il payload dell'evento. Questo payload contiene informazioni sulla risorsa di Google Workspace modificata. Ad esempio, se hai sottoscritto l'abbonamento agli eventi di appartenenza in uno spazio, il payload di questi eventi contiene informazioni sulla spaces.membership risorsa modificata.

Dati delle risorse nel payload dell'evento

Quando crei un abbonamento, puoi specificare se vuoi che il payload includa i dettagli della risorsa o solo il nome della risorsa. Ad esempio, se vuoi ricevere eventi sui membri di uno spazio di Chat, specifica i campi di una risorsa di appartenenza che vuoi ricevere nel payload dell'evento.

La tabella seguente fornisce esempi di payload JSON per un abbonamento allo spazio di Chat spaces/AAAABBBBBB. Per ogni evento ricevuto dall'abbonamento, il payload viene visualizzato nel campo data dell'evento:

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID",
        "sender":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/SPACE_ID/threads/THREAD_ID"
        },
        "space":
        {
            "name": "spaces/SPACE_ID"
        },
        "argumentText": "Hello world"
    }
}
      

{
    "message":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID"
    }
}
      

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID",
        "state": "JOINED",
        "member":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
      

{
    "membership":
    {
        "name": "spaces/SPACE_ID/members/MEMBER_ID"
    }
}
      

{
    "space":
    {
        "name": "spaces/SPACE_ID",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
      

{
    "space":
    {
        "name": "spaces/SPACE_ID"
    }
}
      

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID",
            "state": "JOINED",
            "member":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
      

{
    "memberships": [
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        },
        {
          "membership": {
            "name": "spaces/SPACE_ID/members/MEMBER_ID"
          }
        }
    ]
}
      

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        "user":
        {
            "name": "users/USER_ID",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
      

{
    "reaction":
    {
        "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
    }
}
      

{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
            "user":
            {
                "name": "users/USER_ID",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
      

{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID"
        },
        "reaction": {
            "name": "spaces/SPACE_ID/messages/MESSAGE_ID/reactions/REACTION_ID",
        }
      }
    ]
}
      

• Per gli abbonamenti agli utenti, gli eventi relativi ai nuovi membri nei messaggi diretti o nelle chat di gruppo senza nome (google.workspace.chat.membership.v1.created), vengono attivati solo dopo la pubblicazione del primo messaggio.
• Per ricevere eventi di appartenenza, l'utente o l'app di Chat deve essere un membro diretto dello spazio. Se sono stati aggiunti, aggiornati o rimossi indirettamente a uno spazio tramite un gruppo Google, l'abbonamento non riceve questi eventi di appartenenza. Per capire come funzionano le appartenenze ai gruppi Google, consulta Aggiungere un gruppo Google a uno spazio.

Argomenti correlati

• Struttura degli eventi di Google Workspace
• Scegliere gli ambiti OAuth
• Creare un abbonamento per ricevere eventi di Chat