Method: spaces.messages.list

Hier werden Nachrichten in einem Gruppenbereich aufgelistet, in dem der Anrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Wenn Sie Nachrichten aus einem Gruppenbereich auflisten, in dem keine Nachrichten vorhanden sind, 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 die 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

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

Wenn nicht angegeben, werden maximal 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.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Listen von Nachrichten 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. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter

string

Optional. 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 RFC-3339-Format und doppelten Anführungszeichen an. Beispiel: "2023-04-21T11:30:00-04:00" Mit dem Operator „größer als“ > können Sie Nachrichten auflisten, die nach einem Zeitstempel erstellt wurden. Mit dem Operator „kleiner als“ < können Sie Nachrichten auflisten, die vor einem Zeitstempel erstellt wurden. Um Nachrichten innerhalb eines Zeitintervalls zu filtern, verwenden Sie den Operator AND zwischen zwei Zeitstempeln.

Wenn Sie nach Thread filtern möchten, geben Sie die thread.name im Format spaces/{space}/threads/{thread} an. Pro Abfrage kann nur eine thread.name angegeben werden.

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 Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
orderBy

string

Optional. Wie die Liste der Nachrichten sortiert wird. Geben Sie einen Wert an, nach dem sortiert werden soll. Gültige Werte für Sortiervorgänge:

  • ASC für aufsteigend.

  • DESC für absteigend.

Die Standardsortierung ist createTime ASC.
showDeleted

boolean

Optional. Ob gelöschte Nachrichten eingeschlossen werden sollen. Gelöschte Nachrichten enthalten das Löschdatum und ‑uhrzeit sowie Metadaten zum Löschen, der Inhalt der Nachricht ist jedoch nicht verfügbar.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für Nachrichten zum Eintrag

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