Method: users.history.list

Muestra un historial de todos los cambios realizados en el buzón de correo. Los resultados del historial se muestran en orden cronológico (aumentando historyId).

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. 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 registros del 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 el token de la página para recuperar una página específica de resultados de la lista.
startHistoryId

string

Obligatorio. Muestra los registros del historial después del startHistoryId especificado. El startHistoryId proporcionado se debe obtener del historyId de un mensaje, una conversación o una respuesta list anterior. Los IDs del historial aumentan cronológicamente, pero no son contiguos a espacios vacíos entre ID válidos. Por lo general, si proporcionas un startHistoryId no válido o desactualizado, se mostrará un código de error HTTP 404. Un historyId suele ser válido durante al menos una semana, pero en algunas circunstancias excepcionales puede ser válido por unas pocas horas. Si recibes una respuesta de error HTTP 404, tu aplicación debería realizar una sincronización completa. Si no recibes nextPageToken en la respuesta, 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)

Lista de registros históricos. Por lo general, los messages contenidos en la respuesta solo tendrán propagados los campos id y threadId.
nextPageToken

string

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

string

El ID del registro del historial actual del buzón.

Permisos de autorización

Se necesita uno de los siguientes alcances 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.

Tipo de historial

Enumeradores
messageAdded
messageDeleted
labelAdded
labelRemoved

Historial

Un registro de un cambio en el buzón del usuario Cada cambio en el historial puede afectar a varios mensajes de diferentes maneras.

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

string

El ID de secuencia del buzón.
messages[]

object (Message)

Lista de mensajes modificados en este registro histórico. Los campos para tipos de cambios específicos, como messagesAdded, pueden duplicar mensajes. En su lugar, recomendamos usar los campos de tipo de cambio específicos.
messagesAdded[]

object (MessageAdded)

Mensajes agregados al buzón en este registro histórico.
messagesDeleted[]

object (MessageDeleted)

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

object (LabelAdded)

Etiquetas agregadas a los mensajes de este registro histórico.
labelsRemoved[]

object (LabelRemoved)

Etiquetas quitadas de los mensajes en este registro de historial.

Mensaje agregado

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

object (Message)

Se borró el mensaje

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

object (Message)

Etiqueta agregada

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

object (Message)
labelIds[]

string

Se agregaron los ID de etiqueta al mensaje.

Se quitó la etiqueta

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

object (Message)
labelIds[]

string

Se quitaron los ID de etiqueta del mensaje.