Method: users.history.list

Enumera el historial de todos los cambios realizados en el buzón de correo determinado. Los resultados del historial se devuelven en orden cronológico (historyId creciente).

Solicitud HTTP

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

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

Parámetros de ruta

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)

Es la cantidad máxima de registros del historial que se devolverán. El valor predeterminado de este campo es 100. El valor máximo permitido para este campo es 500.
pageToken

string

Es el token de página para recuperar una página específica de resultados en la lista.
startHistoryId

string

Obligatorio. Devuelve los registros del historial después del startHistoryId especificado. El startHistoryId proporcionado se debe obtener del historyId de un mensaje, un hilo o una respuesta de list anterior. Los IDs de historial aumentan de forma cronológica, pero no son contiguos, ya que hay espacios aleatorios entre los IDs válidos. Si se proporciona un startHistoryId no válido o desactualizado, por lo general, se muestra un código de error HTTP 404. Por lo general, un historyId es válido durante al menos una semana, pero en algunas circunstancias excepcionales puede ser válido solo por unas horas. Si recibes una respuesta de error HTTP 404, tu aplicación debería realizar una sincronización completa. Si no recibes ningún nextPageToken en la respuesta, no hay actualizaciones para recuperar y puedes almacenar el historyId devuelto para una solicitud futura.
labelId

string

Solo se devuelven los mensajes con una etiqueta que coincida con el ID.
historyTypes[]

enum (HistoryType)

Tipos de historial que devolverá la función

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 
{
  "history": [
    {
      object (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Campos
history[]

object (History)

Es la lista de registros del historial. Por lo general, cualquier messages que se incluya en la respuesta solo tendrá los campos id y threadId completados.
nextPageToken

string

Es el token de página para recuperar la siguiente página de resultados en la lista.
historyId

string

Es el ID del registro de historial actual del buzón.

Permisos 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 OAuth 2.0 Overview.

HistoryType

Enums
messageAdded
messageDeleted
labelAdded
labelRemoved

Historial

Es un registro de un cambio en el buzón de correo del usuario. Cada cambio en el historial puede afectar varios mensajes de diversas maneras.

Representación JSON 
{
  "id": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Campos
id

string

Es el ID de secuencia del buzón.
messages[]

object (Message)

Es la lista de mensajes que se modificaron en este registro del historial. Los campos para tipos de cambios específicos, como messagesAdded, pueden duplicar mensajes en este campo. Te recomendamos que uses los campos específicos de tipo de cambio en lugar de este.
messagesAdded[]

object (MessageAdded)

Son los mensajes que se agregaron al buzón en este registro del historial.
messagesDeleted[]

object (MessageDeleted)

Son los mensajes borrados (no enviados a la papelera) del buzón en este registro del historial.
labelsAdded[]

object (LabelAdded)

Son las etiquetas que se agregaron a los mensajes en este registro del historial.
labelsRemoved[]

object (LabelRemoved)

Son las etiquetas que se quitaron de los mensajes en este registro del historial.

MessageAdded

Representación JSON 
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

MessageDeleted

Representación JSON 
{
  "message": {
    object (Message)
  }
}
Campos
message

object (Message)

LabelAdded

Representación JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)
labelIds[]

string

Son los IDs de las etiquetas agregadas al mensaje.

LabelRemoved

Representación JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Campos
message

object (Message)
labelIds[]

string

Son los IDs de las etiquetas que se quitaron del mensaje.