Elenco di messaggi

Questa guida spiega come utilizzare il metodo list nella risorsa Message dell'API Google Chat per visualizzare un elenco di messaggi impaginato e filtrabile in uno spazio.

La risorsa Message rappresenta un messaggio di testo o scheda in Google Chat. Puoi create, get, update o delete un messaggio nell'API Google Chat chiamando i metodi corrispondenti. Per saperne di più sui messaggi di testo e delle schede, consulta la panoramica dei messaggi di Google Chat.

Prerequisiti

Python

  • Python 3.6 o versioni successive
  • Lo strumento di gestione dei pacchetti pip

  • Le librerie client di Google più recenti per Python. Per installarli o aggiornarli, esegui questo comando nell'interfaccia a riga di comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Un progetto Google Cloud in cui l'API Google Chat è abilitata e configurata. Per i passaggi da seguire, consulta Creare un'app Google Chat.

  • Autorizzazione configurata per l'app Chat. I messaggi della scheda richiedono l'autenticazione utente con l'ambito di autorizzazione chat.messages.readonly o chat.messages.

Elenco di messaggi

Per elencare i messaggi con autenticazione utente, trasmetti quanto segue nella richiesta:

Nell'esempio seguente sono elencati i messaggi in uno spazio di Chat inviati dopo il 16 marzo 2023:

Python

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

  2. Includi il seguente codice in chat_messages_list.py:

    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 = ["https://www.googleapis.com/auth/chat.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists messages in a space sent after March 16, 2023.
    '''

    # 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().messages().list(

          # The space for which to list messages.
          parent = 'spaces/SPACE',

          # An optional filter that returns messages
          # created after March 16, 2023.
          filter = 'createTime > "2023-03-16T00:00:00-00:00"'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Nel codice, sostituisci SPACE con il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

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

    python3 chat_messages_list.py

L'API Google Chat restituisce un elenco dei messaggi inviati nello spazio specificato dopo il 16 marzo 2023.