Visualizzare i dettagli di un messaggio

Questa guida spiega come utilizzare il metodo get nella risorsa Message dell'API Google Chat per restituire dettagli su un SMS o un messaggio di congratulazioni.

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. La ricezione di un messaggio supporta entrambi i metodi di autenticazione:

    • L'autenticazione utente, con l'ambito di autorizzazione chat.messages.readonly o chat.messages, può ricevere i messaggi a cui l'utente ha accesso.
    • L'autenticazione app, con l'ambito di autorizzazione chat.bot, può ricevere i messaggi inviati all'app.

Ricevere un messaggio con l'autenticazione utente

Per ottenere i dettagli di un messaggio con autenticazione utente, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito dell'autorizzazione chat.messages.readonly o chat.messages.
  • Chiama il metodo get nella risorsa Message.
  • Imposta name sul nome della risorsa del messaggio da ricevere.

Nell'esempio seguente viene restituito un messaggio con autenticazione utente:

Python

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

  2. Includi il seguente codice in chat_message_get_user.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 gets a message.
    '''

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

        # The message 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 MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name = 'spaces/SPACE/messages/MESSAGE'

    ).execute()

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

if __name__ == '__main__':
    main()

  3. Sostituisci quanto segue nel codice:

    • SPACE: il nome di uno spazio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.
    • MESSAGE: nome del messaggio, che puoi ottenere dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.

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

    python3 chat_message_get_user.py

L'API Chat restituisce un'istanza di Message che descrive in dettaglio il messaggio specificato.

Ricevere un messaggio con l'autenticazione delle app

Per ottenere i dettagli di un messaggio con autenticazione app, trasmetti quanto segue nella richiesta:

  • Specifica l'ambito dell'autorizzazione chat.bot.
  • Chiama il metodo get nella risorsa Message.
  • Imposta name sul nome della risorsa del messaggio da ricevere.

Nell'esempio seguente viene restituito un messaggio con autenticazione app:

Python

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

  2. Includi il seguente codice in chat_get_message_app.py:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Get a Chat message.
result = chat.spaces().messages().get(

    # The message 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 MESSAGE with a message name.
    # Obtain the message name from the response body returned
    # after creating a message asynchronously with Chat REST API.
    name='spaces/SPACE/messages/MESSAGE'

  ).execute()

# Print Chat API's response in your command line interface.
print(result)

  3. Sostituisci quanto segue nel codice:

    • SPACE: name dello spazio in cui è pubblicato il messaggio, che puoi ottenere dal metodo spaces.list nell'API Chat o dall'URL di uno spazio.

    • MESSAGE: il nome del messaggio, che puoi ottenere dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.

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

    python3 chat_get_message_app.py

L'API Chat restituisce un'istanza di Message che descrive in dettaglio il messaggio specificato.