Method: spaces.messages.list

Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Ein Beispiel finden Sie unter Nachrichten auflisten. Erfordert eine Nutzerauthentifizierung.

HTTP-Anfrage

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameters
parent

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, aus dem Nachrichten aufgelistet werden sollen.

Format: spaces/{space}

Suchparameter

Parameters
pageSize

integer

Die maximale Anzahl der zurückgegebenen Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als dieser Wert zurück.

Wenn keine Vorgabe erfolgt, werden höchstens 25 zurückgegeben.

Der Maximalwert beträgt 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in „1.000“ geändert.

Negative Werte geben den Fehler INVALID_ARGUMENT zurück.

pageToken

string

Optional, wenn mit einer vorherigen Abfrage fortgefahren wird.

Ein von einem vorherigen Listenaufruf empfangenes Seitentoken. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren sollten alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe verschiedener Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.

filter

string

Ein Abfragefilter.

Sie können Nachrichten nach Datum (createTime) und Thread (thread.name) filtern.

Um Nachrichten nach dem Erstellungsdatum zu filtern, geben Sie die createTime mit einem Zeitstempel im Format RFC-3339 und doppelten Anführungszeichen an. Beispiel: "2023-04-21T11:30:00-04:00" Sie können den Größer-als-Operator > verwenden, um Nachrichten aufzulisten, die nach einem Zeitstempel erstellt wurden, oder den Kleiner-als-Operator <, um Nachrichten aufzulisten, die vor einem Zeitstempel erstellt wurden. Verwenden Sie den Operator AND zwischen zwei Zeitstempeln, um Nachrichten innerhalb eines bestimmten Zeitintervalls zu filtern.

Wenn Sie nach Thread filtern möchten, geben Sie die thread.name im Format spaces/{space}/threads/{thread} an. Sie können nur eine thread.name pro Abfrage angeben.

Verwenden Sie den Operator AND in Ihrer Abfrage, um sowohl nach Thread als auch nach Datum zu filtern.

Die folgenden Abfragen sind beispielsweise gültig:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

orderBy

string

Optional, wenn mit einer vorherigen Abfrage fortgefahren wird.

Die Reihenfolge der Nachrichtenliste. Geben Sie einen Wert an, der nach einem Sortiervorgang sortiert werden soll. Gültige Werte für Sortiervorgänge sind:

  • ASC für aufsteigend.

  • DESC für absteigend.

Die Standardsortierung ist createTime ASC.

showDeleted

boolean

Gibt an, ob gelöschte Nachrichten einbezogen werden sollen. Zu den gelöschten Nachrichten gehören der Zeitpunkt der Löschung und Metadaten zum Löschen. Der Nachrichteninhalt ist jedoch nicht mehr verfügbar.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

JSON-Darstellung
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Felder
messages[]

object (Message)

Liste der Nachrichten.

nextPageToken

string

Sie können ein Token als pageToken senden, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.