Elenco di messaggi

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

Nell'API Chat, un messaggio di Chat è rappresentato dalla risorsa Message. Mentre gli utenti di Chat possono inviare solo messaggi di testo, le app di chat possono utilizzare molte altre funzionalità di messaggistica, tra cui la visualizzazione di interfacce utente statiche o interattive, la raccolta di informazioni dagli utenti e l'invio privato di messaggi. Per scoprire di più sulle funzionalità di messaggistica disponibili per l'API Chat, consulta la Panoramica dei messaggi di Google Chat.

Prerequisiti

Node.js

Python

Java

Apps Script

Elencare i messaggi come utente

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

  • Specifica l'ambito di autorizzazione chat.messages.readonly o chat.messages.
  • Chiama il metodo ListMessages().

L'esempio seguente elenca i messaggi in uno spazio di Chat:

Node.js

chat/client-libraries/cloud/list-messages-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';  const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages.readonly'];  // This sample shows how to list messages with user credential async function main() {   // Create a client   const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);    // Initialize request argument(s)   const request = {     // Replace SPACE_NAME here     parent: 'spaces/SPACE_NAME'   };    // Make the request   const pageResult = chatClient.listMessagesAsync(request);    // Handle the response. Iterating over pageResult will yield results and   // resolve additional pages automatically.   for await (const response of pageResult) {     console.log(response);   } }  main().catch(console.error);

Python

chat/client-libraries/cloud/list_messages_user_cred.py
from authentication_utils import create_client_with_user_credentials from google.apps import chat_v1 as google_chat  SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"]  # This sample shows how to list messages with user credential def list_messages_with_user_cred():     # Create a client     client = create_client_with_user_credentials(SCOPES)      # Initialize request argument(s)     request = google_chat.ListMessagesRequest(         # Replace SPACE_NAME here         parent = 'spaces/SPACE_NAME',         # Number of results that will be returned at once         page_size = 100     )      # Make the request     page_result = client.list_messages(request)      # Handle the response. Iterating over page_result will yield results and     # resolve additional pages automatically.     for response in page_result:         print(response)  list_messages_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMessagesUserCred.java
import com.google.chat.v1.ChatServiceClient; import com.google.chat.v1.ListMessagesRequest; import com.google.chat.v1.ListMessagesResponse; import com.google.chat.v1.Message;  // This sample shows how to list messages with user credential. public class ListMessagesUserCred {    private static final String SCOPE =     "https://www.googleapis.com/auth/chat.messages.readonly";    public static void main(String[] args) throws Exception {     try (ChatServiceClient chatServiceClient =         AuthenticationUtils.createClientWithUserCredentials(           ImmutableList.of(SCOPE))) {       ListMessagesRequest.Builder request = ListMessagesRequest.newBuilder()         // Replace SPACE_NAME here.         .setParent("spaces/SPACE_NAME")         // Number of results that will be returned at once.         .setPageSize(10);        // Iterate over results and resolve additional pages automatically.       for (Message response :           chatServiceClient.listMessages(request.build()).iterateAll()) {         System.out.println(JsonFormat.printer().print(response));       }     }   } }

Apps Script

chat/advanced-service/Main.gs
/**  * This sample shows how to list messages with user credential  *   * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages.readonly'  * referenced in the manifest file (appsscript.json).  */ function listMessagesUserCred() {   // Initialize request argument(s)   // TODO(developer): Replace SPACE_NAME here   const parent = 'spaces/SPACE_NAME';    // Iterate through the response pages using page tokens   let responsePage;   let pageToken = null;   do {     // Request response pages     responsePage = Chat.Spaces.Messages.list(parent, {       pageSize: 10,       pageToken: pageToken     });     // Handle response pages     if (responsePage.messages) {       responsePage.messages.forEach((message) => console.log(message));     }     // Update the page token to the next one     pageToken = responsePage.nextPageToken;   } while (pageToken); }

Per eseguire questo esempio, sostituisci SPACE_NAME con l'ID del campo name dello spazio. Puoi ottenere l'ID chiamando il metodo ListSpaces() o dall'URL dello spazio.

L'API Chat restituisce un elenco di messaggi inviati nello spazio specificato. Se non sono presenti messaggi nella richiesta, la risposta dell'API Chat restituisce un oggetto vuoto. Quando utilizzi un'interfaccia REST/HTTP, la risposta contiene un oggetto JSON vuoto, {}.

Elencare i messaggi come app di chat

L'autenticazione dell'app richiede l'approvazione dell'amministratore una sola volta.

Per elencare i messaggi di uno spazio con autenticazione dell'app utilizzando l'API REST di Chat, trasmetti quanto segue nella richiesta:

  • Specifica uno dei seguenti ambiti di autorizzazione:
    • https://www.googleapis.com/auth/chat.app.messages.readonly
  • Chiama il metodo list sulla risorsa messages.
  • Passa l'name dello spazio da cui elencare i messaggi.

Crea una chiave API

Per chiamare un metodo API di anteprima per gli sviluppatori, devi utilizzare una versione di anteprima per gli sviluppatori non pubblica del documento di rilevamento API. Per autenticare la richiesta, devi passare una chiave API.

Per creare la chiave API, apri il progetto Google Cloud della tua app e svolgi i seguenti passaggi:

  1. Nella console Google Cloud, vai a Menu > API e servizi > Credenziali.

    Vai a credenziali

  2. Fai clic su Crea credenziali > Chiave API.
  3. Viene visualizzata la nuova chiave API.
    • Fai clic su Copia per copiare la chiave API da utilizzare nel codice della tua app. La chiave API è disponibile anche nella sezione "Chiavi API" delle credenziali del progetto.
    • Per impedire l'uso non autorizzato, ti consigliamo di limitare dove e per quali API può essere utilizzata la chiave API. Per maggiori dettagli, vedi Aggiungere limitazioni API.

Scrivere uno script che chiama l'API Chat

Ecco come elencare i messaggi con l'autenticazione dell'app e l'API REST di Chat:

Python

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

  2. Includi il seguente codice in chat_messages_list_app.py:

    from google.oauth2 import service_account from apiclient.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.app.messages.readonly"]  def main():     '''     Authenticates with Chat API using app authentication,     then lists messages from a specified space.     '''      # Specify service account details.     creds = (         service_account.Credentials.from_service_account_file('credentials.json')         .with_scopes(SCOPES)     )      # Build a service endpoint for Chat API.     chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')      # Use the service endpoint to call Chat API.     result = chat.spaces().messages().list(          # The space to list messages from.         #         # Replace SPACE_NAME with a space name.         # Obtain the space name from the spaces resource of Chat API,         # or from a space's URL.         parent='spaces/SPACE_NAME'      ).execute()      # Print Chat API's response in your command line interface.     print(result)  if __name__ == '__main__':     main()

  3. Nel codice, sostituisci quanto segue:

    • API_KEY: la chiave API che hai creato per creare l'endpoint del servizio per l'API Chat.

    • SPACE_NAME: 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, compila ed esegui l'esempio:

    python3 chat_messages_list_app.py

L'API Chat restituisce un elenco di messaggi inviati nello spazio specificato. Se non sono presenti messaggi nella richiesta, la risposta dell'API Chat restituisce un oggetto vuoto. Quando utilizzi un'interfaccia REST/HTTP, la risposta contiene un oggetto JSON vuoto, {}.