Ottenere dettagli su un evento dello spazio di Google Chat

Questa guida spiega come utilizzare Metodo get attivo SpaceEvent risorsa del API Google Chat per ottenere i dettagli su un evento da uno spazio di Google Chat.

La risorsa SpaceEvent rappresenta una modifica a uno spazio o al relativo asset figlio come messaggi, reazioni e iscrizioni. Per ulteriori informazioni sui tipi di eventi supportati, consulta il campo eventType dell' SpaceEvent risorsa documentazione di riferimento.

Puoi richiedere eventi fino a 28 giorni prima dell'ora della richiesta. L'evento contiene la versione più recente della risorsa che è stata modificata. Ad esempio, se richiedi un evento relativo a un nuovo messaggio, ma il messaggio è stato aggiornato successivamente, il server restituisce la risorsa Message aggiornata nel payload dell'evento.

Per chiamare questo metodo, devi utilizzare user autenticazione. Per ottenere l'utente autenticato deve essere membro dello spazio in cui si svolge l'evento si è verificato un errore.

Prerequisiti

Python

  • Python 3.6 o versioni successive
  • Lo strumento di gestione dei pacchetti pip
  • Le librerie client di Google più recenti. Per installarle o aggiornarle, esegui questo comando nell'interfaccia a riga di comando: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Ricevere i dettagli di un evento dello spazio

Per visualizzare i dettagli di un SpaceEvent in Google Chat, segui questi passaggi:

  • Chiama il metodo get il SpaceEvent risorsa.
  • Supera name del SpaceEvent per ricevere. Ottieni il nome SpaceEvent dal SpaceEvent risorsa di Google Chat.
  • Con utente l'autenticazione, specifica un ambito di autorizzazione che supporti il tipo di evento nella richiesta. Come best practice, scegli l'ambito più restrittivo che consenta comunque alla tua app per funzionare.

Ecco come ottenere un SpaceEvent con autenticazione utente:

Python

  1. Nella directory di lavoro, crea un file denominato chat_space_event_get.py.

  2. Includi il seguente codice in chat_space_event_get.py:

    """Gets a SpaceEvent resource from the Chat API."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace
# and get user authorization.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
creds = flow.run_local_server()

# Build a service endpoint for Chat API.
chat = build(
  'chat',
  'v1',
  credentials=creds
)

# Use the service endpoint to call Chat API.
result = (
    chat.spaces()
    .spaceEvents()
    .get(
        # The space event to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace SPACE_EVENT with a SpaceEvent name.
        # Obtain the spaceEvent name from the SpaceEvent resource of
        # Chat API.
        name='spaces/SPACE/spaceEvents/SPACE_EVENT'
    )
    .execute()
)

# Prints details about the created spaceEvent.
print(result)

  3. Nel codice, sostituisci quanto segue:

    • SCOPE: un ambito di autorizzazione basato sul tipo di evento. Ad esempio, se vuoi ricevere un evento spaziale sui nuovi abbonamenti, usa l'ambito chat.memberships.readonly, formattato come https://www.googleapis.com/auth/chat.memberships.readonly. Puoi ottenere il tipo di evento dal Metodo spaces.spaceEvents.list. Per scoprire come utilizzare questo metodo, consulta Elenca gli eventi di uno spazio.
    • SPACE: il nome di uno spazio che puoi recuperare da il metodo spaces.list nell'API Chat o dall'URL di uno spazio.
    • SPACE_EVENT: il nome dello spazio ottenibile dalle risorse Metodo spaces.spaceEvents.list.

  4. Nella directory di lavoro, crea ed esegui l'esempio:

    python3 chat_space_event_get.py

L'API Chat restituisce un'istanza SpaceEvent con i dettagli dell'evento.