Method: users.threads.list

Listet die Unterhaltungen im Postfach des Nutzers auf. Weitere Informationen finden Sie unter Unterhaltungen verwalten.

HTTP-Anfrage

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
userId

string

Die E-Mail-Adresse des Nutzers. Mit dem Sonderwert me kann der authentifizierte Nutzer angegeben werden.

Suchparameter

Parameter
maxResults

integer (uint32 format)

Maximale Anzahl der zurückzugebenden Unterhaltungen. Der Standardwert für dieses Feld ist 100. Der maximal zulässige Wert für dieses Feld ist 500.

pageToken

string

Seitentoken zum Abrufen einer bestimmten Seite mit Ergebnissen in der Liste.

q

string

Gibt nur Unterhaltungen zurück, die der angegebenen Abfrage entsprechen. Unterstützt dasselbe Abfrageformat wie das Suchfeld von Gmail. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Der Parameter kann nicht verwendet werden, wenn auf die API mit dem Bereich „gmail.metadata“ zugegriffen wird.

labelIds[]

string

Gibt nur Unterhaltungen mit Labels zurück, die allen angegebenen Label-IDs entsprechen.

includeSpamTrash

boolean

Unterhaltungen aus SPAM und TRASH in die Ergebnisse einschließen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

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

JSON-Darstellung
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Felder
threads[]

object (Thread)

Liste der Unterhaltungen. Jede Unterhaltungsressource enthält keine Liste von messages. Die Liste der messages für eine bestimmte Unterhaltung kann mit der Methode threads.get abgerufen werden.

nextPageToken

string

Seitentoken zum Abrufen der nächsten Seite mit Ergebnissen in der Liste.

resultSizeEstimate

integer (uint32 format)

Geschätzte Gesamtzahl der Ergebnisse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

Weitere Informationen finden Sie im Autorisierungsleitfaden.