Method: spaces.messages.list

Listet Nachrichten in einem Gruppenbereich auf, in dem der Aufrufer Mitglied ist, einschließlich Nachrichten von blockierten Mitgliedern und Gruppenbereichen. Systemnachrichten wie Ankündigungen neuer Gruppenbereichsmitglieder sind nicht enthalten. Wenn Sie Nachrichten aus einem Gruppenbereich ohne Nachrichten auflisten, ist die Antwort ein leeres Objekt. Bei Verwendung einer REST/HTTP-Schnittstelle enthält die Antwort ein leeres JSON-Objekt: {}. Ein Beispiel finden Sie unter Nachrichten auflisten.

Unterstützt die folgenden Arten der Authentifizierung:

  • App-Authentifizierung mit Administratorgenehmigung mit dem Autorisierungsbereich:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Bei Verwendung dieses Autorisierungsbereichs gibt diese Methode nur öffentliche Nachrichten in einem Gruppenbereich zurück. Private Nachrichten sind nicht enthalten.

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)

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 Maximalwert ist 1000. Wenn Sie einen Wert über 1000 verwenden, wird er automatisch in 1000 geändert.

Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nächste 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 dies zu unerwarteten Ergebnissen führen.
filter

string

Optional. Ein Abfragefilter.

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

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

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

Wenn Sie sowohl nach Thread als auch nach Datum filtern möchten, verwenden Sie den Operator AND in der Abfrage.

Beispiel: Die folgenden Abfragen sind 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 einem INVALID_ARGUMENT-Fehler abgelehnt.
orderBy

string

Optional. Wie die Liste der Nachrichten sortiert wird. Geben Sie einen Wert an, um nach einer Sortieroperation zu sortieren. Gültige Werte für Sortieroperationen sind:

  • ASC für aufsteigend.

  • DESC für absteigend.

Die Standardsortierung ist createTime ASC.
showDeleted

boolean

Optional. Gibt an, ob gelöschte Nachrichten berücksichtigt werden sollen. Gelöschte Nachrichten enthalten die Löschzeit und Metadaten zur Löschung, aber der Nachrichteninhalt ist nicht verfügbar.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für das 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 Seite mit Ergebnissen abzurufen. Wenn leer, 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.