Method: spaces.messages.list

Listet Nachrichten in einem Gruppenbereich auf, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Wenn Sie Nachrichten aus einem Gruppenbereich ohne Nachrichten auflisten, ist die Antwort ein leeres Objekt. Wenn Sie eine REST/HTTP-Schnittstelle verwenden, enthält die Antwort ein leeres JSON-Objekt, {}. 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

Parameter
parent

string

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

Format: spaces/{space}

Suchparameter

Parameter
pageSize

integer

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

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

Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.

pageToken

string

Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird.

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

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

filter

string

Einen Abfragefilter.

Du kannst Nachrichten nach Datum (createTime) und Thread (thread.name) filtern.

Wenn Sie Nachrichten nach dem Erstellungsdatum filtern möchten, geben Sie createTime mit einem Zeitstempel im Format RFC-3339 und in doppelten Anführungszeichen an. 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. Um Nachrichten innerhalb eines Zeitintervalls zu filtern, verwenden Sie den Operator AND zwischen zwei Zeitstempeln.

Geben Sie thread.name im Format spaces/{space}/threads/{thread} an, um nach Thread zu filtern. Sie können nur ein thread.name pro Abfrage angeben.

Verwenden Sie in Ihrer Abfrage den Operator AND, um sowohl nach Threads 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 Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

orderBy

string

Optional, wenn die Pausierung von einer vorherigen Abfrage aufgehoben wird.

Die Reihenfolge der Nachrichtenliste. Geben Sie einen Wert für die Sortierung über einen Sortiervorgang an. 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 berücksichtigt werden sollen. Gelöschte Nachrichten enthalten den gelöschten Zeitraum und Metadaten zum Löschen, der Inhalt der Nachricht ist jedoch nicht verfügbar.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht zum Auflisten von Nachrichten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden 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. Ist das Feld leer, 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.