Method: users.history.list

Muestra 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 de acceso

Parámetros
userId

string

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

Parámetros de consulta

Parámetros
maxResults

integer (uint32 format)

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

string

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

string

Obligatorio. Muestra los registros de historial después del startHistoryId especificado. El startHistoryId proporcionado debe obtenerse del historyId de un mensaje, una conversación o una respuesta list anterior. Los IDs de historial aumentan cronológicamente, pero no son contiguos y tienen espacios aleatorios entre los IDs válidos. Si proporcionas 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, significa que no hay actualizaciones para recuperar y puedes almacenar el historyId que se muestra para una solicitud futura.
labelId

string

Solo muestra mensajes con una etiqueta que coincida con el ID.
historyTypes[]

enum (HistoryType)

Tipos de historial que mostrará 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 propagados.
nextPageToken

string

Es un 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 de correo.

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 la Guía de autorización.

HistoryType

Enumeraciones
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 a varios mensajes de varias 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 de historial. Los campos de tipos de cambios específicos, como messagesAdded, pueden duplicar los mensajes en este campo. Te recomendamos que uses los campos de tipo de cambio específicos en su lugar.
messagesAdded[]

object (MessageAdded)

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

object (MessageDeleted)

Mensajes borrados (no enviados a la papelera) del buzón de este registro de historial.
labelsAdded[]

object (LabelAdded)

Etiquetas agregadas a los mensajes en este registro de historial
labelsRemoved[]

object (LabelRemoved)

Etiquetas quitadas de los mensajes en este registro de 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

IDs de etiquetas agregados al mensaje.

LabelRemoved

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

object (Message)
labelIds[]

string

IDs de etiquetas que se quitaron del mensaje