Method: users.threads.list

Muestra una lista de las conversaciones del buzón del usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
userId

string

La dirección de correo electrónico del usuario. Se puede usar el valor especial me para indicar el usuario autenticado.

Parámetros de consulta

Parámetros
maxResults

integer (uint32 format)

Cantidad máxima de subprocesos que se mostrarán. El valor predeterminado de este campo es 100. El valor máximo permitido para este campo es 500.
pageToken

string

Token de la página para recuperar una página específica de resultados en la lista.
q

string

Solo muestra subprocesos que coincidan con la consulta especificada. Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". El parámetro no se puede usar cuando se accede a la API con el permiso gmail.metadata.
labelIds[]

string

Solo muestra conversaciones con etiquetas que coincidan con todos los IDs de etiqueta especificados.
includeSpamTrash

boolean

Incluye conversaciones de SPAM y TRASH en los resultados.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
Campos
threads[]

object (Thread)

Lista de conversaciones. Ten en cuenta que cada recurso de subprocesos no contiene una lista de messages. La lista de messages para un subproceso determinado se puede recuperar con el método threads.get.
nextPageToken

string

Token de la página para recuperar la página siguiente de resultados de la lista.
resultSizeEstimate

integer (uint32 format)

Cantidad total estimada de resultados.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • 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

Para obtener más información, consulta la Guía de autorización.