Nachrichten auflisten

In dieser Anleitung wird erläutert, wie Sie die list() Methode für die Message Ressource der Google Chat API verwenden, um eine paginierte, filterbare Liste von Nachrichten in einem Gruppenbereich aufzurufen.

In der Chat API wird eine Chat-Nachricht durch die Message Ressource dargestellt. Während Chat-Nutzer nur Nachrichten mit Text senden können, können Chat-Apps viele andere Messaging-Funktionen nutzen, darunter das Anzeigen statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen von Nutzern und das private Senden von Nachrichten. Weitere Informationen zu den Messaging Funktionen, die für die Chat API verfügbar sind, finden Sie in der Übersicht zu Google Chat-Nachrichten.

Vorbereitung

Node.js

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .

Python

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .

Java

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .

Apps Script

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .

Nachrichten als Nutzer auflisten

Wenn Sie Nachrichten mit Nutzerauthentifizierung, auflisten möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den chat.messages.readonly oder chat.messages Autorisierungsbereich an.
  • Rufen Sie die ListMessages() Methode auf.

Im folgenden Beispiel werden Nachrichten in einem Chat-Gruppenbereich aufgelistet:

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);
  }
}

await main();

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) {
      for (const message of responsePage.messages) {
        console.log(message);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Ersetzen Sie SPACE_NAME durch die ID aus dem Feld name des Gruppenbereichs, um dieses Beispiel auszuführen. Sie können die ID abrufen, indem Sie die ListSpaces() Methode aufrufen oder die URL des Gruppenbereichs verwenden.

Die Chat API gibt eine Liste der Nachrichten zurück, die im angegebenen Gruppenbereich gesendet wurden. Wenn keine Nachrichten aus der Anfrage vorhanden sind, gibt die Chat API-Antwort ein leeres Objekt zurück. Bei Verwendung einer REST/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt: {}.

Nachrichten als Chat-App auflisten

Für die App-Authentifizierung ist eine einmalige Genehmigung durch den Administrator erforderlich.

Wenn Sie Nachrichten aus einem Gruppenbereich mit App-Authentifizierung über die Chat REST API, auflisten möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie einen der folgenden Autorisierungsbereiche an:
    • https://www.googleapis.com/auth/chat.app.messages.readonly
  • Rufen Sie die list Methode für die messages Ressource auf.
  • Übergeben Sie den name des Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen.

Skript zum Aufrufen der Chat API schreiben

So listen Sie Nachrichten mit App-Authentifizierung und der Chat REST API auf:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_messages_list_app.py.
  2. Fügen Sie den folgenden Code in chat_messages_list_app.py ein:

    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)
    
        # 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. Ersetzen Sie im Code Folgendes:

    • SPACE_NAME: Ein Gruppenbereichsname, den Sie mit der spaces.list Methode in der Chat API oder über die URL eines Gruppenbereichs abrufen können.
  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_messages_list_app.py

Die Chat API gibt eine Liste der Nachrichten zurück, die im angegebenen Gruppenbereich gesendet wurden. Wenn keine Nachrichten aus der Anfrage vorhanden sind, gibt die Chat API-Antwort ein leeres Objekt zurück. Bei Verwendung einer REST/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt: {}.