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 Nutzerauthentifizierung.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

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

Format: spaces/{space}

Suchparameter

Parameter
pageSize

integer

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

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

Der Höchstwert ist 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 die Pausierung aus einer vorherigen Abfrage aufgehoben wird.

Ein Seitentoken, das von einem vorherigen Listennachrichtenaufruf empfangen wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Bei der Paginierung 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.

Geben Sie createTime mit einem Zeitstempel im Format RFC-3339 und doppelten Anführungszeichen an, um Nachrichten nach dem Erstellungsdatum zu filtern. Beispiel: "2023-04-21T11:30:00-04:00" Sie können den Operator > verwenden, um Nachrichten aufzulisten, die nach einem Zeitstempel erstellt wurden, oder den Operator <, um Nachrichten aufzulisten, die vor einem Zeitstempel erstellt wurden. Wenn Nachrichten in einem bestimmten Zeitintervall gefiltert werden sollen, verwenden Sie den Operator AND zwischen zwei Zeitstempeln.

Geben Sie zum Filtern nach Thread das Format thread.name im Format spaces/{space}/threads/{thread} an. Sie können nur eine thread.name pro Abfrage angeben.

Verwenden Sie in Ihrer Abfrage den Operator AND, um nach Thread und 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 die Pausierung aus einer vorherigen Abfrage aufgehoben wird.

Reihenfolge der Liste von Nachrichten. Geben Sie einen Wert an, der nach einem Bestellvorgang sortiert werden soll. Gültige Werte für die Sortierung:

  • ASC für aufsteigend.

  • DESC für absteigend.

Die Standardreihenfolge ist createTime ASC.

showDeleted

boolean

Gibt an, ob gelöschte Nachrichten einbezogen werden sollen. Zu den gelöschten Nachrichten gehören auch die gelöschte Zeit und Metadaten zum Löschen, der Inhalt der Nachricht ist aber nicht 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 weiteren 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.